Skip to content

feat(require-keywords): add require-keywords rule #884

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

Merged

Conversation

chouchouji
Copy link
Contributor

@chouchouji chouchouji commented Feb 9, 2025

PR Checklist

Overview

Add require-keywords rule

Copy link

codecov bot commented Feb 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.77%. Comparing base (3a82dd8) to head (31dccb4).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #884   +/-   ##
=======================================
  Coverage   98.77%   98.77%           
=======================================
  Files          21       21           
  Lines        1220     1221    +1     
  Branches      142      142           
=======================================
+ Hits         1205     1206    +1     
  Misses         15       15           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@chouchouji
Copy link
Contributor Author

@michaelfaith @JoshuaKGoldberg Should we add some keywords for this repo? e.g eslint plugin package.json.

@michaelfaith
Copy link
Collaborator

Should we add some keywords for this repo? e.g eslint plugin package.json.

It probably wouldn't hurt, but I'm also not sure that it would help any, since those are all components of the package name already. I'd be ok with adding those.

Copy link
Collaborator

@michaelfaith michaelfaith left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks!

@michaelfaith michaelfaith merged commit 99237f0 into JoshuaKGoldberg:main Feb 9, 2025
21 of 22 checks passed
Copy link

github-actions bot commented Feb 9, 2025

🎉 This is included in version v0.25.0 🎉

The release is available on:

Cheers! 📦🚀

@chouchouji
Copy link
Contributor Author

chouchouji commented Feb 9, 2025

Should we add some keywords for this repo? e.g eslint plugin package.json.

It probably wouldn't hurt, but I'm also not sure that it would help any, since those are all components of the package name already. I'd be ok with adding those.

I think it is helpful like this repo https://github.com/vuejs/eslint-plugin-vue/blob/master/package.json#L31

@michaelfaith
Copy link
Collaborator

Helpful in what respect? Keywords are used by npm search which also searches the package's name. Maybe there's another use case i"m not aware of?

@chouchouji
Copy link
Contributor Author

Helpful in what respect? Keywords are used by npm search which also searches the package's name. Maybe there's another use case i"m not aware of?

No, you are right. I check the npm docs. This field helps to search package. It is just a suggestion and we can ignore it.

@chouchouji chouchouji deleted the feat-require-keywords branch February 9, 2025 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🚀 Feature: Bring in a require-keywords rule
2 participants