docs: Configure Prettier for docs #17737

Zamiell · 2023-11-08T23:12:46Z

This reverts commit 57bf249.

eslint-github-bot · 2023-11-08T23:12:51Z

Hi @Zamiell!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
There should be a space following the initial tag and colon, for example 'feat: Message'.
The first letter of the tag should be in lowercase

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

netlify · 2023-11-08T23:12:52Z

✅ Deploy Preview for docs-eslint canceled.

Name	Link
🔨 Latest commit	`6753b7c`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/6582fa5e35958c000869baec

nzakas

Overall this looks pretty good to me. Aside from the few files we should ignore, it would also be helpful to add a precommit hook to run Prettier on these files.

CHANGELOG.md

docs/src/library/rule.md

docs/src/pages/rules.md

Zamiell · 2023-11-09T18:12:25Z

not a fan of pre-commit hooks myself.
it is laggy for developers and produces pain, especially when making lots of nice, small commits.
a pre-commit hook is nice in the situation where one developer is pushing directly to a "main" branch without any other checks and balances.
but for ESLint, and any other relatively big project, most code is coming in to the project through pull requests, and a pull request will never be merged if CI isn't passing. (and Prettier should be enforced in CI!)
i find a much better workflow is to enforce Prettier in CI, and then additionally configure the repo settings.json file for vscode to have it automatically summon prettier every time a file is saved.
this is essentially lag free and is the shortest possible distance between type-time and notice-error-time.
(noticing at commit-time with a pre-commit-hook is a midway point between noticing at save-time and noticing at PR-time with CI, but comes with an nasty lag cost)

This reverts commit 1ce161c.

This reverts commit 51045ac.

Zamiell · 2023-11-10T04:03:46Z

I added the requested exceptions to the .prettierignore file: 625b360

kecrily

I'm not sure this is necessary, as of right now I think all these changes can be detected and fixed by the markdown-lint we are using

Zamiell · 2023-11-10T16:59:17Z

Using markdown-lint as a formatter is a bad idea for the exact same reasons that ESLint itself is deprecating its formatting rules!

CONTRIBUTING.md

nzakas · 2023-11-13T16:02:41Z

We already run precommit hooks for most ESLint files, so let's keep it consistent and do it for Prettier, too.

github-actions · 2023-11-23T22:31:17Z

Hi everyone, it looks like we lost track of this pull request. Please review and see what the next steps are. This pull request will auto-close in 7 days without an update.

Rec0iL99 · 2023-11-24T16:03:28Z

Ping @Zamiell

This reverts commit 7204106.

Zamiell · 2023-11-28T14:11:24Z

Ok, I added the pre-commit hook and fixed the list tab issue, the PR diff looks a lot cleaner now.

Should I convert this from a draft?

Zamiell · 2023-11-28T14:30:55Z

Looks like ESLint is throwing a spurious error related to this PR:

/home/runner/work/eslint/eslint/prettier.config.mjs
  33:1  error  Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

That's a bug in ESLint because an mjs file extension doesn't respect 'sourceType: module' at all. Does anyone know if there's already an issue opened about that?

mdjermanovic · 2023-11-28T14:57:08Z

That's a bug in ESLint because an mjs file extension doesn't respect 'sourceType: module' at all. Does anyone know if there's already an issue opened about that?

It's not a bug, our eslint config for this project is just set to treat all files as CommonJS. Can the Prettier config file be a CommonJS .js file?

Zamiell · 2023-11-28T15:04:25Z

It's not a bug, our eslint config for this project is just set to treat all files as CommonJS.

then that's a bug in the eslint config for this project and should probably be fixed =p

Can the Prettier config file be a CommonJS .js file?

done

github-actions · 2023-12-08T22:31:19Z

Hi everyone, it looks like we lost track of this pull request. Please review and see what the next steps are. This pull request will auto-close in 7 days without an update.

github-actions · 2023-12-19T22:31:18Z

Hi everyone, it looks like we lost track of this pull request. Please review and see what the next steps are. This pull request will auto-close in 7 days without an update.

kecrily · 2023-12-20T11:50:54Z

@Zamiell Is it ready for review now?

Zamiell · 2023-12-20T13:22:22Z

@kecrily it has been ready to review since this comment

kecrily

There's a big problem with indent. This is caused by the prettier bug mentioned above. prettier/prettier#5019

tabWidth: 2 doesn't fix it, it just goes from one problem to another. We are blocked.

package.json

kecrily · 2023-12-20T13:57:59Z

docs/src/contribute/work-on-issue.md

-    1. **Features** - new functionality that will aid users in the future.
-    1. **Enhancements** - requested improvements for existing functionality.
-    1. **Other** - anything else.
+   1. **Bugs** - problems with the project are actively affecting users. We want to get these resolved as quickly as possible.


The indent here has only three spaces.

kecrily · 2023-12-20T13:59:09Z

docs/src/extend/custom-processors.md

-        text: string
-    }
-    ```
+   ```typescript


package.json

Co-authored-by: Percy Ma <kecrily@gmail.com>

github-actions · 2024-01-06T22:31:17Z

Hi everyone, it looks like we lost track of this pull request. Please review and see what the next steps are. This pull request will auto-close in 7 days without an update.

github-actions · 2024-01-13T22:31:19Z

This pull request was auto-closed due to inactivity. While we wish we could keep working on every request, we unfortunately don't have the bandwidth to continue here and need to focus on other things. You can resubmit this pull request if you would like to continue working on it.

Zamiell added 6 commits November 8, 2023 17:50

chore: fix yarn install

57bf249

Revert "chore: fix yarn install"

8aacd21

This reverts commit 57bf249.

chore: add prettier config

d51fbb2

chore: add prettier dep

c0c149b

chore: prettier --write

51045ac

chore: prettier --write with 2 spaces

1ce161c

Zamiell mentioned this pull request Nov 8, 2023

Change Request: autoformat docs #17504

Open

1 task

nzakas changed the title ~~Prettier~~ chore: Configure Prettier for docs Nov 9, 2023

eslint-github-bot bot added the chore This change is not user-facing label Nov 9, 2023

nzakas reviewed Nov 9, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

docs/src/library/rule.md Outdated Show resolved Hide resolved

docs/src/pages/rules.md Outdated Show resolved Hide resolved

Zamiell changed the title ~~chore: Configure Prettier for docs~~ docs: Configure Prettier for docs Nov 9, 2023

eslint-github-bot bot added the documentation Relates to ESLint's documentation label Nov 9, 2023

Zamiell added 5 commits November 9, 2023 22:56

Revert "chore: prettier --write with 2 spaces"

48246c7

This reverts commit 1ce161c.

Revert "chore: prettier --write"

afbb8ac

This reverts commit 51045ac.

feat: .prettierignore

625b360

chore: update package.json script

74072a9

feat: prettier --write

7204106

kecrily reviewed Nov 10, 2023

View reviewed changes

mdjermanovic reviewed Nov 12, 2023

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

github-actions bot added the Stale label Nov 23, 2023

Rec0iL99 removed the Stale label Nov 24, 2023

chore: update prettier config

5ff3ce1

Zamiell added 4 commits November 28, 2023 09:04

Revert "feat: prettier --write"

bf0cfd4

This reverts commit 7204106.

chore: run prettier --write

31eb8c2

Merge branch 'main' into prettier

07af2e9

chore: add commit hook

e57570d

chore: change prettier config to CJS

4d0ddbb

github-actions bot added the Stale label Dec 8, 2023

fasttime removed the Stale label Dec 9, 2023

github-actions bot added the Stale label Dec 19, 2023

kecrily removed the Stale label Dec 20, 2023

kecrily reviewed Dec 20, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

Update package.json

6753b7c

Co-authored-by: Percy Ma <kecrily@gmail.com>

github-actions bot added the Stale label Jan 6, 2024

github-actions bot closed this Jan 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Configure Prettier for docs #17737

docs: Configure Prettier for docs #17737

Zamiell commented Nov 8, 2023

eslint-github-bot bot commented Nov 8, 2023

netlify bot commented Nov 8, 2023 •

edited

nzakas left a comment

Zamiell commented Nov 9, 2023 •

edited

Zamiell commented Nov 10, 2023

kecrily left a comment

Zamiell commented Nov 10, 2023 •

edited

nzakas commented Nov 13, 2023

github-actions bot commented Nov 23, 2023

Rec0iL99 commented Nov 24, 2023

Zamiell commented Nov 28, 2023 •

edited

Zamiell commented Nov 28, 2023 •

edited

mdjermanovic commented Nov 28, 2023

Zamiell commented Nov 28, 2023 •

edited

github-actions bot commented Dec 8, 2023

github-actions bot commented Dec 19, 2023

kecrily commented Dec 20, 2023

Zamiell commented Dec 20, 2023

kecrily left a comment •

edited

kecrily Dec 20, 2023

kecrily Dec 20, 2023

github-actions bot commented Jan 6, 2024

github-actions bot commented Jan 13, 2024

docs: Configure Prettier for docs #17737

docs: Configure Prettier for docs #17737

Conversation

Zamiell commented Nov 8, 2023

eslint-github-bot bot commented Nov 8, 2023

netlify bot commented Nov 8, 2023 • edited

✅ Deploy Preview for docs-eslint canceled.

nzakas left a comment

Choose a reason for hiding this comment

Zamiell commented Nov 9, 2023 • edited

Zamiell commented Nov 10, 2023

kecrily left a comment

Choose a reason for hiding this comment

Zamiell commented Nov 10, 2023 • edited

nzakas commented Nov 13, 2023

github-actions bot commented Nov 23, 2023

Rec0iL99 commented Nov 24, 2023

Zamiell commented Nov 28, 2023 • edited

Zamiell commented Nov 28, 2023 • edited

mdjermanovic commented Nov 28, 2023

Zamiell commented Nov 28, 2023 • edited

github-actions bot commented Dec 8, 2023

github-actions bot commented Dec 19, 2023

kecrily commented Dec 20, 2023

Zamiell commented Dec 20, 2023

kecrily left a comment • edited

Choose a reason for hiding this comment

kecrily Dec 20, 2023

Choose a reason for hiding this comment

kecrily Dec 20, 2023

Choose a reason for hiding this comment

github-actions bot commented Jan 6, 2024

github-actions bot commented Jan 13, 2024

netlify bot commented Nov 8, 2023 •

edited

Zamiell commented Nov 9, 2023 •

edited

Zamiell commented Nov 10, 2023 •

edited

Zamiell commented Nov 28, 2023 •

edited

Zamiell commented Nov 28, 2023 •

edited

Zamiell commented Nov 28, 2023 •

edited

kecrily left a comment •

edited