Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing rule descriptions #904

Merged
merged 1 commit into from
Oct 30, 2022
Merged

Add missing rule descriptions #904

merged 1 commit into from
Oct 30, 2022

Conversation

bmish
Copy link
Contributor

@bmish bmish commented Oct 30, 2022

Follow-up to #901 where I added eslint-doc-generator.

I noticed some rule descriptions were missing. All rules should have descriptions, even if they're deprecated.

@codecov
Copy link

codecov bot commented Oct 30, 2022

Codecov Report

Merging #904 (79b975a) into main (6d7a857) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #904      +/-   ##
==========================================
- Coverage   99.29%   99.29%   -0.01%     
==========================================
  Files         103      103              
  Lines        1571     1570       -1     
  Branches      514      514              
==========================================
- Hits         1560     1559       -1     
  Misses         11       11              
Impacted Files Coverage Δ
src/rules/accessible-emoji.js 100.00% <ø> (ø)
src/rules/label-has-for.js 100.00% <ø> (ø)
src/rules/no-aria-hidden-on-focusable.js 100.00% <ø> (ø)
src/rules/prefer-tag-over-role.js 100.00% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Member

@ljharb ljharb left a comment

Choose a reason for hiding this comment

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

Thanks!

@bmish
Copy link
Contributor Author

bmish commented Oct 30, 2022

I'm not sure why CI is failing:

> eslint-doc-generator --rule-doc-title-format prefix-name --rule-doc-section-options false --config-emoji recommended,☑️ --check

Please run eslint-doc-generator. README.md is out-of-date.

I don't see a diff when I run it locally.

I'm implementing a feature so we can see what diff is occurring during CI: bmish/eslint-doc-generator#187

@ljharb
Copy link
Member

ljharb commented Oct 30, 2022

I got a diff locally, but only after running npm install ¯\_(ツ)_/¯

@bmish
Copy link
Contributor Author

bmish commented Oct 30, 2022

Okay yeah, looks like it's fixed now. Problem might have been because I was mixing up npm/yarn with installing/running it.

@ljharb ljharb merged commit 79b975a into jsx-eslint:main Oct 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants