feat: no-depends-on-boolean-flag rule
#447
Merged
Conversation
This file contains 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
cristiand391
changed the title
no-depends-on-boolean-flag rule
cristiand391
commented
Jul 25, 2024
| @@ -10,6 +10,8 @@ jobs: | |||
| linux-unit-tests: | |||
| needs: yarn-lockfile-check | |||
| uses: salesforcecli/github-workflows/.github/workflows/unitTestsLinux.yml@main | |||
| with: | |||
| skipTsDepCheck: true | |||
There was a problem hiding this comment.
opt-in way to disable the ts-dep-check, see: salesforcecli/github-workflows#120
this is a devDep so it's ok to ship TS
cristiand391
commented
Jul 25, 2024
| @@ -90,6 +91,7 @@ const recommended = { | |||
| 'sf-plugin/no-default-and-depends-on-flags': 'error', | |||
| 'sf-plugin/only-extend-SfCommand': 'warn', | |||
| 'sf-plugin/spread-base-flags': 'warn', | |||
| 'sf-plugin/no-depends-on-boolean-flag': 'warn', | |||
There was a problem hiding this comment.
warn instead of error because there are cases where depending on a boolean flag works as expected:
flag1is boolean and has no default value/noallowNoflag2depends onflag1
there's no way flag1 can have a value if it's not passed in. Still, the warning should push users to double-check and future-proof their code 😉
cristiand391
commented
Jul 25, 2024
| f.value.callee.type == AST_NODE_TYPES.MemberExpression && | ||
| f.value.callee.property.type == AST_NODE_TYPES.Identifier && | ||
| f.value.callee.property.name === 'boolean' | ||
| ); |
There was a problem hiding this comment.
mshanemc
reviewed
Jul 25, 2024
| recommended: 'recommended', | ||
| }, | ||
| messages: { | ||
| message: 'Cannot create a flag that `dependsOn` a boolean flag', |
There was a problem hiding this comment.
can the message say more, something like, "use the relationships property with a when function".
* refactor: pr review * refactor: min/max/default
|
@mshanemc this PR has a ton of commits, make sure to squash-merge it when QA is done. |
mshanemc
approved these changes
Jul 26, 2024
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.
Closes: #446
Adds a new
no-depends-on-boolean-flagrule, see: https://github.com/salesforcecli/eslint-plugin-sf-plugin/blob/cd/depend-on-boolean-flag/docs/rules/no-depends-on-boolean-flag.mdDidn't do the autofix because I'm not sure it would be a good default and added more complexity (had to handle flags with
relationshipsalready defined, what if you really wanted it to depend on value, etc).@W-16320656@