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: eslint-disable to be able to parse quoted rule names #17612

Merged
merged 6 commits into from
Oct 4, 2023
+290 −2
Merged

fix: eslint-disable to be able to parse quoted rule names #17612

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
63f1545
fix: `eslint-disable` to be able to parse literal rule names
ota-meshi Sep 28, 2023
58851a5
fix: id casing
ota-meshi Sep 28, 2023
24e093b
Apply suggestions from code review
ota-meshi Oct 3, 2023
2a27816
test: update test cases
ota-meshi Oct 3, 2023
ac69d86
test: add eslint-env test case
ota-meshi Oct 3, 2023
80f5147
test: add test case and fix test case
ota-meshi Oct 3, 2023
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: 1 addition & 1 deletion lib/linter/apply-disable-directives.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ function createIndividualDirectivesRemoval(directives, commentToken) {
return directives.map(directive => {
const { ruleId } = directive;

const regex = new RegExp(String.raw`(?:^|\s*,\s*)${escapeRegExp(ruleId)}(?:\s*,\s*|$)`, "u");
const regex = new RegExp(String.raw`(?:^|\s*,\s*)(?<quote>['"]?)${escapeRegExp(ruleId)}\k<quote>(?:\s*,\s*|$)`, "u");
const match = regex.exec(listText);
const matchedText = match[0];
const matchStartOffset = listStartOffset + match.index;
Expand Down
2 changes: 1 addition & 1 deletion lib/linter/config-comment-parser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ module.exports = class ConfigCommentParser {
const items = {};

string.split(",").forEach(name => {
const trimmedName = name.trim();
const trimmedName = name.replace(/^\s*(?<quote>['"]?)(?<ruleId>\S*)\k<quote>\s*$/u, "$<ruleId>");
ota-meshi marked this conversation as resolved.
Show resolved Hide resolved

if (trimmedName) {
items[trimmedName] = true;
Expand Down
12 changes: 12 additions & 0 deletions tests/lib/linter/config-comment-parser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,18 @@ describe("ConfigCommentParser", () => {
b: true
});
});

it("should parse list config with literal items", () => {
const code = "'a', \"b\", 'c\", \"d'";
const result = commentParser.parseListConfig(code);

assert.deepStrictEqual(result, {
a: true,
b: true,
"\"d'": true, // This result is correct because used mismatched quotes.
"'c\"": true // This result is correct because used mismatched quotes.
});
});
});

});
119 changes: 119 additions & 0 deletions tests/lib/linter/linter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13060,6 +13060,60 @@ var a = "test2";
assert.strictEqual(suppressedMessages[1].line, 3);
});

it("should report a violation with literals", () => {
ota-meshi marked this conversation as resolved.
Show resolved Hide resolved
mdjermanovic marked this conversation as resolved.
Show resolved Hide resolved
const code = [
"/*eslint-disable 'no-alert' */",
"alert('test');",
"console.log('test');", // here
"/*eslint-enable */",
"/*eslint-disable \"no-console\" */",
"alert('test');", // here
"console.log('test');"
].join("\n");
const config = { rules: { "no-alert": 1, "no-console": 1 } };

const messages = linter.verify(code, config, filename);
const suppressedMessages = linter.getSuppressedMessages();

assert.strictEqual(messages.length, 2);
assert.strictEqual(messages[0].ruleId, "no-console");
assert.strictEqual(messages[1].ruleId, "no-alert");

assert.strictEqual(suppressedMessages.length, 2);
assert.strictEqual(suppressedMessages[0].ruleId, "no-alert");
assert.strictEqual(suppressedMessages[1].ruleId, "no-console");
});

it("should report a violation with literals", () => {
ota-meshi marked this conversation as resolved.
Show resolved Hide resolved
const code = [
"/*eslint-disable no-alert, no-console */",
"alert('test');",
"console.log('test');",
"/*eslint-enable 'no-alert'*/",
"alert('test');", // here
"console.log('test');",
"/*eslint-enable \"no-console\"*/",
"console.log('test');" // here
].join("\n");
const config = { rules: { "no-alert": 1, "no-console": 1 } };

const messages = linter.verify(code, config, filename);
const suppressedMessages = linter.getSuppressedMessages();

assert.strictEqual(messages.length, 2);
assert.strictEqual(messages[0].ruleId, "no-alert");
assert.strictEqual(messages[0].line, 5);
assert.strictEqual(messages[1].ruleId, "no-console");
assert.strictEqual(messages[1].line, 8);

assert.strictEqual(suppressedMessages.length, 3);
assert.strictEqual(suppressedMessages[0].ruleId, "no-alert");
assert.strictEqual(suppressedMessages[0].line, 2);
assert.strictEqual(suppressedMessages[1].ruleId, "no-console");
assert.strictEqual(suppressedMessages[1].line, 3);
assert.strictEqual(suppressedMessages[2].ruleId, "no-console");
assert.strictEqual(suppressedMessages[2].line, 6);
});
});

describe("/*eslint-disable-line*/", () => {
Expand Down Expand Up @@ -13293,6 +13347,32 @@ var a = "test2";
assert.strictEqual(suppressedMessages.length, 5);
});

it("should report a violation with literals", () => {
ota-meshi marked this conversation as resolved.
Show resolved Hide resolved
const code = [
"alert('test'); // eslint-disable-line 'no-alert'",
"console.log('test');", // here
"alert('test'); // eslint-disable-line \"no-alert\""
].join("\n");
const config = {
rules: {
"no-alert": 1,
"no-console": 1
}
};

const messages = linter.verify(code, config, filename);
const suppressedMessages = linter.getSuppressedMessages();

assert.strictEqual(messages.length, 1);
assert.strictEqual(messages[0].ruleId, "no-console");
assert.strictEqual(messages[0].line, 2);

assert.strictEqual(suppressedMessages.length, 2);
assert.strictEqual(suppressedMessages[0].ruleId, "no-alert");
assert.strictEqual(suppressedMessages[0].line, 1);
assert.strictEqual(suppressedMessages[1].ruleId, "no-alert");
assert.strictEqual(suppressedMessages[1].line, 3);
});
});

describe("/*eslint-disable-next-line*/", () => {
Expand Down Expand Up @@ -13689,6 +13769,31 @@ var a = "test2";

assert.strictEqual(suppressedMessages.length, 0);
});

it("should ignore violation of specified rule on next line with literals", () => {
const code = [
"// eslint-disable-next-line 'no-alert'",
"alert('test');",
"// eslint-disable-next-line \"no-alert\"",
"alert('test');",
"console.log('test');"
].join("\n");
const config = {
rules: {
"no-alert": 1,
"no-console": 1
}
};
const messages = linter.verify(code, config, filename);
const suppressedMessages = linter.getSuppressedMessages();

assert.strictEqual(messages.length, 1);
assert.strictEqual(messages[0].ruleId, "no-console");

assert.strictEqual(suppressedMessages.length, 2);
assert.strictEqual(suppressedMessages[0].ruleId, "no-alert");
assert.strictEqual(suppressedMessages[1].ruleId, "no-alert");
});
});

describe("descriptions in directive comments", () => {
Expand Down Expand Up @@ -15366,6 +15471,20 @@ var a = "test2";
output
);
});

// Test for literals
for (const testcaseForLiteral of [
{ code: code.replace(/(test\/[\w-]+)/gu, '"$1"'), output: output.replace(/(test\/[\w-]+)/gu, '"$1"') },
{ code: code.replace(/(test\/[\w-]+)/gu, "'$1'"), output: output.replace(/(test\/[\w-]+)/gu, "'$1'") }
]) {
// eslint-disable-next-line no-loop-func -- `linter` is getting updated in beforeEach()
it(testcaseForLiteral.code, () => {
assert.strictEqual(
linter.verifyAndFix(testcaseForLiteral.code, config).output,
testcaseForLiteral.output
);
});
}
}
});
});
Expand Down