Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
docs: fix up config links#11254
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
docs: fix up config links#11254
Conversation
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 onhttps://opencollective.com/typescript-eslint. |
netlifybot commentedMay 30, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
✅ Deploy Preview fortypescript-eslint ready!
To edit notification comments on pull requests, go to yourNetlify project configuration. |
nx-cloudbot commentedMay 30, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
View yourCI Pipeline Execution ↗ for commita39a32b.
☁️Nx Cloud last updated this comment at |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
+1 in general, but with an accessibility note
docs/users/Shared_Configurations.mdx Outdated
| @@ -144,7 +144,7 @@ module.exports = { | |||
| </TabItem> | |||
| </Tabs> | |||
| See [`configs/recommended.ts`](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/eslintrc/recommended.ts) for the exact contents of this config. | |||
| See [the source code for this config](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/eslintrc/recommended.ts) for the exact contents. | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
https://www.w3.org/WAI/WCAG21/Understanding/link-purpose-in-context.html - the problem with having the same text on all links is they can't be disambiguated from just that text. Maybe...
| See[the source code forthis config](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/eslintrc/recommended.ts) for the exact contents. | |
| See[the source code forthe`recommended` config](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/eslintrc/recommended.ts) for the exact contents. |
would be a good fix?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Yes, agreed that that's better. Thanks for the suggestion!
PR Checklist
Overview
Affectshttps://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 tohttps://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.