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

Fix: False negative with TypeScript rules that don't have type parameters (fixes #202) #209

Merged
merged 1 commit into from
Oct 13, 2021
Merged

Fix: False negative with TypeScript rules that don't have type parameters (fixes #202) #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 0 additions & 2 deletions lib/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,6 @@ function getRuleExportsESM (ast) {
return { create: node, meta: null, isNewStyle: false };
} else if (
node.type === 'CallExpression' &&
node.typeParameters &&
node.typeParameters.params.length === 2 && // Expecting: <Options, MessageIds>
node.arguments.length === 1 &&
node.arguments[0].type === 'ObjectExpression' &&
// Check various TypeScript rule helper formats.
Expand Down
33 changes: 22 additions & 11 deletions tests/lib/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,6 @@ describe('utils', () => {
'export default foo.bar(123);',
'export default foo.bar()(123);',

// Correct TypeScript helper structure but missing parameterized types:
'export default createESLintRule({ create() {}, meta: {} });',
'export default util.createRule({ create() {}, meta: {} });',
'export default ESLintUtils.RuleCreator(docsUrl)({ create() {}, meta: {} });',
].forEach(noRuleCase => {
it(`returns null for ${noRuleCase}`, () => {
const ast = espree.parse(noRuleCase, { ecmaVersion: 8, range: true, sourceType: 'module' });
Expand All @@ -75,13 +71,6 @@ describe('utils', () => {
'export default foo<Options, MessageIds>(123);',
'export default foo.bar<Options, MessageIds>(123);',
'export default foo.bar()<Options, MessageIds>(123);',

// Correct TypeScript helper structure but missing parameterized types:
'export default createESLintRule({ create() {}, meta: {} });',
'export default createESLintRule<>({ create() {}, meta: {} });',
'export default createESLintRule<OnlyOneType>({ create() {}, meta: {} });',
'export default util.createRule({ create() {}, meta: {} });',
'export default ESLintUtils.RuleCreator(docsUrl)({ create() {}, meta: {} });',
].forEach(noRuleCase => {
it(`returns null for ${noRuleCase}`, () => {
const ast = typescriptEslintParser.parse(noRuleCase, { ecmaVersion: 8, range: true, sourceType: 'module' });
Expand Down Expand Up @@ -112,18 +101,40 @@ describe('utils', () => {
meta: { type: 'ObjectExpression' },
isNewStyle: true,
},
'export default createESLintRule<>({ create() {}, meta: {} });': {
create: { type: 'FunctionExpression' },
meta: { type: 'ObjectExpression' },
isNewStyle: true,
},
'export default createESLintRule({ create() {}, meta: {} });': {
create: { type: 'FunctionExpression' },
meta: { type: 'ObjectExpression' },
isNewStyle: true,
},

// Util function from util object
'export default util.createRule<Options, MessageIds>({ create() {}, meta: {} });': {
create: { type: 'FunctionExpression' },
meta: { type: 'ObjectExpression' },
isNewStyle: true,
},
'export default util.createRule({ create() {}, meta: {} });': {
create: { type: 'FunctionExpression' },
meta: { type: 'ObjectExpression' },
isNewStyle: true,
},

// Util function from util object with additional doc URL argument
'export default ESLintUtils.RuleCreator(docsUrl)<Options, MessageIds>({ create() {}, meta: {} });': {
create: { type: 'FunctionExpression' },
meta: { type: 'ObjectExpression' },
isNewStyle: true,
},
'export default ESLintUtils.RuleCreator(docsUrl)({ create() {}, meta: {} });': {
create: { type: 'FunctionExpression' },
meta: { type: 'ObjectExpression' },
isNewStyle: true,
},
};

Object.keys(CASES).forEach(ruleSource => {
Expand Down