Skip to content

Commit 5c5b802

Browse files
mdjermanovicmdjermanovic
authored
feat: Add --ext CLI option (#19405)
* feat: Add `--ext` CLI option Fixes #19361 * fix typos in test descriptions * check for empty input
1 parent dd7d930 commit 5c5b802

File tree

13 files changed

+197
-39
lines changed

13 files changed

+197
-39
lines changed

‎docs/src/use/command-line-interface.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ Basic configuration:
9393
-c, --config path::String Use this configuration instead of eslint.config.js, eslint.config.mjs, or
9494
eslint.config.cjs
9595
--inspect-config Open the config inspector with the current configuration
96+
--ext [String] Specify additional file extensions to lint
9697
--global [String] Define global variables
9798
--parser String Specify the parser to be used
9899
--parser-options Object Specify parser options
@@ -219,34 +220,32 @@ Details about the global variables defined by each environment are available in
219220

220221
#### `--ext`
221222

222-
**eslintrc Mode Only.** If you are using flat config (`eslint.config.js`), please see [migration guide](./configure/migration-guide#--ext).
223-
224-
This option allows you to specify which file extensions ESLint uses when searching for target files in the directories you specify.
223+
This option allows you to specify additional file extensions to lint.
225224

226225
* **Argument Type**: String. File extension.
227226
* **Multiple Arguments**: Yes
228-
* **Default Value**: `.js` and the files that match the `overrides` entries of your configuration.
227+
* **Default Value**: By default, ESLint lints files with extensions `.js`, `.mjs`, `.cjs`, and additional extensions [specified in the configuration file](configure/configuration-files#specifying-files-with-arbitrary-extensions).
229228

230-
`--ext` is only used when the patterns to lint are directories. If you use glob patterns or file names, then `--ext` is ignored. For example, `npx eslint "lib/*" --ext .js` matches all files within the `lib/` directory, regardless of extension.
229+
This option is primarely intended for use in combination with the `--no-config-lookup` option, since in that case there is no configuration file in which the additional extensions would be specified.
231230

232231
##### `--ext` example
233232

234233
{{ npx_tabs ({
235234
package: "eslint",
236235
args: [".", "--ext", ".ts"],
237-
comment: "Use only .ts extension"
236+
comment: "Include .ts files"
238237
}) }}
239238

240239
{{ npx_tabs ({
241240
package: "eslint",
242-
args: [".", "--ext", ".js", "--ext", ".ts"],
243-
comment: "Use both .js and .ts"
241+
args: [".", "--ext", ".ts", "--ext", ".tsx"],
242+
comment: "Include .ts and .tsx files"
244243
}) }}
245244

246245
{{ npx_tabs ({
247246
package: "eslint",
248-
args: [".", "--ext", ".js,.ts"],
249-
comment: "Also use both .js and .ts"
247+
args: [".", "--ext", ".ts,.tsx"],
248+
comment: "Also include .ts and .tsx files"
250249
}) }}
251250

252251
#### `--global`

‎lib/cli.js

+23
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,12 @@ async function translateOptions({
192192
overrideConfig[0].plugins = await loadPlugins(importer, plugin);
193193
}
194194

195+
if (ext) {
196+
overrideConfig.push({
197+
files: ext.map(extension => `**/*${extension.startsWith(".") ? "" : "."}${extension}`)
198+
});
199+
}
200+
195201
} else {
196202
overrideConfigFile = config;
197203

@@ -489,6 +495,23 @@ const cli = {
489495
return 2;
490496
}
491497

498+
if (usingFlatConfig && options.ext) {
499+
500+
// Passing `--ext ""` results in `options.ext` being an empty array.
501+
if (options.ext.length === 0) {
502+
log.error("The --ext option value cannot be empty.");
503+
return 2;
504+
}
505+
506+
// Passing `--ext ,ts` results in an empty string at index 0. Passing `--ext ts,,tsx` results in an empty string at index 1.
507+
const emptyStringIndex = options.ext.indexOf("");
508+
509+
if (emptyStringIndex >= 0) {
510+
log.error(`The --ext option arguments cannot be empty strings. Found an empty string at index ${emptyStringIndex}.`);
511+
return 2;
512+
}
513+
}
514+
492515
const ActiveESLint = usingFlatConfig ? ESLint : LegacyESLint;
493516
const eslintOptions = await translateOptions(options, usingFlatConfig ? "flat" : "eslintrc");
494517
const engine = new ActiveESLint(eslintOptions);

‎lib/options.js

+6
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,12 @@ module.exports = function(usingFlatConfig) {
123123
type: "[String]",
124124
description: "Specify JavaScript file extensions"
125125
};
126+
} else {
127+
extFlag = {
128+
option: "ext",
129+
type: "[String]",
130+
description: "Specify additional file extensions to lint"
131+
};
126132
}
127133

128134
let resolvePluginsFlag;

‎tests/fixtures/file-extensions/a.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// empty

‎tests/fixtures/file-extensions/b.mjs

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// empty

‎tests/fixtures/file-extensions/c.cjs

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// empty

‎tests/fixtures/file-extensions/d.jsx

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// empty

‎tests/fixtures/file-extensions/eslint.config.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = [{ files: ["**/*.jsx"] }];

‎tests/fixtures/file-extensions/f.ts

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// empty

‎tests/fixtures/file-extensions/foots

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// this file should not be linted with --ext ts

‎tests/fixtures/file-extensions/g.tsx

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// empty

‎tests/lib/cli.js

+128-5
Original file line numberDiff line numberDiff line change
@@ -218,17 +218,17 @@ describe("cli", () => {
218218
it(`should use it when an eslint.config.js is present and useFlatConfig is true:${configType}`, async () => {
219219
process.cwd = getFixturePath;
220220

221-
const exitCode = await cli.execute(`--no-ignore --ext .js ${getFixturePath("files")}`, null, useFlatConfig);
221+
const exitCode = await cli.execute(`--no-ignore --env es2024 ${getFixturePath("files")}`, null, useFlatConfig);
222222

223-
// When flat config is used, we get an exit code of 2 because the --ext option is unrecognized.
223+
// When flat config is used, we get an exit code of 2 because the --env option is unrecognized.
224224
assert.strictEqual(exitCode, useFlatConfig ? 2 : 0);
225225
});
226226

227227
it(`should not use it when ESLINT_USE_FLAT_CONFIG=false even if an eslint.config.js is present:${configType}`, async () => {
228228
process.env.ESLINT_USE_FLAT_CONFIG = "false";
229229
process.cwd = getFixturePath;
230230

231-
const exitCode = await cli.execute(`--no-ignore --ext .js ${getFixturePath("files")}`, null, useFlatConfig);
231+
const exitCode = await cli.execute(`--no-ignore --env es2024 ${getFixturePath("files")}`, null, useFlatConfig);
232232

233233
assert.strictEqual(exitCode, 0);
234234

@@ -245,9 +245,9 @@ describe("cli", () => {
245245
// Set the CWD to outside the fixtures/ directory so that no eslint.config.js is found
246246
process.cwd = () => getFixturePath("..");
247247

248-
const exitCode = await cli.execute(`--no-ignore --ext .js ${getFixturePath("files")}`, null, useFlatConfig);
248+
const exitCode = await cli.execute(`--no-ignore --env es2024 ${getFixturePath("files")}`, null, useFlatConfig);
249249

250-
// When flat config is used, we get an exit code of 2 because the --ext option is unrecognized.
250+
// When flat config is used, we get an exit code of 2 because the --env option is unrecognized.
251251
assert.strictEqual(exitCode, useFlatConfig ? 2 : 0);
252252
});
253253
});
@@ -2027,6 +2027,129 @@ describe("cli", () => {
20272027
});
20282028
});
20292029

2030+
describe("--ext option", () => {
2031+
2032+
let originalCwd;
2033+
2034+
beforeEach(() => {
2035+
originalCwd = process.cwd();
2036+
process.chdir(getFixturePath("file-extensions"));
2037+
});
2038+
2039+
afterEach(() => {
2040+
process.chdir(originalCwd);
2041+
originalCwd = void 0;
2042+
});
2043+
2044+
it("when not provided, without config file only default extensions should be linted", async () => {
2045+
const exitCode = await cli.execute("--no-config-lookup -f json .", null, true);
2046+
2047+
assert.strictEqual(exitCode, 0, "exit code should be 0");
2048+
2049+
const results = JSON.parse(log.info.args[0][0]);
2050+
2051+
assert.deepStrictEqual(
2052+
results.map(({ filePath }) => filePath).sort(),
2053+
["a.js", "b.mjs", "c.cjs", "eslint.config.js"].map(filename => path.resolve(filename))
2054+
);
2055+
});
2056+
2057+
it("when not provided, only default extensions and extensions from the config file should be linted", async () => {
2058+
const exitCode = await cli.execute("-f json .", null, true);
2059+
2060+
assert.strictEqual(exitCode, 0, "exit code should be 0");
2061+
2062+
const results = JSON.parse(log.info.args[0][0]);
2063+
2064+
assert.deepStrictEqual(
2065+
results.map(({ filePath }) => filePath).sort(),
2066+
["a.js", "b.mjs", "c.cjs", "d.jsx", "eslint.config.js"].map(filename => path.resolve(filename))
2067+
);
2068+
});
2069+
2070+
it("should include an additional extension when specified with dot", async () => {
2071+
const exitCode = await cli.execute("-f json --ext .ts .", null, true);
2072+
2073+
assert.strictEqual(exitCode, 0, "exit code should be 0");
2074+
2075+
const results = JSON.parse(log.info.args[0][0]);
2076+
2077+
assert.deepStrictEqual(
2078+
results.map(({ filePath }) => filePath).sort(),
2079+
["a.js", "b.mjs", "c.cjs", "d.jsx", "eslint.config.js", "f.ts"].map(filename => path.resolve(filename))
2080+
);
2081+
});
2082+
2083+
it("should include an additional extension when specified without dot", async () => {
2084+
const exitCode = await cli.execute("-f json --ext ts .", null, true);
2085+
2086+
assert.strictEqual(exitCode, 0, "exit code should be 0");
2087+
2088+
const results = JSON.parse(log.info.args[0][0]);
2089+
2090+
// should not include "foots"
2091+
assert.deepStrictEqual(
2092+
results.map(({ filePath }) => filePath).sort(),
2093+
["a.js", "b.mjs", "c.cjs", "d.jsx", "eslint.config.js", "f.ts"].map(filename => path.resolve(filename))
2094+
);
2095+
});
2096+
2097+
it("should include multiple additional extensions when specified by repeating the option", async () => {
2098+
const exitCode = await cli.execute("-f json --ext .ts --ext tsx .", null, true);
2099+
2100+
assert.strictEqual(exitCode, 0, "exit code should be 0");
2101+
2102+
const results = JSON.parse(log.info.args[0][0]);
2103+
2104+
assert.deepStrictEqual(
2105+
results.map(({ filePath }) => filePath).sort(),
2106+
["a.js", "b.mjs", "c.cjs", "d.jsx", "eslint.config.js", "f.ts", "g.tsx"].map(filename => path.resolve(filename))
2107+
);
2108+
});
2109+
2110+
it("should include multiple additional extensions when specified with comma-delimited list", async () => {
2111+
const exitCode = await cli.execute("-f json --ext .ts,.tsx .", null, true);
2112+
2113+
assert.strictEqual(exitCode, 0, "exit code should be 0");
2114+
2115+
const results = JSON.parse(log.info.args[0][0]);
2116+
2117+
assert.deepStrictEqual(
2118+
results.map(({ filePath }) => filePath).sort(),
2119+
["a.js", "b.mjs", "c.cjs", "d.jsx", "eslint.config.js", "f.ts", "g.tsx"].map(filename => path.resolve(filename))
2120+
);
2121+
});
2122+
2123+
it('should fail when passing --ext ""', async () => {
2124+
2125+
// When passing "" on command line, its corresponding item in process.argv[] is an empty string
2126+
const exitCode = await cli.execute(["argv0", "argv1", "--ext", ""], null, true);
2127+
2128+
assert.strictEqual(exitCode, 2, "exit code should be 2");
2129+
assert.strictEqual(log.info.callCount, 0, "log.info should not be called");
2130+
assert.strictEqual(log.error.callCount, 1, "log.error should be called once");
2131+
assert.deepStrictEqual(log.error.firstCall.args[0], "The --ext option value cannot be empty.");
2132+
});
2133+
2134+
it("should fail when passing --ext ,ts", async () => {
2135+
const exitCode = await cli.execute("--ext ,ts", null, true);
2136+
2137+
assert.strictEqual(exitCode, 2, "exit code should be 2");
2138+
assert.strictEqual(log.info.callCount, 0, "log.info should not be called");
2139+
assert.strictEqual(log.error.callCount, 1, "log.error should be called once");
2140+
assert.deepStrictEqual(log.error.firstCall.args[0], "The --ext option arguments cannot be empty strings. Found an empty string at index 0.");
2141+
});
2142+
2143+
it("should fail when passing --ext ts,,tsx", async () => {
2144+
const exitCode = await cli.execute("--ext ts,,tsx", null, true);
2145+
2146+
assert.strictEqual(exitCode, 2, "exit code should be 2");
2147+
assert.strictEqual(log.info.callCount, 0, "log.info should not be called");
2148+
assert.strictEqual(log.error.callCount, 1, "log.error should be called once");
2149+
assert.deepStrictEqual(log.error.firstCall.args[0], "The --ext option arguments cannot be empty strings. Found an empty string at index 1.");
2150+
});
2151+
});
2152+
20302153
describe("unstable_config_lookup_from_file", () => {
20312154

20322155
const flag = "unstable_config_lookup_from_file";

‎tests/lib/options.js

+23-24
Original file line numberDiff line numberDiff line change
@@ -318,40 +318,39 @@ describe("options", () => {
318318
assert.strictEqual(currentOptions.printConfig, "file.js");
319319
});
320320
});
321-
});
322321

323-
});
322+
describe("--ext", () => {
323+
it("should return an array with one item when passed .jsx", () => {
324+
const currentOptions = options.parse("--ext .jsx");
324325

326+
assert.isArray(currentOptions.ext);
327+
assert.strictEqual(currentOptions.ext[0], ".jsx");
328+
});
325329

326-
describe("--ext", () => {
327-
it("should return an array with one item when passed .jsx", () => {
328-
const currentOptions = eslintrcOptions.parse("--ext .jsx");
330+
it("should return an array with two items when passed .js and .jsx", () => {
331+
const currentOptions = options.parse("--ext .jsx --ext .js");
329332

330-
assert.isArray(currentOptions.ext);
331-
assert.strictEqual(currentOptions.ext[0], ".jsx");
332-
});
333+
assert.isArray(currentOptions.ext);
334+
assert.strictEqual(currentOptions.ext[0], ".jsx");
335+
assert.strictEqual(currentOptions.ext[1], ".js");
336+
});
333337

334-
it("should return an array with two items when passed .js and .jsx", () => {
335-
const currentOptions = eslintrcOptions.parse("--ext .jsx --ext .js");
338+
it("should return an array with two items when passed .jsx,.js", () => {
339+
const currentOptions = options.parse("--ext .jsx,.js");
336340

337-
assert.isArray(currentOptions.ext);
338-
assert.strictEqual(currentOptions.ext[0], ".jsx");
339-
assert.strictEqual(currentOptions.ext[1], ".js");
340-
});
341+
assert.isArray(currentOptions.ext);
342+
assert.strictEqual(currentOptions.ext[0], ".jsx");
343+
assert.strictEqual(currentOptions.ext[1], ".js");
344+
});
341345

342-
it("should return an array with two items when passed .jsx,.js", () => {
343-
const currentOptions = eslintrcOptions.parse("--ext .jsx,.js");
346+
it("should not exist when not passed", () => {
347+
const currentOptions = options.parse("");
344348

345-
assert.isArray(currentOptions.ext);
346-
assert.strictEqual(currentOptions.ext[0], ".jsx");
347-
assert.strictEqual(currentOptions.ext[1], ".js");
349+
assert.notProperty(currentOptions, "ext");
350+
});
351+
});
348352
});
349353

350-
it("should not exist when not passed", () => {
351-
const currentOptions = eslintrcOptions.parse("");
352-
353-
assert.notProperty(currentOptions, "ext");
354-
});
355354
});
356355

357356
describe("--rulesdir", () => {

0 commit comments

Comments
 (0)