docs: fix up config links #11254
Merged
docs: fix up config links #11254
+13
−13
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
|
Thanks for the PR, @kirkwaiblinger! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
View your CI Pipeline Execution ↗ for commit a39a32b.
☁️ Nx Cloud last updated this comment at |
bradzacher
previously approved these changes
May 30, 2025
JoshuaKGoldberg
requested changes
May 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Checklist
Overview
Affects https://typescript-eslint.io/users/configs
Addresses 2 issues.
https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/eslintrc/eslint-recommended.ts is a bad link to use for
eslint-recommended. It's technically true but doesn't show its contents. So, I've changed it to https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/eslint-recommended-raw.tsThe wording "See
configs/<config-name>.tsfor the exact contents of this config" doesn't really work because those configs are now atconfigs/eslintrc/<config-name>.ts(with the exception of bullet point 1, which is atconfigs/eslint-recommended-raw.ts). Since puttingeslintrcand*-rawin the link text is IMO distracting, I've opted to change the wording to "Seethe source code for this configfor the exact contents"... Not dead set on this solution, but I'd like to avoid putting the technically-falseconfigs/<config-name>.tsin the text.