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: Clarify tsconfigRootDir in docs #6124

Closed
2 tasks done
JoshuaKGoldberg opened this issue Nov 29, 2022 · 2 comments
Closed
2 tasks done

Docs: Clarify tsconfigRootDir in docs #6124

JoshuaKGoldberg opened this issue Nov 29, 2022 · 2 comments
Assignees
Labels
accepting prs Go ahead, send a pull request that resolves this issue blocked by another issue Issues which are not ready because another issue needs to be resolved first documentation Documentation ("docs") that needs adding/updating

Comments

@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commented Nov 29, 2022

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

Suggested Changes

Pulling from https://twitter.com/_baxuz/status/1597248286108553216 & #6084 (comment): it's not explicitly mentioned in our docs when & why you would want to enable tsconfigRootDir.

...but that's about it. It'd be nice if we were more explicit that:

  • It's for when your current working directory doesn't match up with your path relativity.
    • It's mentioned in the @typescript-eslint/parser README as:

    Relative paths are interpreted relative to the current working directory if tsconfigRootDir is not set. If you intend on running ESLint from directories other than the project root, you should consider using tsconfigRootDir.

  • Having working directory mismatches is, to my understanding, an unfortunate and to-be-avoided situation?
    • We could add workarounds somewhere, such as Troubleshooting & FAQs?

Note: once #5984 is merged, we'll have the package READMEs and included API docs on the site.

Affected URL(s)

https://typescript-eslint.io/docs/linting/typed-linting/monorepos
https://typescript-eslint.io/docs/linting/troubleshooting

@JoshuaKGoldberg JoshuaKGoldberg added documentation Documentation ("docs") that needs adding/updating accepting prs Go ahead, send a pull request that resolves this issue labels Nov 29, 2022
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Nov 29, 2022
@JoshuaKGoldberg
Copy link
Member Author

I'll say this is blocked on #6084 being merged. Once that's in, I can send more to the docs.

@JoshuaKGoldberg JoshuaKGoldberg added the blocked by another issue Issues which are not ready because another issue needs to be resolved first label Dec 2, 2022
@JoshuaKGoldberg
Copy link
Member Author

Meh, dup of #6208, and not really blocked.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 25, 2022
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 blocked by another issue Issues which are not ready because another issue needs to be resolved first documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Development

No branches or pull requests

1 participant