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 'recommended' status to each rule as a starter #317

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jdforrester
Copy link
Member

@jdforrester jdforrester commented Jun 3, 2024

Now-recommended rules:
- no-animate-toggle
- no-animate
- no-class-state
- no-constructor-attributes
- no-deferred
- no-extend
- no-fx-interval
- no-global-selector
- no-jquery-constructor
- no-load-shorthand
- no-on-ready
- no-parse-html-literal
- no-ready
- no-sizzle
- variable-pattern

Fixes #249.

@jdforrester jdforrester requested a review from edg2s June 3, 2024 20:14
Copy link

codecov bot commented Jun 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (6f5cc33) to head (aff0669).

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #317   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          103       103           
  Lines          603       603           
=========================================
  Hits           603       603           
Files Coverage Δ
src/rules/no-ajax-events.js 100.00% <ø> (ø)
src/rules/no-animate-toggle.js 100.00% <ø> (ø)
src/rules/no-animate.js 100.00% <ø> (ø)
src/rules/no-append-html.js 100.00% <ø> (ø)
src/rules/no-class-state.js 100.00% <ø> (ø)
src/rules/no-constructor-attributes.js 100.00% <ø> (ø)
src/rules/no-deferred.js 100.00% <ø> (ø)
src/rules/no-extend.js 100.00% <ø> (ø)
src/rules/no-fx-interval.js 100.00% <ø> (ø)
src/rules/no-global-selector.js 100.00% <ø> (ø)
... and 9 more

docs/rules/no-is-function.md Outdated Show resolved Hide resolved
@edg2s
Copy link
Member

edg2s commented Jun 4, 2024

How have you decided which rules are recommended?

@jdforrester
Copy link
Member Author

How have you decided which rules are recommended?

Gut feeling / commonality in practice of changes, mostly. Very happy to change any of them.

@edg2s
Copy link
Member

edg2s commented Jun 4, 2024

Is the boolean used for anything? I'm hesitant to include this in the release without thinking about it a bit more.

@jdforrester
Copy link
Member Author

Is the boolean used for anything? I'm hesitant to include this in the release without thinking about it a bit more.

The next commit in the stack requires this commit.

@jdforrester
Copy link
Member Author

jdforrester commented Jun 4, 2024

[Edit: Oh, never mind, you just opted out for now. Sure.] Wait, now you've squash-merged a different version of this commit in 8acaa2e instead?

Now-recommended rules:
- no-animate-toggle
- no-animate
- no-class-state
- no-constructor-attributes
- no-deferred
- no-extend
- no-fx-interval
- no-global-selector
- no-jquery-constructor
- no-load-shorthand
- no-on-ready
- no-parse-html-literal
- no-ready
- no-sizzle
- variable-pattern

Fixes #249.
@edg2s
Copy link
Member

edg2s commented Jun 9, 2024

According to the docs:

recommended: (boolean) For core rules, this specifies whether the rule is enabled by the recommended config from @eslint/js.

We also have a recommended config that only applies variable-pattern. If we do use the flag it should match the list. I'm not sure why you would specify that a rule is recommended in two places though...

@edg2s
Copy link
Member

edg2s commented Jun 9, 2024

Not also in general for the parent property docs:

docs: (object) Properties often used for documentation generation and tooling. Required for core rules and optional for custom rules. Custom rules can include additional properties here as needed.

https://eslint.org/docs/latest/extend/custom-rules

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Create a recommended config
2 participants