[Linter] Update linter rule to check if sdk-type exists in package.json #18597
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
bzhang0
requested review from
deyaaeldeen,
maorleger,
mikeharder,
praveenkuttappan,
sadasant and
witemple-msft
as code owners
ghost
added
KeyVault
eslint plugin
customer-reported
|
Thank you for your contribution bzhang0! We will review the pull request and get back to you soon. |
maorleger
approved these changes
Nov 9, 2021
There was a problem hiding this comment.
🚀 this looks fine to me. For the README update I think 3.1.0 is fine, this is the latest version we used when adding ts-no-window and this isn't actually released to npm anymore
Thanks for helping out!
@bzhang0 I can merge this after the README is updated
deyaaeldeen
approved these changes
Nov 9, 2021
| if (!["client", "mgmt"].includes(strValue)) { | ||
| context.report({ | ||
| node: node.value, | ||
| message: "sdk-type is not set to `client` or `mgmt`" |
There was a problem hiding this comment.
Perhaps it could be useful to print the unrecognized value too?
Suggested change
| message: "sdk-type is not set to `client` or `mgmt`" | |
| message: `unrecognized sdk-type value: ${strValue}. Expected `client` or `mgmt` instead.` |
Please note the error messages in the tests will need to be updated too.
|
@maorleger @deyaaeldeen I'll have these changes done! |
jeremymeng
reviewed
Nov 9, 2021
|
|
||
| const strValue = stripPath(value.value); | ||
|
|
||
| if (!["client", "mgmt"].includes(strValue)) { |
There was a problem hiding this comment.
Please add "utility" into the allowed list. It was just added earlier in #18402.
deyaaeldeen
approved these changes
Nov 10, 2021
danieljurek
pushed a commit
that referenced
this pull request
Nov 10, 2021
…on (#18597) This fixes #13214. This PR is an update from a past PR, #18565. What's new? - I updated ```ts-package-json-sdktype.ts``` to enforce the existence of```sdk-type``` and that it is either ```client``` or ```mgmt```. If it does not, then the linter will throw an error. - I added/updated appropriate tests and verified the entire repository using ```rush lint``` - I also put the rules in the correct files (```src/configs/index.ts, src/rules/index.ts```, and ```tests/plugin.ts```) - I have written a docs file to put in ```docs/rules``` which are now included in the commit! - I do need to still update the actual ```README.md``` file, but I'm not sure what the actual version is (hopefully this isn't too much trouble)
maorleger
added a commit
that referenced
this pull request
Nov 22, 2021
It looks like ts-package-json-sdktype rule entry was duplicated in #18597 - which causes the "number of rules should match the expected value" to report an error. This PR fixes the issue by removing the duplicated entry. I also went ahead and sorted the entries to make these things easier to spot in the future (although there is no guarantee sort will be preserved).
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.
This fixes #13214. This PR is an update from a past PR, #18565.
What's new?
ts-package-json-sdktype.tsto enforce the existence ofsdk-typeand that it is eitherclientormgmt. If it does not, then the linter will throw an error.rush lintsrc/configs/index.ts, src/rules/index.ts, andtests/plugin.ts)docs/ruleswhich are now included in the commit!README.mdfile, but I'm not sure what the actual version is (hopefully this isn't too much trouble)Let me know if there's anything I missed!