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): [ban-ts-comment] add descriptionFormat option#5026
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
Merged
JoshuaKGoldberg merged 6 commits intotypescript-eslint:mainfromJosh-Cena:ts-expect-error-patternMay 25, 2022
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
6 commits Select commitHold shift + click to select a range
273e750 feat(eslint-plugin): [ban-ts-comment] add descriptionFormat option fo…
Josh-Cenaa1686bb test: test
Josh-Cena88430b3 Update packages/eslint-plugin/src/rules/ban-ts-comment.ts
Josh-Cenaacf7b70 Merge branch 'master' into ts-expect-error-pattern
Josh-Cena620bf20 refactor: deduplicate
Josh-Cenaa93f5b0 Merge branch 'main' into ts-expect-error-pattern
JoshuaKGoldbergFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
127 changes: 70 additions & 57 deletionspackages/eslint-plugin/src/rules/ban-ts-comment.ts
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 |
|---|---|---|
| @@ -1,19 +1,43 @@ | ||
| import { AST_TOKEN_TYPES } from '@typescript-eslint/utils'; | ||
| import * as util from '../util'; | ||
| type DirectiveConfig = | ||
| | boolean | ||
| | 'allow-with-description' | ||
| | { descriptionFormat: string }; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Hmm, it would be nice to have | ||
| interface Options { | ||
| 'ts-expect-error'?:DirectiveConfig; | ||
| 'ts-ignore'?:DirectiveConfig; | ||
| 'ts-nocheck'?:DirectiveConfig; | ||
| 'ts-check'?:DirectiveConfig; | ||
| minimumDescriptionLength?: number; | ||
| } | ||
| const directiveConfigSchema = { | ||
| oneOf: [ | ||
| { | ||
| type: 'boolean', | ||
| default: true, | ||
| }, | ||
| { | ||
| enum: ['allow-with-description'], | ||
| }, | ||
| { | ||
| type: 'object', | ||
| properties: { | ||
| descriptionFormat: { type: 'string' }, | ||
| }, | ||
| }, | ||
| ], | ||
| }; | ||
| export const defaultMinimumDescriptionLength = 3; | ||
| type MessageIds = | ||
| | 'tsDirectiveComment' | ||
| | 'tsDirectiveCommentRequiresDescription' | ||
| | 'tsDirectiveCommentDescriptionNotMatchPattern'; | ||
| export default util.createRule<[Options], MessageIds>({ | ||
| name: 'ban-ts-comment', | ||
| @@ -29,55 +53,17 @@ export default util.createRule<[Options], MessageIds>({ | ||
| 'Do not use "@ts-{{directive}}" because it alters compilation errors.', | ||
| tsDirectiveCommentRequiresDescription: | ||
| 'Include a description after the "@ts-{{directive}}" directive to explain why the @ts-{{directive}} is necessary. The description must be {{minimumDescriptionLength}} characters or longer.', | ||
| tsDirectiveCommentDescriptionNotMatchPattern: | ||
| 'The description for the "@ts-{{directive}}" directive must match the {{format}} format.', | ||
| }, | ||
| schema: [ | ||
| { | ||
| type: 'object', | ||
| properties: { | ||
| 'ts-expect-error': directiveConfigSchema, | ||
| 'ts-ignore': directiveConfigSchema, | ||
| 'ts-nocheck': directiveConfigSchema, | ||
| 'ts-check': directiveConfigSchema, | ||
| minimumDescriptionLength: { | ||
| type: 'number', | ||
| default: defaultMinimumDescriptionLength, | ||
| @@ -99,25 +85,42 @@ export default util.createRule<[Options], MessageIds>({ | ||
| create(context, [options]) { | ||
| /* | ||
| The regex used are taken from the ones used in the official TypeScript repo - | ||
| https://github.com/microsoft/TypeScript/blob/408c760fae66080104bc85c449282c2d207dfe8e/src/compiler/scanner.ts#L288-L296 | ||
bradzacher marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| */ | ||
| const commentDirectiveRegExSingleLine = | ||
| /^\/*\s*@ts-(?<directive>expect-error|ignore|check|nocheck)(?<description>.*)/; | ||
| const commentDirectiveRegExMultiLine = | ||
| /^\s*(?:\/|\*)*\s*@ts-(?<directive>expect-error|ignore|check|nocheck)(?<description>.*)/; | ||
| const sourceCode = context.getSourceCode(); | ||
| const descriptionFormats = new Map<string, RegExp>(); | ||
| for (const directive of [ | ||
| 'ts-expect-error', | ||
| 'ts-ignore', | ||
| 'ts-nocheck', | ||
| 'ts-check', | ||
| ] as const) { | ||
| const option = options[directive]; | ||
| if (typeof option === 'object' && option.descriptionFormat) { | ||
| descriptionFormats.set(directive, new RegExp(option.descriptionFormat)); | ||
| } | ||
| } | ||
| return { | ||
| Program(): void { | ||
| const comments = sourceCode.getAllComments(); | ||
| comments.forEach(comment => { | ||
| const regExp = | ||
| comment.type === AST_TOKEN_TYPES.Line | ||
| ? commentDirectiveRegExSingleLine | ||
| : commentDirectiveRegExMultiLine; | ||
| const match = regExp.exec(comment.value); | ||
| if (!match) { | ||
| return; | ||
| } | ||
| const{ directive, description } = match.groups!; | ||
| const fullDirective = `ts-${directive}` as keyof Options; | ||
| @@ -130,16 +133,26 @@ export default util.createRule<[Options], MessageIds>({ | ||
| }); | ||
| } | ||
| if ( | ||
| option === 'allow-with-description' || | ||
| (typeof option === 'object' && option.descriptionFormat) | ||
| ) { | ||
| const { | ||
| minimumDescriptionLength = defaultMinimumDescriptionLength, | ||
| } = options; | ||
| const format = descriptionFormats.get(fullDirective); | ||
| if (description.trim().length < minimumDescriptionLength) { | ||
| context.report({ | ||
| data: { directive, minimumDescriptionLength }, | ||
| node: comment, | ||
| messageId: 'tsDirectiveCommentRequiresDescription', | ||
| }); | ||
| } else if (format && !format.test(description)) { | ||
| context.report({ | ||
| data: { directive, format: format.source }, | ||
| node: comment, | ||
| messageId: 'tsDirectiveCommentDescriptionNotMatchPattern', | ||
| }); | ||
| } | ||
| } | ||
| }); | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.