Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
feat(eslint-plugin): [restrict-plus-operands] add allowAny option#901
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
feat(eslint-plugin): [restrict-plus-operands] add allowAny option#901
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Thanks for the PR,@lonyele! 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 onhttps://opencollective.com/typescript-eslint |
codecovbot commentedAug 24, 2019 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Codecov Report
@@ Coverage Diff @@## master #901 +/- ##==========================================+ Coverage 94.13% 94.13% +<.01%========================================== Files 115 115 Lines 5011 5013 +2 Branches 1399 1400 +1 ==========================================+ Hits 4717 4719 +2 Misses 166 166 Partials 128 128
|
| @@ -88,6 +106,10 @@ export default util.createRule({ | |||
| const leftType = getNodeType(node.left); | |||
| const rightType = getNodeType(node.right); | |||
| if (option.allowAny && (leftType === 'any' || rightType === 'any')) { | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
this is not quite correct.
This shouldn't override all validation in the rule, it should only allowany as a valid type.
I.e.any + boolean shouldn't be allowed - becauseboolean isn't a valid type for this rule without the option.
Howeverany + (string | number | bigint) should be allowed, as those 3 are all valid types.
| }, | ||
| { | ||
| code: ` | ||
| export const f = (a: boolean, b: any) => a + b; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
as mentioned - this should be invalid
| ```ts | ||
| const x = (a: any, b: string) => a + b; | ||
| const y = (a: boolean, b: any) => a + b; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
ditto - see comment in rule
| If the rule is too strict then making this option `true` | ||
| can be a help. Though It is not recommended since lint errors are potentially a real runtime errors in many cases. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Suggestion for stronger/clearer wording for this:
This option is not recommended, as it greatly reduces the type safety in your code.
It is provided as a stopgap to make it easier to migrate codebases onto the rule.
This option will cause the rule to acceptany as a type for operands.any will be allowed to be summed with all other valid types.
| Options may be provided as an object with: | ||
| - `allowAny` to ignore this rule when either left or | ||
| right of plus operand is a type `any` | ||
| ```json | ||
| { | ||
| "@typescript-eslint/restrict-plus-operands": "error" | ||
| "@typescript-eslint/estrict-plus-operands": [ | ||
| "error", | ||
| { | ||
| "allowAny": true | ||
| } | ||
| ] | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This section can be changed to just this snippet.
We try to avoid putting the full config block in rule docs now.
typeOptions={allowAny?:boolean;}constdefaultOptions:Options={allowAny:false,};
Fixes#386
I added
allowAnyoption to the rule as described in the issue. Please take a look.