Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat(eslint-plugin): [ban-ts-comments] add "allow-with-description" option #2099

Merged
merged 8 commits into from May 30, 2020
Merged

feat(eslint-plugin): [ban-ts-comments] add "allow-with-description" option #2099

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
73c5b64
adds "allow-with-description" option to `ban-ts-comments` rule
dimitropoulos May 25, 2020
a4b99d7
updates message to resemble the eslint-comments/require-description
dimitropoulos May 25, 2020
12262fe
adds threshold for minimum length
dimitropoulos May 26, 2020
fda8ee1
adds documentation for allow-with-description
dimitropoulos May 26, 2020
27fd610
removes unknown cspell word to make CI pass
dimitropoulos May 26, 2020
65c71a0
adds `minimumDescriptionLength` option to `ban-ts-comment`
dimitropoulos May 26, 2020
a1a8e0e
use `noFormat` instead of eslint-disable
dimitropoulos May 26, 2020
c5b0b9d
updates test to satisfy cspell
dimitropoulos May 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/eslint-plugin/src/rules/ban-ts-comment.ts
View file
Open in desktop
Expand Up @@ -119,7 +119,8 @@ export default util.createRule<[Options], MessageIds>({
}

if (option === 'allow-with-description') {
if (description.length === 0) {
const threshold = 3;
if (description.trim().length < threshold) {
context.report({
data: { directive },
node: comment,
Expand Down
25 changes: 25 additions & 0 deletions packages/eslint-plugin/tests/rules/ban-ts-comment.test.ts
View file
Open in desktop
Expand Up @@ -187,6 +187,31 @@ if (false) {
},
],
},
{
// eslint-disable-next-line @typescript-eslint/internal/plugin-test-formatting
code: '// @ts-ignore ',
dimitropoulos marked this conversation as resolved.
Show resolved Hide resolved
options: [{ 'ts-ignore': 'allow-with-description' }],
errors: [
{
data: { directive: 'ignore' },
messageId: 'tsDirectiveCommentRequiresDescription',
line: 1,
column: 1,
},
],
},
{
code: '// @ts-ignore .',
options: [{ 'ts-ignore': 'allow-with-description' }],
errors: [
{
data: { directive: 'ignore' },
messageId: 'tsDirectiveCommentRequiresDescription',
line: 1,
column: 1,
},
],
},
],
});

Expand Down