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.

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

fix: Correct ignore message for "node_modules" subfolders #17217

Merged
merged 2 commits into from May 24, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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/eslint/eslint-helpers.js
Expand Up @@ -591,7 +591,7 @@ function isErrorMessage(message) {
*/
function createIgnoreResult(filePath, baseDir) {
let message;
const isInNodeModules = baseDir && path.relative(baseDir, filePath).startsWith("node_modules");
const isInNodeModules = baseDir && /(?:^|[\\/])node_modules[\\/]/u.test(path.relative(baseDir, filePath));
fasttime marked this conversation as resolved.
Show resolved Hide resolved

if (isInNodeModules) {
message = "File ignored by default because it is located under the node_modules directory. Use ignore pattern \"!**/node_modules/\" to override.";
Expand Down
1 change: 1 addition & 0 deletions tests/fixtures/cli-engine/node_modules_cleaner.js
@@ -0,0 +1 @@
// not implemented
40 changes: 39 additions & 1 deletion tests/lib/eslint/flat-eslint.js
Expand Up @@ -1191,7 +1191,7 @@ describe("FlatESLint", () => {

describe("Ignoring Files", () => {

it("should report on all files passed explicitly, even if ignored by default", async () => {
it("should report on a file in the node_modules folder passed explicitly, even if ignored by default", async () => {
eslint = new FlatESLint({
cwd: getFixturePath("cli-engine")
});
Expand All @@ -1204,6 +1204,44 @@ describe("FlatESLint", () => {
assert.strictEqual(results[0].fatalErrorCount, 0);
assert.strictEqual(results[0].fixableErrorCount, 0);
assert.strictEqual(results[0].fixableWarningCount, 0);
assert.strictEqual(results[0].messages[0].severity, 1);
assert.strictEqual(results[0].messages[0].message, expectedMsg);
assert.strictEqual(results[0].suppressedMessages.length, 0);
});

it("should report on a file in a node_modules subfolder passed explicitly, even if ignored by default", async () => {
eslint = new FlatESLint({
cwd: getFixturePath("cli-engine")
});
const results = await eslint.lintFiles(["nested_node_modules/subdir/node_modules/text.js"]);
const expectedMsg = "File ignored by default because it is located under the node_modules directory. Use ignore pattern \"!**/node_modules/\" to override.";

assert.strictEqual(results.length, 1);
assert.strictEqual(results[0].errorCount, 0);
assert.strictEqual(results[0].warningCount, 1);
assert.strictEqual(results[0].fatalErrorCount, 0);
assert.strictEqual(results[0].fixableErrorCount, 0);
assert.strictEqual(results[0].fixableWarningCount, 0);
assert.strictEqual(results[0].messages[0].severity, 1);
assert.strictEqual(results[0].messages[0].message, expectedMsg);
assert.strictEqual(results[0].suppressedMessages.length, 0);
});

it("should report on an ignored file with \"node_modules\" in its name", async () => {
eslint = new FlatESLint({
cwd: getFixturePath("cli-engine"),
ignorePatterns: ["*.js"]
});
const results = await eslint.lintFiles(["node_modules_cleaner.js"]);
const expectedMsg = "File ignored because of a matching ignore pattern. Use \"--no-ignore\" to override.";

assert.strictEqual(results.length, 1);
assert.strictEqual(results[0].errorCount, 0);
assert.strictEqual(results[0].warningCount, 1);
assert.strictEqual(results[0].fatalErrorCount, 0);
assert.strictEqual(results[0].fixableErrorCount, 0);
assert.strictEqual(results[0].fixableWarningCount, 0);
assert.strictEqual(results[0].messages[0].severity, 1);
assert.strictEqual(results[0].messages[0].message, expectedMsg);
assert.strictEqual(results[0].suppressedMessages.length, 0);
});
Expand Down