Repository navigation
chore: normalize package keywords and main JSDoc across _tools/eslint/rules/* outliers - #16384
Draft
Planeshifter wants to merge 6 commits into
Draft
Planeshifter wants to merge 6 commits into
Planeshifter wants to merge 6 commits into
Conversation
…/rules/eol-open-bracket-spacing` Removed `@private` from the JSDoc of `main`, which is exported as the rule's `create` method; absent in 123 of 125 sibling rules (98.4%). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017wWD7ATC5tezitwdtcJwPh
…/rules/line-closing-bracket-spacing` Removed `@private` from the JSDoc of `main`, which is exported as the rule's `create` method; absent in 123 of 125 sibling rules (98.4%). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017wWD7ATC5tezitwdtcJwPh
…vate-annotation` Added namespace keyword `plugin` (present in 121 of 125 sibling rules, 96.8%). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017wWD7ATC5tezitwdtcJwPh
…uire-throws-tags` Added namespace keyword `plugin` (present in 121 of 125 sibling rules, 96.8%). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017wWD7ATC5tezitwdtcJwPh
…cessary-nested-functions` Added namespace keywords `custom` (124 of 125 siblings, 99.2%), `rules` (123 of 125, 98.4%), and `plugin` (121 of 125, 96.8%). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017wWD7ATC5tezitwdtcJwPh
…eclarations-doctest` Added namespace keywords `rules` (123 of 125 siblings, 98.4%) and `plugin` (121 of 125, 96.8%). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017wWD7ATC5tezitwdtcJwPh
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request:
_tools/eslint/rulespackages in line with the conventions followed by nearly all of the namespace's 125 rule packages. Only package metadata and JSDoc change; rule behavior does not.Namespace summary. 125 members, none autogenerated. 24 features analyzed: structural features (file tree,
package.jsonkeys,scripts,directories, keywords, README sections) and semantic features (lib/main.jssection layout, rule object shape,meta/docskeys,mainsignature and JSDoc tags, report style, dependencies). 23 had a clear majority (≥75%). One did not and was excluded:metakey set, where the most common pattern covers only 67.2%._tools/eslint/rules/eol-open-bracket-spacingRemoves
@privatefrom the JSDoc ofmain.mainis exported as the rule'screatemethod, and 123 of 125 rules (98.4%) leave this tag off._tools/eslint/rules/line-closing-bracket-spacingSame fix as
eol-open-bracket-spacing, of which this package is a near copy: removes@privatefrommain(absent in 98.4% of rules)._tools/eslint/rules/jsdoc-private-annotationAdds the namespace keyword
pluginafterrule(present in 121 of 125 rules, 96.8%)._tools/eslint/rules/jsdoc-require-throws-tagsAdds the namespace keyword
pluginafterrule(96.8%)._tools/eslint/rules/no-unnecessary-nested-functionsAdds the namespace keywords
custom(99.2%),rules(98.4%), andplugin(96.8%) in their usual order._tools/eslint/rules/tsdoc-declarations-doctestAdds the namespace keywords
rules(98.4%) andplugin(96.8%) in their usual order.Related Issues
None.
Reference Packages
This pull request followed these packages:
_tools/eslint/rules/*packages, which form the majority pattern (e.g.,_tools/eslint/rules/jsdoc-doctest,_tools/eslint/rules/no-builtin-math).package.jsonkeyword set and order; JSDoc tag set onmain.Questions
No.
Other
Validation. Features were extracted from every package's files and
lib/main.js. Each candidate fix was then checked by three separate reviews: semantic (is the deviation intentional?), cross-reference (do tests, examples, or tooling depend on the deviating state?), and structural (does the majority pattern apply?). All six packages were confirmed as drift by all three. Thejsdoc-private-annotationrule does not flagmainwithout@private, becausemainis assigned tocreate. The editedpackage.jsonfiles parse as valid JSON.Deliberately excluded:
test/fixtures/unvalidated.js, missing in 6 packages: adding it would require test changes.bin: {}, missing in 3 packages: present in only about 9% of packages repo-wide.__stdlib__intsdoc-declarations-doctest: intentional environment metadata.// MODULES //section in 18 rules: these rules have norequirecalls.context.reportstyle in thedoctest,jsdoc-doctest, andtsdoc-declarations-doctestrules: changing it would change behavior.metakey set: no clear majority.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was written primarily by Claude Code, through an automated check that compares packages in a namespace against their siblings.
@stdlib-js/reviewers
Generated by Claude Code