Add docs for ESLint plugin settings and rule options #28059
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
mrmckeb
requested review from
huozhi,
ijjk,
leerob,
lfades,
padmaia,
shuding,
styfle and
timneutkens
as code owners
housseindjirdeh
previously approved these changes
Aug 13, 2021
leerob
suggested changes
Aug 13, 2021
errors/no-html-link-for-pages.md
Outdated
|
|
||
| This rule can normally locate your `pages` directory automatically. | ||
|
|
||
| If you're working in a monorepo, we recommend configuring the [`rootDir`](https://nextjs.org/docs/basic-features/eslint.md#rootDir) setting in `eslint-plugin-next`, which this rule will use to locate your `pages` directory. |
There was a problem hiding this comment.
Suggested change
| If you're working in a monorepo, we recommend configuring the [`rootDir`](https://nextjs.org/docs/basic-features/eslint.md#rootDir) setting in `eslint-plugin-next`, which this rule will use to locate your `pages` directory. | |
| If you're working in a monorepo, we recommend configuring the [`rootDir`](/docs/basic-features/eslint.md#rootDir) setting in `eslint-plugin-next`, which `pagesDir` will use to locate your `pages` directory. |
There was a problem hiding this comment.
Does this first section need an example, if the second one does?
There was a problem hiding this comment.
We could add it here, but I worry that users would miss the details and configuration options - WDYT?
|
Looks really good 😄 |
Co-authored-by: Lee Robinson <[email protected]>
Co-authored-by: Lee Robinson <[email protected]>
Co-authored-by: Lee Robinson <[email protected]>
Co-authored-by: Lee Robinson <[email protected]>
leerob
approved these changes
Aug 18, 2021
timneutkens
approved these changes
Aug 19, 2021
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR adds documentation for the new
rootDirsetting (#27918), and fornext/no-html-link-for-pages.Documentation / Examples