Changes the top-level heading to be just the rule name, with the description as the following paragraph
Enforces an## Options section with ajsonc snippet for just the recommended, non-extension rules without options

Fun little script I used to rewrite all rule docs file headings:

constfs=require('fs');constdir=fs.readdirSync(__dirname).filter(fileName=>!fileName.includes('README'));for(constfileNameofdir){construleName=fileName.split('.')[0];constcontents=fs.readFileSync(fileName).toString();constfirstHeader=contents.match(/^\#(.*)/g)?.[0];if(!firstHeader){continue;}constdescription=`${firstHeader.slice(2).replace(` (\`${ruleName}\`)`,'')}.`;constreplaced=[`# \`${ruleName}\``,'',description,'',contents.slice(firstHeader.length+2),].join('\n');fs.writeFileSync(fileName,replaced);}

docs: standardized rule docs heading and option-less Options

9b13323

Copy link

nx-cloudbot commentedDec 30, 2021•
edited
Loading

☁️ Nx Cloud Report

CI ran the following commands for commitfc3404b. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 48 targets

Sent with 💌 fromNxCloud.

Copy link

Contributor

typescript-eslintbot commentedDec 30, 2021

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 visitorsper day.

Copy link

netlifybot commentedDec 30, 2021•
edited
Loading

✔️ Deploy Preview fortypescript-eslint ready!

🔨 Explore the source changes:fc3404b

🔍 Inspect the deploy log:https://app.netlify.com/sites/typescript-eslint/deploys/61f570220b32b00008f89750

😎 Browse the preview:https://deploy-preview-4367--typescript-eslint.netlify.app

chore: fix package devDependencies listings

be0b011

JoshuaKGoldberg marked this pull request as ready for review

December 30, 2021 17:58

Copy link

MemberAuthor

JoshuaKGoldberg commentedDec 31, 2021

Drafting pending resolution in#4365.

JoshuaKGoldberg marked this pull request as draft

December 31, 2021 17:32

bradzacher added the documentationDocumentation ("docs") that needs adding/updating label

Jan 1, 2022

bradzacher reviewed

Jan 1, 2022

View reviewed changes

Copy link

Member

bradzacher left a comment•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

it'd be good to create a blank.md file that people can use as a template when creating a new rule doc. That would make it super easy for people to adhere to the style/layout without going through a test to check.

otherwise people end up copy-pasting an old rule and then sometimes we have bad text in docs.

Josh Goldbergand others added2 commits

January 23, 2022 17:20

Merge branch 'main' into standard-rule-docs-heading

9f37589

docs: add template rule docs file

12d91a6

JoshuaKGoldberg requested a review frombradzacher

January 23, 2022 22:25

JoshuaKGoldberg marked this pull request as ready for review

January 23, 2022 22:25

chore: fix docs.test.ts

11b5c05

Copy link

codecovbot commentedJan 23, 2022•
edited
Loading

Codecov Report

Merging#4367 (fed1694) intomain (d4768c0) willincrease coverage by7.40%.
The diff coverage isn/a.

❗ Current headfed1694 differs from pull request most recent headfc3404b. Consider uploading reports for the commitfc3404b to get more accurate results

@@            Coverage Diff             @@##             main    #4367      +/-   ##==========================================+ Coverage   86.97%   94.38%   +7.40%==========================================  Files           5      164     +159       Lines         215     9235    +9020       Branches       60     2889    +2829     ==========================================+ Hits          187     8716    +8529- Misses         22      300     +278- Partials        6      219     +213

Flag	Coverage Δ
unittest	`94.38% <ø> (+7.40%)`	⬆️

Flags with carried forward coverage won't be shown.Click here to find out more.

Impacted Files	Coverage Δ
...internal/src/rules/no-typescript-default-import.ts
...plugin-internal/src/rules/prefer-ast-types-enum.ts
...gin-internal/src/rules/no-poorly-typed-ts-props.ts
...-internal/src/rules/no-typescript-estree-import.ts
...lugin-internal/src/rules/plugin-test-formatting.ts
packages/eslint-plugin/src/rules/no-redeclare.ts	`91.89% <0.00%> (ø)`
packages/eslint-plugin/src/rules/return-await.ts	`99.00% <0.00%> (ø)`
...s/eslint-plugin/src/rules/no-implicit-any-catch.ts	`84.61% <0.00%> (ø)`
...lugin/src/rules/padding-line-between-statements.ts	`93.83% <0.00%> (ø)`
...slint-plugin/src/rules/prefer-namespace-keyword.ts	`100.00% <0.00%> (ø)`
... and159 more