Skip to content

fix(eslint-plugin): [padding-line-between-statements] type StatementTypes can't differenciate from variable #4270

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

Merged
merged 4 commits into from
Dec 20, 2021
Merged

fix(eslint-plugin): [padding-line-between-statements] type StatementTypes can't differenciate from variable #4270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c16558d
fix: statementType keyword can't differenciate from variable
lonyele Dec 7, 2021
ebe2c42
test: add test case
lonyele Dec 7, 2021
898bf15
Merge branch 'main' into fix/type-variable-working-as-statement-type
lonyele Dec 7, 2021
da3676e
Merge branch 'main' into fix/type-variable-working-as-statement-type
lonyele Dec 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 56 additions & 25 deletions packages/eslint-plugin/src/rules/padding-line-between-statements.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,24 @@ const PADDING_LINE_SEQUENCE = new RegExp(
);

/**
* Creates tester which check if a node starts with specific keyword.
* Creates tester which check if a node starts with specific keyword with the
* appropriate AST_NODE_TYPES.
* @param keyword The keyword to test.
* @returns the created tester.
* @private
*/
function newKeywordTester(keyword: string): NodeTestObject {
function newKeywordTester(
type: AST_NODE_TYPES | AST_NODE_TYPES[],
keyword: string,
): NodeTestObject {
return {
test(node, sourceCode): boolean {
return sourceCode.getFirstToken(node)?.value === keyword;
const isSameKeyword = sourceCode.getFirstToken(node)?.value === keyword;
const isSameType = Array.isArray(type)
? type.some(val => val === node.type)
: type === node.type;

return isSameKeyword && isSameType;
},
};
}
Expand Down Expand Up @@ -525,30 +534,52 @@ const StatementTypes: Record<string, NodeTestObject> = {
empty: newNodeTypeTester(AST_NODE_TYPES.EmptyStatement),
function: newNodeTypeTester(AST_NODE_TYPES.FunctionDeclaration),

break: newKeywordTester('break'),
case: newKeywordTester('case'),
class: newKeywordTester('class'),
const: newKeywordTester('const'),
continue: newKeywordTester('continue'),
debugger: newKeywordTester('debugger'),
default: newKeywordTester('default'),
do: newKeywordTester('do'),
export: newKeywordTester('export'),
for: newKeywordTester('for'),
if: newKeywordTester('if'),
import: newKeywordTester('import'),
let: newKeywordTester('let'),
return: newKeywordTester('return'),
switch: newKeywordTester('switch'),
throw: newKeywordTester('throw'),
try: newKeywordTester('try'),
var: newKeywordTester('var'),
while: newKeywordTester('while'),
with: newKeywordTester('with'),
break: newKeywordTester(AST_NODE_TYPES.BreakStatement, 'break'),
case: newKeywordTester(AST_NODE_TYPES.SwitchCase, 'case'),
class: newKeywordTester(AST_NODE_TYPES.ClassDeclaration, 'class'),
const: newKeywordTester(AST_NODE_TYPES.VariableDeclaration, 'const'),
continue: newKeywordTester(AST_NODE_TYPES.ContinueStatement, 'continue'),
debugger: newKeywordTester(AST_NODE_TYPES.DebuggerStatement, 'debugger'),
default: newKeywordTester(
[AST_NODE_TYPES.SwitchCase, AST_NODE_TYPES.ExportDefaultDeclaration],
'default',
),
do: newKeywordTester(AST_NODE_TYPES.DoWhileStatement, 'do'),
export: newKeywordTester(
[
AST_NODE_TYPES.ExportDefaultDeclaration,
AST_NODE_TYPES.ExportNamedDeclaration,
],
'export',
),
for: newKeywordTester(
[
AST_NODE_TYPES.ForStatement,
AST_NODE_TYPES.ForInStatement,
AST_NODE_TYPES.ForOfStatement,
],
'for',
),
if: newKeywordTester(AST_NODE_TYPES.IfStatement, 'if'),
import: newKeywordTester(AST_NODE_TYPES.ImportDeclaration, 'import'),
let: newKeywordTester(AST_NODE_TYPES.VariableDeclaration, 'let'),
return: newKeywordTester(AST_NODE_TYPES.ReturnStatement, 'return'),
switch: newKeywordTester(AST_NODE_TYPES.SwitchStatement, 'switch'),
throw: newKeywordTester(AST_NODE_TYPES.ThrowStatement, 'throw'),
try: newKeywordTester(AST_NODE_TYPES.TryStatement, 'try'),
var: newKeywordTester(AST_NODE_TYPES.VariableDeclaration, 'var'),
while: newKeywordTester(
[AST_NODE_TYPES.WhileStatement, AST_NODE_TYPES.DoWhileStatement],
'while',
),
with: newKeywordTester(AST_NODE_TYPES.WithStatement, 'with'),

// Additional Typescript constructs
interface: newKeywordTester('interface'),
type: newKeywordTester('type'),
interface: newKeywordTester(
AST_NODE_TYPES.TSInterfaceDeclaration,
'interface',
),
type: newKeywordTester(AST_NODE_TYPES.TSTypeAliasDeclaration, 'type'),
};

//------------------------------------------------------------------------------
Expand Down
7 changes: 7 additions & 0 deletions packages/eslint-plugin/tests/rules/padding-line-between-statements.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -642,6 +642,13 @@ ruleTester.run('padding-line-between-statements', rule, {
{ blankLine: 'always', prev: 'type', next: '*' },
],
},
{
code: 'let var1, var2, type;\nvar1 = "bar";\ntype="baz";\ntype="qux";\nvar2="quux";',
options: [
{ blankLine: 'never', prev: '*', next: 'type' },
{ blankLine: 'always', prev: 'type', next: '*' },
],
},

//----------------------------------------------------------------------
// interface
Expand Down