Skip to content

Corrected Prettier plugin inclusion in config files #444

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 2 commits into from
May 4, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
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
13 changes: 9 additions & 4 deletions src/creation/simplification/retrieveExtendsValues.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,12 @@ const builtInExtensions = new Map([
["eslint:recommended", "eslint/conf/eslint-recommended"],
]);

const typescriptPluginExtensions = new Map([
const pluginExtensions = new Map([
["eslint-plugin-prettier", "node_modules/eslint-config-prettier/index.js"],
[
"eslint-plugin-prettier/@typescript-eslint",
"node_modules/eslint-config-prettier/@typescript-eslint.js",
],
[
"plugin:@typescript-eslint/all",
"node_modules/@typescript-eslint/eslint-plugin/dist/configs/all.json",
Expand Down Expand Up @@ -54,10 +59,10 @@ export const retrieveExtendsValues = async (
return;
}

const typescriptPluginExtension = typescriptPluginExtensions.get(extensionName);
if (typescriptPluginExtension !== undefined) {
const pluginExtension = pluginExtensions.get(extensionName);
if (pluginExtension !== undefined) {
const importedTypeScriptPlugin = (await dependencies.importer(
typescriptPluginExtension,
pluginExtension,
)) as ESLintConfiguration;
importedExtensions.push({
rules: importedTypeScriptPlugin.rules,
Expand Down
5 changes: 1 addition & 4 deletions src/creation/simplification/simplifyPackageRules.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,7 @@ describe("simplifyPackageRules", () => {
expect(simplifiedResults).toEqual({
...ruleConversionResults,
converted: undefined,
extends: [
"plugin:eslint-config-prettier",
"plugin:eslint-config-prettier/@typescript-eslint",
],
extends: ["prettier", "prettier/@typescript-eslint"],
});
});

Expand Down
7 changes: 2 additions & 5 deletions src/creation/simplification/simplifyPackageRules.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,7 @@ export const simplifyPackageRules = async (

// 3a. If no output rules conflict with `eslint-config-prettier`, it's added in
if (await dependencies.addPrettierExtensions(ruleConversionResults, prettierRequested)) {
allExtensions.push(
"plugin:eslint-config-prettier",
"plugin:eslint-config-prettier/@typescript-eslint",
);
allExtensions.push("prettier", "prettier/@typescript-eslint");
}

if (allExtensions.length === 0) {
Expand All @@ -58,7 +55,7 @@ export const simplifyPackageRules = async (
return {
...ruleConversionResults,
converted,
extends: allExtensions,
extends: uniqueFromSources(allExtensions),
failed: [...ruleConversionResults.failed, ...configurationErrors],
};
};
2 changes: 1 addition & 1 deletion src/reporting/packages/logMissingPackages.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ describe("logMissingPackages", () => {
// Arrange
const { choosePackageManager, logger } = createStubDependencies();
const ruleConversionResults = createEmptyConversionResults({
extends: ["plugin:eslint-config-prettier"],
extends: ["prettier"],
});

// Act
Expand Down
3 changes: 1 addition & 2 deletions src/reporting/packages/logMissingPackages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ export const logMissingPackages = async (
const requiredPackageNames = [
"@typescript-eslint/eslint-plugin",
"@typescript-eslint/parser",
ruleConversionResults.extends?.join("").includes("eslint-config-prettier") &&
"eslint-config-prettier",
ruleConversionResults.extends?.join("").includes("prettier") && "eslint-config-prettier",
ruleConversionResults.missing.length !== 0 && "@typescript-eslint/eslint-plugin-tslint",
"eslint",
...Array.from(ruleConversionResults.plugins),
Expand Down
5 changes: 1 addition & 4 deletions src/reporting/reportConversionResults.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@ import { createEmptyConversionResults } from "../conversion/conversionResults.st
import { ESLintRuleOptions } from "../rules/types";
import { reportConversionResults } from "./reportConversionResults";

const basicExtends = [
"plugin:eslint-config-prettier",
"plugin:eslint-config-prettier/@typescript-eslint",
];
const basicExtends = ["prettier", "prettier/@typescript-eslint"];

describe("reportConversionResults", () => {
it("logs a successful conversion without notices when there is one converted rule without notices", async () => {
Expand Down
2 changes: 1 addition & 1 deletion src/reporting/reportConversionResults.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export const reportConversionResults = async (
);
}

if (!ruleConversionResults.extends?.join("").includes("eslint-config-prettier")) {
if (!ruleConversionResults.extends?.join("").includes("prettier")) {
logPrettierExtension(dependencies.logger);
}
};
Expand Down
2 changes: 1 addition & 1 deletion src/reporting/reportOutputs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export const logSuccessfulConversions = (
converted: Map<string, EditorSetting | ESLintRuleOptions>,
logger: Logger,
) => {
logger.stdout.write(chalk.greenBright(`${EOL} ✨ ${converted.size}`));
logger.stdout.write(chalk.greenBright(`${EOL}✨ ${converted.size}`));
logger.stdout.write(
converted.size === 1
? chalk.green(` ${conversionTypeName} replaced with its ESLint equivalent.`)
Expand Down