Skip to content

Intentionally fail fast on module lookup failures #419

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

Merged
merged 3 commits into from
Apr 26, 2020
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Intentionally fail fast on module lookup failures
  • Loading branch information
JoshuaKGoldberg committed Apr 26, 2020
commit 68c8de0aebe9a90166a8665fc75e274c5f7fc032
27 changes: 27 additions & 0 deletions src/input/findOriginalConfigurations.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,33 @@ describe("findOriginalConfigurations", () => {
});
});

it.each(["Cannot find module", "could not require", "couldn't find the plugin"])(
"returns an error when an optional configuration returns a '%s' error",
async (message) => {
// Arrange
const eslint = new Error(`${message} "example"`);
const dependencies = createStubDependencies({
findESLintConfiguration: async () => eslint,
});

// Act
const result = await findOriginalConfigurations(
dependencies,
createRawSettings({
eslint: "./eslintrc.js",
}),
);

// Assert
expect(result).toEqual({
complaints: [
`Could not import the "example" module. Do you need to install packages?`,
],
status: ResultStatus.ConfigurationError,
});
},
);

it("returns an error when an optional configuration returns an error and the user asked for it", async () => {
// Arrange
const eslint = new Error("one");
Expand Down
52 changes: 41 additions & 11 deletions src/input/findOriginalConfigurations.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
} from "./findTypeScriptConfiguration";
import { findTSLintConfiguration, TSLintConfiguration } from "./findTSLintConfiguration";
import { mergeLintConfigurations } from "./mergeLintConfigurations";
import { isDefined } from "../utils";

export type FindOriginalConfigurationsDependencies = {
findESLintConfiguration: SansDependencies<typeof findESLintConfiguration>;
Expand Down Expand Up @@ -54,20 +55,42 @@ export const findOriginalConfigurations = async (
// Out of those configurations, only TSLint's is always required to run
if (tslint instanceof Error) {
return {
complaints: [tslint.message],
complaints: [getMissingPackageMessage(tslint) ?? tslint.message],
status: ResultStatus.ConfigurationError,
};
}

// Other configuration errors only halt the program if the user asked for them
const configurationErrors = [
[eslint, rawSettings.eslint],
[packages, rawSettings.package],
[typescript, rawSettings.typescript],
].filter(configurationResultIsError);
if (configurationErrors.length !== 0) {
const configurationResults = [
[eslint, "eslint"],
[packages, "package"],
[typescript, "typescript"],
] as const;

// Other configuration errors only halt the program if...
const errorMessages = configurationResults
.map(([error, key]) => {
if (!(error instanceof Error)) {
return undefined;
}

// * Their failure was caused by a missing package that needs to be installed
const missingPackageMessage = getMissingPackageMessage(error);
if (missingPackageMessage !== undefined) {
return missingPackageMessage;
}

// * The user explicitly asked for them
if (typeof rawSettings[key] === "string") {
return error.message;
}

return undefined;
})
.filter(isDefined);

if (errorMessages.length !== 0) {
return {
complaints: configurationErrors.map(([configuration]) => configuration.message),
complaints: errorMessages,
status: ResultStatus.ConfigurationError,
};
}
Expand All @@ -83,6 +106,13 @@ export const findOriginalConfigurations = async (
};
};

const configurationResultIsError = (result: unknown[]): result is [Error, string] => {
return result[0] instanceof Error && typeof result[1] === "string";
const getMissingPackageMessage = (error: Error) => {
const match = /(Cannot find module|could not require|couldn't find the plugin) ([a-zA-Z0-9-_"'@/]+)/.exec(
error.message,
);
if (match === null) {
return undefined;
}

return `Could not import the ${match[2]} module. Do you need to install packages?`;
};