Skip to content

Commit

Permalink
Use relative path for example (#33565)
Browse files Browse the repository at this point in the history
The paths starting with slashes in the ESLint config examples are absolute, which are almost never the correct configuration for a project. Using a relative path is a much more common configuration, and leads to much less debugging why these examples don't work.

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have helpful link attached, see `contributing.md`

## Documentation / Examples

- [ ] Make sure the linting passes by running `yarn lint`
  • Loading branch information
karlhorky authored Jan 26, 2022
1 parent 65c63c9 commit 5c6c385
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/basic-features/eslint.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,13 @@ If you're using `eslint-plugin-next` in a project where Next.js isn't installed
"extends": "next",
"settings": {
"next": {
"rootDir": "/packages/my-app/"
"rootDir": "packages/my-app/"
}
}
}
```

`rootDir` can be a path (relative or absolute), a glob (i.e. `"/packages/*/"`), or an array of paths and/or globs.
`rootDir` can be a path (relative or absolute), a glob (i.e. `"packages/*/"`), or an array of paths and/or globs.

## Linting Custom Directories and Files

Expand Down
2 changes: 1 addition & 1 deletion errors/no-html-link-for-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ In some cases, you may also need to configure this rule directly by providing a
```json
{
"rules": {
"@next/next/no-html-link-for-pages": ["error", "/my-app/pages/"]
"@next/next/no-html-link-for-pages": ["error", "packages/my-app/pages/"]
}
}
```
Expand Down

0 comments on commit 5c6c385

Please sign in to comment.