mirror of
https://github.com/hanzoai/eslint.git
synced 2026-10-30 19:38:10 +00:00
126 lines
6.7 KiB
JavaScript
126 lines
6.7 KiB
JavaScript
"use strict";
|
|
|
|
//------------------------------------------------------------------------------
|
|
// Requirements
|
|
//------------------------------------------------------------------------------
|
|
|
|
const assert = require("node:assert");
|
|
const { execFile } = require("node:child_process");
|
|
const { promisify } = require("node:util");
|
|
const { LATEST_ECMA_VERSION } = require("../../conf/ecma-version");
|
|
|
|
//------------------------------------------------------------------------------
|
|
// Helpers
|
|
//------------------------------------------------------------------------------
|
|
|
|
/**
|
|
* Runs check-rule-examples on the specified files.
|
|
* @param {...string} filenames Files to be passed to check-rule-examples.
|
|
* @returns {Promise<ChildProcess>} An object with properties `stdout` and `stderr` on success.
|
|
* @throws An object with properties `code`, `stdout` and `stderr` on success.
|
|
*/
|
|
async function runCheckRuleExamples(...filenames) {
|
|
return await promisify(execFile)(
|
|
process.execPath,
|
|
["--no-deprecation", "tools/check-rule-examples.js", ...filenames],
|
|
{ env: { FORCE_COLOR: "3" } }, // 24-bit color mode
|
|
);
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
// Tests
|
|
//------------------------------------------------------------------------------
|
|
|
|
describe("check-rule-examples", () => {
|
|
it("succeeds when not passed any files", async () => {
|
|
const childProcess = await runCheckRuleExamples();
|
|
|
|
assert.strictEqual(childProcess.stdout, "");
|
|
assert.strictEqual(childProcess.stderr, "");
|
|
});
|
|
|
|
it("succeeds when passed a syntax error free file", async () => {
|
|
const childProcess = await runCheckRuleExamples(
|
|
"tests/fixtures/good-examples.md",
|
|
);
|
|
|
|
assert.strictEqual(childProcess.stdout, "");
|
|
assert.strictEqual(childProcess.stderr, "");
|
|
});
|
|
|
|
it("fails when passed a file with a syntax error", async () => {
|
|
const promise = runCheckRuleExamples(
|
|
"tests/fixtures/good-examples.md",
|
|
"tests/fixtures/bad-examples.md",
|
|
);
|
|
|
|
await assert.rejects(promise, ({ code, stdout, stderr }) => {
|
|
assert.strictEqual(code, 1);
|
|
assert.strictEqual(stdout, "");
|
|
|
|
/* eslint-disable no-control-regex -- escaping control characters */
|
|
|
|
const normalizedStderr = stderr
|
|
|
|
// Remove OS-dependent path except base name.
|
|
.replace(/(?<=\x1B\[4m).*(?=bad-examples\.md)/u, "")
|
|
|
|
// Remove runtime-specific error message part (different in Node.js 20, 22 and 24).
|
|
.replace(/(?<='doesn't allow this comment'):.*(?=\n)/u, "")
|
|
|
|
// Remove multiple whitespace before rule name in lint errors
|
|
.replaceAll(/\s+(?=\S*no-restricted-syntax\S*\n)/gu, " ");
|
|
|
|
/* eslint-enable no-control-regex -- re-enable rule */
|
|
|
|
const expectedStderr =
|
|
"\x1B[0m\n" +
|
|
"\x1B[4mbad-examples.md\x1B[24m\n" +
|
|
" \x1B[2m11:4\x1B[22m \x1B[31merror\x1B[39m Missing language tag: use one of 'javascript', 'js', 'jsx', 'ts', or 'tsx'\n" +
|
|
" \x1B[2m12:1\x1B[22m \x1B[31merror\x1B[39m Unexpected lint error found: Parsing error: 'import' and 'export' may appear only with 'sourceType: module'\n" +
|
|
" \x1B[2m20:5\x1B[22m \x1B[31merror\x1B[39m Nonstandard language tag 'rs': use one of 'javascript', 'js', 'jsx', 'ts', or 'tsx'\n" +
|
|
" \x1B[2m23:7\x1B[22m \x1B[31merror\x1B[39m Unexpected lint error found: Parsing error: Identifier 'foo' has already been declared\n" +
|
|
' \x1B[2m31:1\x1B[22m \x1B[31merror\x1B[39m Example code should contain a configuration comment like /* eslint no-restricted-syntax: "error" */\n' +
|
|
" \x1B[2m41:1\x1B[22m \x1B[31merror\x1B[39m Unexpected lint error found: Failed to parse JSON from 'doesn't allow this comment'\n" +
|
|
' \x1B[2m51:1\x1B[22m \x1B[31merror\x1B[39m Unexpected lint error found: Rule "no-restricted-syntax" is already configured by another configuration comment in the preceding code. This configuration is ignored\n' +
|
|
" \x1B[2m51:1\x1B[22m \x1B[31merror\x1B[39m Duplicate /* eslint no-restricted-syntax */ configuration comment. Each example should contain only one. Split this example into multiple examples\n" +
|
|
' \x1B[2m56:1\x1B[22m \x1B[31merror\x1B[39m "ecmaVersion": "latest" is the default and can be omitted\n' +
|
|
` \x1B[2m64:1\x1B[22m \x1B[31merror\x1B[39m "ecmaVersion" must be one of ${[3, 5, ...Array.from({ length: LATEST_ECMA_VERSION - 2015 + 1 }, (_, index) => index + 2015)].join(", ")}\n` +
|
|
" \x1B[2m76:1\x1B[22m \x1B[31merror\x1B[39m Unexpected lint error found: /* eslint-env */ comments are no longer supported\n" +
|
|
" \x1B[2m78:1\x1B[22m \x1B[31merror\x1B[39m Unexpected lint error found: /* eslint-env */ comments are no longer supported\n" +
|
|
" \x1B[2m79:1\x1B[22m \x1B[31merror\x1B[39m Unexpected lint error found: /* eslint-env */ comments are no longer supported\n" +
|
|
' \x1B[2m84:1\x1B[22m \x1B[31merror\x1B[39m Configuration error: Key "languageOptions": Unexpected key "foo" found\n' +
|
|
" \x1B[2m97:7\x1B[22m \x1B[31merror\x1B[39m Unexpected lint error found: Using 'ArrayPattern' is not allowed \x1B[2mno-restricted-syntax\x1B[22m\n" +
|
|
" \x1B[2m105:1\x1B[22m \x1B[31merror\x1B[39m Incorrect examples should have at least one error reported by the rule\n" +
|
|
" \x1B[2m115:1\x1B[22m \x1B[31merror\x1B[39m Incorrect examples should have at least one error reported by the rule\n" +
|
|
' \x1B[2m115:1\x1B[22m \x1B[31merror\x1B[39m Unexpected lint error found: Inline configuration for rule "no-restricted-syntax" is invalid:\n' +
|
|
'\tExpected severity of "off", 0, "warn", 1, "error", or 2. You passed "errorr,ArrayPattern". \x1B[2mno-restricted-syntax\x1B[22m\n' +
|
|
' \x1B[2m122:1\x1B[22m \x1B[31merror\x1B[39m "sourceType": "module" is the default and can be omitted\n' +
|
|
' \x1B[2m130:1\x1B[22m \x1B[31merror\x1B[39m "jsx": false is the default and can be omitted\n' +
|
|
' \x1B[2m140:4\x1B[22m \x1B[31merror\x1B[39m The "jsx" language tag requires JSX to be enabled\n' +
|
|
' \x1B[2m148:4\x1B[22m \x1B[31merror\x1B[39m The "tsx" language tag requires JSX to be enabled\n' +
|
|
' \x1B[2m156:4\x1B[22m \x1B[31merror\x1B[39m The "jsx" language tag requires JSX to be enabled\n' +
|
|
' \x1B[2m154:1\x1B[22m \x1B[31merror\x1B[39m "jsx": false is the default and can be omitted\n' +
|
|
' \x1B[2m164:4\x1B[22m \x1B[31merror\x1B[39m JSX is enabled, but the code block is tagged as "js". Use "jsx" or "tsx"\n' +
|
|
"\n" +
|
|
"\x1B[31m\x1B[1m✖ 25 problems (25 errors, 0 warnings)\x1B[22m\x1B[39m\n" +
|
|
"\x1B[0m\n";
|
|
|
|
assert.strictEqual(normalizedStderr, expectedStderr);
|
|
return true;
|
|
});
|
|
});
|
|
|
|
it("fails when a file cannot be processed", async () => {
|
|
const promise = runCheckRuleExamples(
|
|
"tests/fixtures/non-existing-examples.md",
|
|
);
|
|
|
|
await assert.rejects(promise, {
|
|
code: 1,
|
|
stdout: "",
|
|
stderr: "No files found that match the specified patterns.\n",
|
|
});
|
|
});
|
|
});
|