docs: fix formatting of unordered lists in Markdown #19660
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
mdjermanovic
commented
Apr 26, 2025
docs/src/extend/plugins.md
Outdated
Comment on lines
86
to
91
| ::: tip | ||
| While there are no restrictions on plugin names, it helps others to find your plugin on [npm](https://npmjs.com) when you follow these naming conventions: | ||
|
|
||
| - **Unscoped:** If your npm package name won't be scoped (doesn't begin with `@`), then the plugin name should begin with `eslint-plugin-`, such as `eslint-plugin-example`. | ||
| - **Scoped:** If your npm package name will be scoped, then the plugin name should be in the format of `@<scope>/eslint-plugin-<plugin-name>` such as `@jquery/eslint-plugin-jquery` or even `@<scope>/eslint-plugin` such as `@jquery/eslint-plugin`. | ||
| ::: | ||
| - **Unscoped:** If your npm package name won't be scoped (doesn't begin with `@`), then the plugin name should begin with `eslint-plugin-`, such as `eslint-plugin-example`. | ||
| - **Scoped:** If your npm package name will be scoped, then the plugin name should be in the format of `@<scope>/eslint-plugin-<plugin-name>` such as `@jquery/eslint-plugin-jquery` or even `@<scope>/eslint-plugin` such as `@jquery/eslint-plugin`. | ||
| ::: |
There was a problem hiding this comment.
Looks like this fixed a bug we didn't notice on https://eslint.org/docs/latest/extend/plugins.
before
after
There was a problem hiding this comment.
Added a blank line before ::: in 4ae7544 to fix its indentation and ensure this doesn't happen again.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x] Other, please explain:
Fixes formatting of unordered lists in all .md files.
In #19628, we upgraded Prettier from v3.3.3 to v3.5.3. In Prettier v3.4.0, a bug with excessive spaces after line prefixes for unordered lists in Markdown has been fixed (https://prettier.io/blog/2024/11/26/3.4.0.html#markdown). As our CI apparently doesn't check the formatting of the entire codebase but just modified files, after merging #19628 a lot of .md files have become incorrectly formatted per Prettier v3.5.3. This is causing problems like:
What changes did you make? (Give an overview)
npm i prettier --no-save).npx prettier --write "**/*.md".Is there anything you'd like reviewers to focus on?