8000 chore(eslint-plugin): enhance many rule descriptions by JoshuaKGoldberg · Pull Request #5696 · typescript-eslint/typescript-eslint · GitHub
[go: up one dir, main page]
Skip to content

chore(eslint-plugin): enhance many rule descriptions #5696

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 19 commits into from
Oct 4, 2022
Merged

chore(eslint-plugin): enhance many rule descriptions #5696

merged 19 commits into from
Oct 4, 2022

Conversation

JoshuaKGoldberg
Copy link
Member
@JoshuaKGoldberg JoshuaKGoldberg commented Sep 28, 2022 •
edited
Loading

PR Checklist

Overview

Goes through the ~90 core (non-extension, non-formatting) rules and spruces up the docs page. For each rule I tried to keep its documentation to roughly the following format:

  1. A brief description of the TypeScript syntax at play, if relevant
  2. What issue the rule is meant to tackle
  3. How the rule tackles the issue

This isn't 100% consistently kept to because I ran out of energy repeatedly throughout writing this horrendously boring PR. If you point out discrepancies that will help me regain the energy to fix them.

Simplifies the typical rule docs page format by joining the initial description with the Rule Details section, leaving an Examples section for just examples.

Pairs nicely with #5702.

@nx-cloud
Copy link
nx-cloud bot commented Sep 28, 2022 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 3e54ec0. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 47 targets

Sent with 💌 from NxCloud.

@typescript-eslint
Copy link
Contributor

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.

@netlify
Copy link
netlify bot commented Sep 28, 2022 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 3e54ec0
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/633c363725c14300090ef905
😎 Deploy Preview https://deploy-preview-5696--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@JoshuaKGoldberg JoshuaKGoldberg changed the title chore(eslint-plugin): enhance many rule descriptions [WIP] chore(eslint-plugin): enhance many rule descriptions Sep 28, 2022
@JoshuaKGoldberg JoshuaKGoldberg mentioned this pull request Oct 1, 2022
Merged
3 tasks
@JoshuaKGoldberg JoshuaKGoldberg changed the title [WIP] chore(eslint-plugin): enhance many rule descriptions chore(eslint-plugin): enhance many rule descriptions Oct 1, 2022
@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review October 1, 2022 06:21
bradzacher
bradzacher previously approved these changes Oct 4, 2022
View reviewed changes
Copy link
Member
@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

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

image

@bradzacher bradzacher added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Oct 4, 2022
@JoshuaKGoldberg JoshuaKGoldberg enabled auto-merge (squash) October 4, 2022 12:38
@codecov
Copy link
codecov bot commented Oct 4, 2022 •
edited
Loading

Codecov Report

Merging #5696 (ee74a51) into main (7954c07) will increase coverage by 0.12%.
The diff coverage is n/a.

❗ Current head ee74a51 differs from pull request most recent head 3e54ec0. Consider uploading reports for the commit 3e54ec0 to get more accurate results

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #5696      +/-   ##
==========================================
+ Coverage   93.82%   93.94%   +0.12%     
==========================================
  Files         134      288     +154     
  Lines        1506     9582    +8076     
  Branches      226     2884    +2658     
==========================================
+ Hits         1413     9002    +7589     
- Misses         60      333     +273     
- Partials       33      247     +214
Flag Coverage Δ
unittest 93.94% <ø> (+0.12%) ⬆️

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

Impacted Files Coverage Δ
...t-plugin/src/rules/adjacent-overload-signatures.ts 95.34% <ø> (ø)
packages/eslint-plugin/src/rules/array-type.ts 97.14% <ø> (ø)
packages/eslint-plugin/src/rules/ban-ts-comment.ts 96.96% <ø> (ø)
.../eslint-plugin/src/rules/member-delimiter-style.ts 94.73% <ø> (ø)
...nt-plugin/src/rules/no-extra-non-null-assertion.ts 100.00% <ø> (ø)
packages/eslint-plugin/src/rules/no-namespace.ts 100.00% <ø> (ø)
.../eslint-plugin/src/rules/restrict-plus-operands.ts 88.67% <ø> (ø)
...kages/eslint-plugin/src/rules/no-dynamic-delete.ts 100.00% <0.00%> (ø)
...kages/eslint-plugin/src/rules/func-call-spacing.ts 96.87% <0.00%> (ø)
...lugin/src/rules/consistent-generic-constructors.ts 94.87% <0.00%> (ø)
... and 151 more

@JoshuaKGoldberg
Copy link
Member Author

...well this is frustrating. GitHub Actions froze at Waiting for a runner to pick up this job.... I tried canceling the job and starting a new one. I think GHA is undergoing an incident.

I can run yarn build, yarn lint, and yarn test locally to verify the merging from main did not break the world.

@JoshuaKGoldberg JoshuaKGoldberg enabled auto-merge (squash) October 4, 2022 14:16
@JoshuaKGoldberg JoshuaKGoldberg merged commit f373fac into typescript-eslint:main Oct 4, 2022
@JoshuaKGoldberg JoshuaKGoldberg deleted the rule-docs-overhaul branch October 4, 2022 15:12
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Zzzen Zzzen Zzzen left review comments

@bradzacher bradzacher bradzacher approved these changes

Assignees
No one assigned
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge
Projects
None yet
Milestone
No milestone
3 participants
@JoshuaKGoldberg @Zzzen @bradzacher
0