docs(eslint-plugin): change createRule usage to point to website #4369
Conversation
|
Thanks for the PR, @JoshuaKGoldberg! 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. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day. |
|
❌ Deploy Preview for typescript-eslint failed. 🔨 Explore the source changes: 019f34b 🔍 Inspect the deploy log: https://app.netlify.com/sites/typescript-eslint/deploys/61ce28a8d877d100094a7e2d |
| export const createRule = ESLintUtils.RuleCreator( | ||
| name => | ||
| `https://github.com/typescript-eslint/typescript-eslint/blob/v${version}/packages/eslint-plugin/docs/rules/${name}.md`, | ||
| name => `https://typescript-eslint.io/rules/${name}`, |
There was a problem hiding this comment.
@bradzacher I have a vague memory of you mentioning it's preferable to link to the specific version of a rule, but can't find where that was. Did that opinion ever exist, and if so, is it still accurate now that the website is ready?
There was a problem hiding this comment.
back in the beginning it was a huge problem for us changing rules regularly.
Now-a-days everything is super stable so I don't think it's worth worrying about any more.
If we want to build it into the website - we totally could, but I think at this stage of the project it's probably super low value.
Codecov Report
@@ Coverage Diff @@
## main #4369 +/- ##
==========================================
+ Coverage 93.88% 94.61% +0.72%
==========================================
Files 297 147 -150
Lines 11193 7841 -3352
Branches 3253 2507 -746
==========================================
- Hits 10509 7419 -3090
+ Misses 416 233 -183
+ Partials 268 189 -79
Flags with carried forward coverage won't be shown. Click here to find out more.
|
| export const createRule = ESLintUtils.RuleCreator( | ||
| name => | ||
| `https://github.com/typescript-eslint/typescript-eslint/blob/v${version}/packages/eslint-plugin/docs/rules/${name}.md`, | ||
| name => `https://typescript-eslint.io/rules/${name}`, |
There was a problem hiding this comment.
back in the beginning it was a huge problem for us changing rules regularly.
Now-a-days everything is super stable so I don't think it's worth worrying about any more.
If we want to build it into the website - we totally could, but I think at this stage of the project it's probably super low value.
PR Checklist
Overview
Changes the link in most rules'
createRuleusage to point to the general website instead of version-specific GitHub markdown files.