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

feat!: Update shouldUseFlatConfig and CLI so flat config is default #17748

Merged
merged 13 commits into from
Dec 20, 2023
Merged

feat!: Update shouldUseFlatConfig and CLI so flat config is default #17748

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
d0dea8f
feat!: Update shouldUseFlatConfig so flat config is default
nzakas Nov 10, 2023
df69890
Fix tests
nzakas Nov 10, 2023
208d2bc
Update CLI
nzakas Nov 10, 2023
99e5f75
Fix test
nzakas Nov 10, 2023
8ac03fa
Fix tests
nzakas Nov 13, 2023
728b4bc
Fix lint warning
nzakas Nov 13, 2023
7b359b0
Update bin tests to search for eslint.config.js
nzakas Nov 27, 2023
4fc794c
Update tests/lib/cli.js
nzakas Nov 27, 2023
bbf0119
Update tests/lib/cli.js
nzakas Nov 27, 2023
8b30806
Update tests/lib/cli.js
nzakas Nov 27, 2023
265105f
Merge tests for deprecation warnings
nzakas Nov 27, 2023
35ccf30
Update lib/cli.js
nzakas Dec 8, 2023
4816e25
Update tests/lib/cli.js
nzakas Dec 20, 2023
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
8 changes: 6 additions & 2 deletions lib/cli.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,10 +304,10 @@ const cli = {
* Executes the CLI based on an array of arguments that is passed in.
* @param {string|Array|Object} args The arguments to process.
* @param {string} [text] The text to lint (used for TTY).
* @param {boolean} [allowFlatConfig] Whether or not to allow flat config.
* @param {boolean} [allowFlatConfig=true] Whether or not to allow flat config.
* @returns {Promise<number>} The exit code for the operation.
*/
async execute(args, text, allowFlatConfig) {
async execute(args, text, allowFlatConfig = true) {
if (Array.isArray(args)) {
debug("CLI args: %o", args.slice(2));
}
Expand All @@ -323,6 +323,10 @@ const cli = {

debug("Using flat config?", usingFlatConfig);

if (allowFlatConfig && !usingFlatConfig) {
process.emitWarning("You are using an eslintrc configuration file, which is deprecated and support will be removed in v10.0.0. Please migrate to an eslint.config.js file. See https://eslint.org/docs/latest/use/configure/migration-guide for details.", "ESLintRCWarning");
}

const CLIOptions = createCLIOptions(usingFlatConfig);

/** @type {ParsedCLIOptions} */
Expand Down
14 changes: 1 addition & 13 deletions lib/eslint/flat-eslint.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1127,19 +1127,7 @@ class FlatESLint {
* @returns {Promise<boolean>} Whether flat config should be used.
*/
async function shouldUseFlatConfig() {
switch (process.env.ESLINT_USE_FLAT_CONFIG) {
case "true":
return true;
case "false":
return false;
default:

/*
* If neither explicitly enabled nor disabled, then use the presence
* of a flat config file to determine enablement.
*/
return !!(await findFlatConfigFile(process.cwd()));
}
return (process.env.ESLINT_USE_FLAT_CONFIG !== "false");
}

//------------------------------------------------------------------------------
Expand Down
8 changes: 3 additions & 5 deletions tests/bin/eslint.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,10 +160,8 @@ describe("bin/eslint.js", () => {
"gives a detailed error message if no config file is found in /",
() => {
if (
fs.readdirSync("/").some(
fileName =>
/^\.eslintrc(?:\.(?:js|yaml|yml|json))?$/u
.test(fileName)
fs.readdirSync("/").includes(
"eslint.config.js"
)
) {
return Promise.resolve(true);
Expand All @@ -176,7 +174,7 @@ describe("bin/eslint.js", () => {
const stderrPromise = getOutput(child).then(output => {
assert.match(
output.stderr,
/ESLint couldn't find a configuration file/u
/Could not find config file/u
nzakas marked this conversation as resolved.
Show resolved Hide resolved
);
});

Expand Down
43 changes: 26 additions & 17 deletions tests/lib/cli.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,11 +142,15 @@ describe("cli", () => {
const originalEnv = process.env;
const originalCwd = process.cwd;

let processStub;

beforeEach(() => {
processStub = sinon.stub(process, "emitWarning");
process.env = { ...originalEnv };
});

afterEach(() => {
processStub.restore();
process.env = originalEnv;
process.cwd = originalCwd;
});
Expand All @@ -167,6 +171,12 @@ describe("cli", () => {
const exitCode = await cli.execute(`--no-ignore --ext .js ${getFixturePath("files")}`, null, useFlatConfig);

assert.strictEqual(exitCode, 0);


if (useFlatConfig) {
assert.strictEqual(processStub.callCount, 1, "calls `process.emitWarning()` once");
assert.strictEqual(processStub.getCall(0).args[1], "ESLintRCWarning");
}
});

it(`should use it when ESLINT_USE_FLAT_CONFIG=true and useFlatConfig is true even if an eslint.config.js is not present:${configType}`, async () => {
Expand Down Expand Up @@ -237,10 +247,11 @@ describe("cli", () => {

describe("Formatters", () => {

const flag = useFlatConfig ? "--no-config-lookup" : "--no-eslintrc";

describe("when given a valid built-in formatter name", () => {
it(`should execute without any errors with configType:${configType}`, async () => {
const filePath = getFixturePath("passing.js");
const flag = useFlatConfig ? "--no-config-lookup" : "--no-eslintrc";
const exit = await cli.execute(`${flag} -f json ${filePath}`, null, useFlatConfig);

assert.strictEqual(exit, 0);
Expand All @@ -261,7 +272,6 @@ describe("cli", () => {

it(`should execute without any errors with configType:${configType}`, async () => {
const filePath = getFixturePath("passing.js");
const flag = useFlatConfig ? "--no-config-lookup" : "--no-eslintrc";
const exit = await cli.execute(`--no-ignore -f json-with-metadata ${filePath} ${flag}`, null, useFlatConfig);

assert.strictEqual(exit, 0);
Expand Down Expand Up @@ -289,7 +299,6 @@ describe("cli", () => {
});

describe("when the --max-warnings option is passed", () => {
const flag = useFlatConfig ? "--no-config-lookup" : "--no-eslintrc";

describe("and there are too many warnings", () => {
it(`should provide \`maxWarningsExceeded\` metadata to the formatter with configType:${configType}`, async () => {
Expand Down Expand Up @@ -330,7 +339,7 @@ describe("cli", () => {
describe("when given an invalid built-in formatter name", () => {
it(`should execute with error: with configType:${configType}`, async () => {
const filePath = getFixturePath("passing.js");
const exit = await cli.execute(`-f fakeformatter ${filePath}`);
const exit = await cli.execute(`-f fakeformatter ${filePath} ${flag}`, null, useFlatConfig);

assert.strictEqual(exit, 2);
});
Expand All @@ -340,7 +349,7 @@ describe("cli", () => {
it(`should execute without any errors with configType:${configType}`, async () => {
const formatterPath = getFixturePath("formatters", "simple.js");
const filePath = getFixturePath("passing.js");
const exit = await cli.execute(`-f ${formatterPath} ${filePath}`);
const exit = await cli.execute(`-f ${formatterPath} ${filePath} ${flag}`, null, useFlatConfig);

assert.strictEqual(exit, 0);
});
Expand Down Expand Up @@ -371,7 +380,7 @@ describe("cli", () => {
it(`should execute without any errors with configType:${configType}`, async () => {
const formatterPath = getFixturePath("formatters", "async.js");
const filePath = getFixturePath("passing.js");
const exit = await cli.execute(`-f ${formatterPath} ${filePath}`);
const exit = await cli.execute(`-f ${formatterPath} ${filePath} ${flag}`, null, useFlatConfig);

assert.strictEqual(log.info.getCall(0).args[0], "from async formatter");
assert.strictEqual(exit, 0);
Expand Down Expand Up @@ -1480,7 +1489,7 @@ describe("cli", () => {

describe("when given a config file", () => {
it("should load the specified config file", async () => {
const configPath = getFixturePath(".eslintrc");
const configPath = getFixturePath("eslint.config.js");
const filePath = getFixturePath("passing.js");

await cli.execute(`--config ${configPath} ${filePath}`);
Expand All @@ -1498,7 +1507,7 @@ describe("cli", () => {
const filePath = getFixturePath("globals-browser.js");
const code = `--config ${configPath} ${filePath}`;

const exit = await cli.execute(code);
const exit = await cli.execute(code, null, false);

assert.strictEqual(exit, 0);
});
Expand All @@ -1510,7 +1519,7 @@ describe("cli", () => {
const filePath = getFixturePath("globals-node.js");
const code = `--config ${configPath} ${filePath}`;

const exit = await cli.execute(code);
const exit = await cli.execute(code, null, false);

assert.strictEqual(exit, 0);
});
Expand All @@ -1522,7 +1531,7 @@ describe("cli", () => {
const filePath = getFixturePath("globals-nashorn.js");
const code = `--config ${configPath} ${filePath}`;

const exit = await cli.execute(code);
const exit = await cli.execute(code, null, false);

assert.strictEqual(exit, 0);
});
Expand All @@ -1534,7 +1543,7 @@ describe("cli", () => {
const filePath = getFixturePath("globals-webextensions.js");
const code = `--config ${configPath} ${filePath}`;

const exit = await cli.execute(code);
const exit = await cli.execute(code, null, false);

assert.strictEqual(exit, 0);
});
Expand All @@ -1549,7 +1558,7 @@ describe("cli", () => {
const code = `--rulesdir ${rulesPath} --config ${configPath} --no-ignore ${filePath}`;

await stdAssert.rejects(async () => {
const exit = await cli.execute(code);
const exit = await cli.execute(code, null, false);

assert.strictEqual(exit, 2);
}, /Error while loading rule 'custom-rule': Boom!/u);
Expand All @@ -1561,7 +1570,7 @@ describe("cli", () => {
const filePath = getFixturePath("rules", "test", "test-custom-rule.js");
const code = `--rulesdir ${rulesPath} --config ${configPath} --no-ignore ${filePath}`;

await cli.execute(code);
await cli.execute(code, null, false);

assert.isTrue(log.info.calledOnce);
assert.isTrue(log.info.neverCalledWith(""));
Expand All @@ -1573,7 +1582,7 @@ describe("cli", () => {
const configPath = getFixturePath("rules", "multi-rulesdirs.json");
const filePath = getFixturePath("rules", "test-multi-rulesdirs.js");
const code = `--rulesdir ${rulesPath} --rulesdir ${rulesPath2} --config ${configPath} --no-ignore ${filePath}`;
const exit = await cli.execute(code);
const exit = await cli.execute(code, null, false);

const call = log.info.getCall(0);

Expand All @@ -1591,7 +1600,7 @@ describe("cli", () => {
describe("when executing with no-eslintrc flag", () => {
it("should ignore a local config file", async () => {
const filePath = getFixturePath("eslintrc", "quotes.js");
const exit = await cli.execute(`--no-eslintrc --no-ignore ${filePath}`);
const exit = await cli.execute(`--no-eslintrc --no-ignore ${filePath}`, null, false);

assert.isTrue(log.info.notCalled);
assert.strictEqual(exit, 0);
Expand All @@ -1601,7 +1610,7 @@ describe("cli", () => {
describe("when executing without no-eslintrc flag", () => {
it("should load a local config file", async () => {
const filePath = getFixturePath("eslintrc", "quotes.js");
const exit = await cli.execute(`--no-ignore ${filePath}`);
const exit = await cli.execute(`--no-ignore ${filePath}`, null, false);

assert.isTrue(log.info.calledOnce);
assert.strictEqual(exit, 1);
Expand All @@ -1615,7 +1624,7 @@ describe("cli", () => {
getFixturePath("globals-node.js")
];

await cli.execute(`--no-eslintrc --config ./packages/js/src/configs/eslint-recommended.js --no-ignore ${files.join(" ")}`);
await cli.execute(`--no-eslintrc --config ./packages/js/src/configs/eslint-recommended.js --no-ignore ${files.join(" ")}`, null, false);

assert.strictEqual(log.info.args[0][0].split("\n").length, 10);
});
Expand Down
2 changes: 1 addition & 1 deletion tests/lib/eslint/flat-eslint.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6446,6 +6446,6 @@ describe("shouldUseFlatConfig", () => {
});

describe("when the env variable `ESLINT_USE_FLAT_CONFIG` is unset", () => {
testShouldUseFlatConfig(true, false);
testShouldUseFlatConfig(true, true);
});
});