Skip to content

docs(website): fix tsconfig.eslint.json instead of .eslintrc.js in code snippet #4263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 6, 2021
Merged

docs(website): fix tsconfig.eslint.json instead of .eslintrc.js in code snippet #4263

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4257b8b
update example code snippet to json instead of js
dsanch3z Dec 3, 2021
58a7c07
Update MONOREPO.md
bradzacher Dec 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/linting/MONOREPO.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,21 +56,21 @@ If you've only got one, you should inspect the `include` paths. If it doesn't in
The former doesn't always work for everyone if they've got a complex build, as adding more paths (like test paths) to `include` could break the build.
In those cases we suggest creating a new config called `tsconfig.eslint.json`, that looks something like this:

```js title=".eslintrc.js"
module.exports = {
```jsonc title="tsconfig.eslint.json"
{
// extend your base config to share compilerOptions, etc
extends: './tsconfig.json',
compilerOptions: {
"extends": "./tsconfig.json",
"compilerOptions": {
// ensure that nobody can accidentally use this config for a build
noEmit: true,
"noEmit": true
},
include: [
"include": [
// whatever paths you intend to lint
'src',
'test',
'tools',
],
};
"src",
"test",
"tools"
]
}
```

Ensure you update your `.eslintrc.js` to point at this new config file.
Expand Down