Setup check format in pipeline #1001

brenelz · 2025-01-03T00:07:04Z

I have read the Contribution guide
This PR references an issue (except for typos, broken links, or other minor problems)

Description(required)

Setup format files in CI
Run pnpm exec prettier . --write

Related issues & labels

Closes [Other]: Unformatted files #1000

stackblitz · 2025-01-03T00:07:07Z

Run & review this pull request in StackBlitz Codeflow.

netlify · 2025-01-03T00:07:22Z

✅ Deploy Preview for solid-docs ready!

Name	Link
🔨 Latest commit	`26c1cac`
🔍 Latest deploy log	https://app.netlify.com/sites/solid-docs/deploys/67c71d27813f720008f739b7
😎 Deploy Preview	https://deploy-preview-1001--solid-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

amirhhashemi · 2025-01-03T05:42:23Z

This is a reminder that Prettier does not format fenced code blocks inside JSX unless the following conditions are met:

There is a blank line at the top and bottom of the block.
The block starts at the beginning of the line (with no indentation).

For example, Prettier does not recognize the fenced code block in this code:

<TabsCodeBlocks>
  <div id="npm">
    ```bash frame="none"
    npm install @macaron-css/core @macaron-css/solid
    ```
  </div>
</TabsCodeBlocks>

As a result, it formats it incorrectly like this:

<TabsCodeBlocks>
  <div id="npm">
    ```bash frame="none" npm install @macaron-css/core @macaron-css/solid ```
  </div>
</TabsCodeBlocks>

To resolve this issue, you need to manually check all fenced code blocks and ensure they meet the criteria mentioned above:

<TabsCodeBlocks>
<div id="npm">

```bash frame="none"
npm install @macaron-css/core @macaron-css/solid
```

</div>
</TabsCodeBlocks>

I have already addressed this in my own pull request, specifically in this commit. If you find it helpful, you can use git cherry-pick to incorporate it.

amirhhashemi · 2025-02-06T07:36:28Z

@brenelz This PR has been inactive for a while. If you're busy, would you mind if I took it over? It's blocking some important changes.

LadyBluenotes · 2025-02-06T14:18:04Z

this isn't actually blocking any changes atm @amirhhashemi

you're welcomed to assist (i'd assume @brenelz would be fine with the assist) just make sure he gets to give a review.

amirhhashemi · 2025-02-06T15:03:59Z

@LadyBluenotes This is a blocker. Any sort of change or refactor is a huge pain to do because of the unformatted files. For example, I was thinking about changing the structure of the component prop docs in the API references and I decided not to do it before this merges, because I don't have the nerve to save a file and deal with the unintended changes.

It's also going to be a huge problem when we wanted to migrate to the new site.

amirhhashemi · 2025-02-06T15:06:00Z

@LadyBluenotes Sorry, I've never taken over a PR :) Should I create a new PR or somehow push my changes to this PR?

LadyBluenotes · 2025-02-06T15:35:07Z

Working within this one is good!

amirhhashemi · 2025-02-07T15:01:16Z

I can't push my commits to this PR. Whether it's because I don't have the write permission to this repo or the OP has un-checked "Allow edits by maintainers".

LadyBluenotes · 2025-02-07T15:14:45Z

No, he has it checked. He has to add you to the branch itself, I guess. I reached out to ask if he could

brenelz · 2025-02-07T15:22:20Z

@amirhhashemi I think I invited you to collaborate on my solid-docs repo

amirhhashemi

I went through all the MDX files and made sure they were formatted correctly to the best of my ability.

amirhhashemi · 2025-02-14T06:54:13Z

I added a "format" script that runs Prettier with the --write flag and used that in the CI workflow to improve the development cycle.

brenelz · 2025-02-18T22:09:18Z

Should probably get this merged so we don't keep having to maintain it

brenelz · 2025-02-18T23:06:59Z

.github/workflows/static_checks.yml

@@ -70,4 +70,4 @@ jobs:
      - name: ESLint check
        run: pnpm check:lint
      - name: Prettier check
-        run: pnpm check:format
+        run: pnpm format


the --write won't work in CI tho will it?

brenelz · 2025-02-18T23:07:49Z

I added a "format" script that runs Prettier with the --write flag and used that in the CI workflow to improve the development cycle.

The CI won't actually write back to the github repo will it?

amirhhashemi · 2025-02-19T06:50:09Z

The CI won't actually write back to the github repo will it?

You are right.

In the latest commit, I used git-auto-commit-action to commit the changes back to ~~the pull requests branch or~~ the main branch. It creates a commit with the message "ci: Format files" when there are changes.

EDIT: git-auto-commit-action can't create a commit on a PRs created from a fork. That's a github limitation. So I created a format workflow that only formats files in the main branch. Formatting is not enforced in PRs.

I also created an install action that is reused in both workflows to install pnpm and configure Node.js.

amirhhashemi · 2025-03-04T15:36:40Z

.github/workflows/static_checks.yml

-  setup:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v4
-        with:
-          version: 9
-      - uses: actions/setup-node@v4
-        with:
-          node-version: "20"
-          cache: "pnpm"
-      - run: pnpm i
-      - uses: actions/cache/save@v4
-        with:
-          path: |
-            node_modules
-            ~/.pnpm-store
-          key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}


I'm not sure what's the goal in this job. It doesn't do anything useful that I can think of. So I removed it.

amirhhashemi · 2025-03-04T15:43:55Z

.github/workflows/static_checks.yml

-      - uses: actions/cache/save@v4
-        with:
-          path: |
-            node_modules
-            ~/.pnpm-store
-          key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}


I don't think this is needed to cache pnpm dependencies. See the official example.

LadyBluenotes · 2025-03-05T02:04:04Z

We merged in #1092 - I'm not sure how necessary this PR is now. @jer3m01 do you mind letting us know?

brenelz · 2025-03-05T02:11:01Z

Yeah I think it would be best to just close this with all the conflicts

amirhhashemi · 2025-03-05T06:16:35Z

@LadyBluenotes Seriously? How formatting is not necessary in a big project? You guys don't format your files (as a proper editor does automatically) and only edit on the website?

Conflicts are no reason to close this PR either. That's part of development, especially when a PR sits for two months. I fixed most of the problems a month ago and have been dealing with the conflicts since. It just needed someone to look at it for 15 minutes before the switch to SolidBase.

Twice, my efforts to format this repository have been dismissed. It's such a basic problem that I can't believe my time has been wasted on it.

I'm not sure I want to work on this project anymore.

LadyBluenotes · 2025-03-05T06:45:47Z

@amirhhashemi I can understand the frustration and I apologize for the miscommunication on this front. You are correct, we do still need formatting and I was unsure of whether it was easier for you to address this within this PR or if it would've been easier for you to do so in a new one. This wasn't closed with the intention of never addressing it, I was going to reach out tomorrow to have a conversation with you if you didn't happen to see this.

Setup check format in pipeline

17a0617

Format files according to prettier

a4cbf0a

kodiakhq bot added 6 commits January 7, 2025 16:26

Merge branch 'main' into format-files

3157ff1

Merge branch 'main' into format-files

50e8d70

Merge branch 'main' into format-files

2e822c5

Merge branch 'main' into format-files

70f469a

Merge branch 'main' into format-files

a5b999a

Merge branch 'main' into format-files

27fad50

amirhhashemi mentioned this pull request Jan 10, 2025

[Other]: Add a PackageManager component #1018

Closed

LadyBluenotes added the in progress Someone is currently working on the issue. label Jan 10, 2025

LadyBluenotes assigned brenelz Jan 10, 2025

LadyBluenotes requested a review from amirhhashemi February 7, 2025 15:10

minor formatting fix to check i can push commits

0367582

amirhhashemi added 4 commits February 8, 2025 12:34

fix formatting issues

ca6a29a

Merge branch 'main' into format-files

bbea460

format with prettier

558d325

remove redundant space

ccb5a98

amirhhashemi approved these changes Feb 8, 2025

View reviewed changes

Merge branch 'main' into format-files

d0bfecd

add format script

54ae1bb

amirhhashemi and others added 4 commits February 18, 2025 09:54

Merge branch 'main' into format-files

6bdb33b

format

5bc9519

Merge branch 'main' into format-files

de2f379

Merge branch 'main' into format-files

aa3fc1c

brenelz marked this pull request as ready for review February 18, 2025 22:08

Merge branch 'main' into format-files

8788ed7

brenelz changed the title ~~WIP: Setup check format in pipeline~~ Setup check format in pipeline Feb 18, 2025

brenelz commented Feb 18, 2025

View reviewed changes

Commit changed files

e884fa8

amirhhashemi added 8 commits March 2, 2025 18:54

Merge branch 'main' into format-files

ae49991

format files

6b7f96a

fix comment

addddb6

Add format workflow

84e7b20

Add install action

2d3bbf9

Add shell property

88375dc

Remove setup step

858b041

Use consitent pnpm command

26c1cac

amirhhashemi reviewed Mar 4, 2025

View reviewed changes

LadyBluenotes closed this Mar 5, 2025

LadyBluenotes mentioned this pull request Mar 9, 2025

update formating, linting, and some dependencies #1117

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Setup check format in pipeline #1001

Setup check format in pipeline #1001

brenelz commented Jan 3, 2025

stackblitz bot commented Jan 3, 2025

netlify bot commented Jan 3, 2025 •

edited

Loading

amirhhashemi commented Jan 3, 2025 •

edited

Loading

amirhhashemi commented Feb 6, 2025

LadyBluenotes commented Feb 6, 2025

amirhhashemi commented Feb 6, 2025

amirhhashemi commented Feb 6, 2025

LadyBluenotes commented Feb 6, 2025

amirhhashemi commented Feb 7, 2025

LadyBluenotes commented Feb 7, 2025

brenelz commented Feb 7, 2025

amirhhashemi left a comment •

edited

Loading

amirhhashemi commented Feb 14, 2025

brenelz commented Feb 18, 2025

brenelz Feb 18, 2025

brenelz commented Feb 18, 2025

amirhhashemi commented Feb 19, 2025 •

edited

Loading

amirhhashemi Mar 4, 2025 •

edited

Loading

amirhhashemi Mar 4, 2025

LadyBluenotes commented Mar 5, 2025

brenelz commented Mar 5, 2025

amirhhashemi commented Mar 5, 2025

LadyBluenotes commented Mar 5, 2025

Setup check format in pipeline #1001

Setup check format in pipeline #1001

Conversation

brenelz commented Jan 3, 2025

Description(required)

Related issues & labels

stackblitz bot commented Jan 3, 2025

netlify bot commented Jan 3, 2025 • edited Loading

✅ Deploy Preview for solid-docs ready!

amirhhashemi commented Jan 3, 2025 • edited Loading

amirhhashemi commented Feb 6, 2025

LadyBluenotes commented Feb 6, 2025

amirhhashemi commented Feb 6, 2025

amirhhashemi commented Feb 6, 2025

LadyBluenotes commented Feb 6, 2025

amirhhashemi commented Feb 7, 2025

LadyBluenotes commented Feb 7, 2025

brenelz commented Feb 7, 2025

amirhhashemi left a comment • edited Loading

Choose a reason for hiding this comment

amirhhashemi commented Feb 14, 2025

brenelz commented Feb 18, 2025

brenelz Feb 18, 2025

Choose a reason for hiding this comment

brenelz commented Feb 18, 2025

amirhhashemi commented Feb 19, 2025 • edited Loading

amirhhashemi Mar 4, 2025 • edited Loading

Choose a reason for hiding this comment

amirhhashemi Mar 4, 2025

Choose a reason for hiding this comment

LadyBluenotes commented Mar 5, 2025

brenelz commented Mar 5, 2025

amirhhashemi commented Mar 5, 2025

LadyBluenotes commented Mar 5, 2025

netlify bot commented Jan 3, 2025 •

edited

Loading

amirhhashemi commented Jan 3, 2025 •

edited

Loading

amirhhashemi left a comment •

edited

Loading

amirhhashemi commented Feb 19, 2025 •

edited

Loading

amirhhashemi Mar 4, 2025 •

edited

Loading