-
Notifications
You must be signed in to change notification settings - Fork 115
chore: add check-variants rule to ESLint plugin #5678
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
Open
MattDevy
wants to merge
1
commit into
main
Choose a base branch
from
chore/check-variants
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+215
−15
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| /* | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| import { ESLintUtils } from '@typescript-eslint/utils' | ||
|
|
||
| export const checkVariants = ESLintUtils.RuleCreator.withoutDocs({ | ||
| name: 'check-variants', | ||
| meta: { | ||
| type: 'problem', | ||
| docs: { | ||
| description: 'Checks that variants are allowed on a given type.', | ||
| recommended: 'error' | ||
| }, | ||
| messages: { | ||
| variantsOnRequestOrResponse: | ||
| 'Variants are not allowed on {{ className }} classes.', | ||
| interfaceWithNonContainerVariants: | ||
| "Interface '{{ interfaceName }}' has '@variants {{ variantValue }}' but only 'container' is allowed for interfaces.", | ||
| invalidVariantsTag: | ||
| "Type alias '{{ typeName }}' has invalid '@variants {{ variantValue }}'. Must start with: {{ allowedValues }}." | ||
| } | ||
| }, | ||
| defaultOptions: [], | ||
| create(context) { | ||
| const sourceCode = context.sourceCode || context.getSourceCode() | ||
|
|
||
| const getJsDocTags = (node) => { | ||
| const targetNode = | ||
| node.parent?.type === 'ExportNamedDeclaration' ? node.parent : node | ||
| const comments = sourceCode.getCommentsBefore(targetNode) | ||
|
|
||
| const jsDocComment = comments | ||
| ?.filter( | ||
| (comment) => comment.type === 'Block' && comment.value.startsWith('*') | ||
| ) | ||
| .pop() | ||
|
|
||
| if (!jsDocComment) return [] | ||
|
|
||
| return jsDocComment.value | ||
| .split('\n') | ||
| .map((line) => line.trim().match(/^\*?\s*@(\w+)(?:\s+(.*))?$/)) | ||
| .filter(Boolean) | ||
| .map(([, tag, value]) => ({ tag, value: value?.trim() || '' })) | ||
| } | ||
|
|
||
| const isRequestOrResponse = (name) => | ||
| name === 'Request' || name === 'Response' | ||
|
|
||
| const hasVariantsTag = (tags) => tags.some(({ tag }) => tag === 'variants') | ||
|
|
||
| return { | ||
| 'TSInterfaceDeclaration, ClassDeclaration'(node) { | ||
| const jsDocTags = getJsDocTags(node) | ||
| if (isRequestOrResponse(node.id.name)) { | ||
| if (hasVariantsTag(jsDocTags)) { | ||
| context.report({ | ||
| node, | ||
| messageId: 'variantsOnRequestOrResponse', | ||
| data: { className: node.id.name } | ||
| }) | ||
| } | ||
| return | ||
| } | ||
|
|
||
| const nonContainerVariant = jsDocTags.find( | ||
| ({ tag, value }) => tag === 'variants' && value !== 'container' | ||
| ) | ||
| if (nonContainerVariant) { | ||
| context.report({ | ||
| node, | ||
| messageId: 'interfaceWithNonContainerVariants', | ||
| data: { | ||
| interfaceName: node.id.name, | ||
| variantValue: nonContainerVariant.value | ||
| } | ||
| }) | ||
| return | ||
| } | ||
| }, | ||
| TSTypeAliasDeclaration(node) { | ||
| const jsDocTags = getJsDocTags(node) | ||
| const allowedVariants = ['internal', 'typed_keys_quirk', 'untagged'] | ||
|
|
||
| const invalidVariant = jsDocTags.find( | ||
| ({ tag, value }) => | ||
| tag === 'variants' && | ||
| !allowedVariants.some((allowed) => value.startsWith(allowed)) | ||
| ) | ||
|
|
||
| if (invalidVariant) { | ||
| context.report({ | ||
| node, | ||
| messageId: 'invalidVariantsTag', | ||
| data: { | ||
| typeName: node.id.name, | ||
| variantValue: invalidVariant.value, | ||
| allowedValues: allowedVariants.join(', ') | ||
| } | ||
| }) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }) | ||
|
|
||
| export default checkVariants |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| /* | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| import { RuleTester } from '@typescript-eslint/rule-tester' | ||
| import rule from '../rules/check-variants.js' | ||
|
|
||
| const ruleTester = new RuleTester({ | ||
| languageOptions: { | ||
| parserOptions: { | ||
| projectService: { | ||
| allowDefaultProject: ['*.ts*'] | ||
| }, | ||
| tsconfigRootDir: import.meta.dirname | ||
| } | ||
| } | ||
| }) | ||
|
|
||
| ruleTester.run('check-variants', rule, { | ||
| valid: [ | ||
| { | ||
| name: 'not Request or Response', | ||
| code: `/** @variants container */ | ||
| export class MyClass { | ||
| body: MyContainer | ||
| }` | ||
| }, | ||
| { | ||
| name: 'internal tag on type alias', | ||
| code: `/** @variants internal tag='type' */ | ||
| export type MyType = string | number` | ||
| } | ||
| ], | ||
| invalid: [ | ||
| { | ||
| name: 'Request has variants tag', | ||
| code: `/** @variants container */ | ||
| export class Request {}`, | ||
| errors: [{ messageId: 'variantsOnRequestOrResponse' }] | ||
| }, | ||
| { | ||
| name: 'Response has variants tag', | ||
| code: `/** @variants container */ | ||
| export class Response {}`, | ||
| errors: [{ messageId: 'variantsOnRequestOrResponse' }] | ||
| }, | ||
| { | ||
| name: 'Interface has non-container variants tag', | ||
| code: `/** @variants internal */ | ||
| export class RankContainer {}`, | ||
| errors: [{ messageId: 'interfaceWithNonContainerVariants' }] | ||
| }, | ||
| { | ||
| name: 'Type alias has invalid variants tag', | ||
| code: `/** @variants invalid */ | ||
| export type MyType = string | number`, | ||
| errors: [{ messageId: 'invalidVariantsTag' }] | ||
| } | ||
| ] | ||
| }) |
Oops, something went wrong.
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.
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.
lgtm! Although I think it would be nice to extend off of the existing variant rule...at least thats what I had in mind
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.
That would make a lot of sense. I will refactor it into the existing rule Monday morning! 🙂