Skip to content
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.

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

Docs: what parserOptions.project relative to? #6992

Closed
2 tasks done
majiang opened this issue May 5, 2023 · 1 comment · Fixed by #7052
Closed
2 tasks done

Docs: what parserOptions.project relative to? #6992

majiang opened this issue May 5, 2023 · 1 comment · Fixed by #7052
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating good first issue Good for newcomers

Comments

@majiang
Copy link

majiang commented May 5, 2023

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

https://github.com/typescript-eslint/typescript-eslint/blob/main/docs/linting/Typed_Linting.mdx

## Specifying TSConfigs

The `parserOptions.project` option can be turned on with either:

- `true`: to always use `tsconfig.json`s nearest to source files
- `string | string[]`: any number of glob paths to match TSConfig files relative to the

For example, if you use a specific `tsconfig.eslint.json` for linting, you'd specify:

Second item ends with "relative to the" without noun. It seems to be "config file" but I'm not sure.

Affected URL(s)

https://typescript-eslint.io/linting/typed-linting#specifying-tsconfigs

@majiang majiang added documentation Documentation ("docs") that needs adding/updating triage Waiting for maintainers to take a look labels May 5, 2023
@bradzacher
Copy link
Member

It should read "relative to parserOptions.tsconfigRootDir, or the CWD if that is not provided".

@bradzacher bradzacher added accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for maintainers to take a look labels May 5, 2023
@JoshuaKGoldberg JoshuaKGoldberg added the good first issue Good for newcomers label May 7, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 8, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants