Skip to content
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
8 changes: 4 additions & 4 deletions src/reporting/reportConversionResults.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -223,8 +223,8 @@ describe("reportConversionResults", () => {
` The "@typescript-eslint/tslint/config" section of .eslintrc.js configures eslint-plugin-tslint to run it in TSLint within ESLint.`,
` Check ${logger.debugFileName} for details.`,
``,
`⚡ 3 packages are required for running with ESLint. ⚡`,
` yarn add @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint --dev`,
`⚡ 4 packages are required for running with ESLint. ⚡`,
` yarn add @typescript-eslint/eslint-plugin @typescript-eslint/parser @typescript-eslint/tslint-eslint-plugin eslint --dev`,
);
expectEqualWrites(
logger.info.write,
Expand Down Expand Up @@ -266,8 +266,8 @@ describe("reportConversionResults", () => {
` The "@typescript-eslint/tslint/config" section of .eslintrc.js configures eslint-plugin-tslint to run them in TSLint within ESLint.`,
` Check ${logger.debugFileName} for details.`,
``,
`⚡ 3 packages are required for running with ESLint. ⚡`,
` yarn add @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint --dev`,
`⚡ 4 packages are required for running with ESLint. ⚡`,
` yarn add @typescript-eslint/eslint-plugin @typescript-eslint/parser @typescript-eslint/tslint-eslint-plugin eslint --dev`,
);
expectEqualWrites(
logger.info.write,
Expand Down
2 changes: 1 addition & 1 deletion src/reporting/reportConversionResults.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export const reportConversionResults = async (
);
}

logMissingPackages(ruleConversionResults.plugins, packageManager, dependencies.logger);
logMissingPackages(ruleConversionResults, packageManager, dependencies.logger);
};

type RuleWithNotices = {
Expand Down
26 changes: 17 additions & 9 deletions src/reporting/reportOutputs.test.ts
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
import { PackageManager } from "./packages/packageManagers";
import { createStubLogger, expectEqualWrites } from "../adapters/logger.stubs";
import { createEmptyConversionResults } from "../conversion/conversionResults.stubs";
import { PackageManager } from "./packages/packageManagers";
import { logMissingPackages } from "./reportOutputs";

const createStubDependencies = (packageManager: PackageManager) => ({
packageManager,
plugins: new Set<string>(),
logger: createStubLogger(),
packageManager,
ruleConversionResults: createEmptyConversionResults(),
});

describe("reportOutputs", () => {
it("reports an npm command when the package manager is npm", () => {
// Arrange
const { logger, packageManager, plugins } = createStubDependencies(PackageManager.npm);
createEmptyConversionResults();
const { logger, packageManager, ruleConversionResults } = createStubDependencies(
PackageManager.npm,
);

// Act
logMissingPackages(plugins, packageManager, logger);
logMissingPackages(ruleConversionResults, packageManager, logger);

// Assert
expectEqualWrites(
Expand All @@ -26,10 +30,12 @@ describe("reportOutputs", () => {

it("reports a pnpm command when the package manager is pnpm", () => {
// Arrange
const { logger, packageManager, plugins } = createStubDependencies(PackageManager.pnpm);
const { logger, packageManager, ruleConversionResults } = createStubDependencies(
PackageManager.pnpm,
);

// Act
logMissingPackages(plugins, packageManager, logger);
logMissingPackages(ruleConversionResults, packageManager, logger);

// Assert
expectEqualWrites(
Expand All @@ -41,10 +47,12 @@ describe("reportOutputs", () => {

it("reports a Yarn command when the package manager is Yarn", () => {
// Arrange
const { logger, packageManager, plugins } = createStubDependencies(PackageManager.Yarn);
const { logger, packageManager, ruleConversionResults } = createStubDependencies(
PackageManager.Yarn,
);

// Act
logMissingPackages(plugins, packageManager, logger);
logMissingPackages(ruleConversionResults, packageManager, logger);

// Assert
expectEqualWrites(
Expand Down
10 changes: 7 additions & 3 deletions src/reporting/reportOutputs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { EditorSetting } from "../editorSettings/types";
import { ErrorSummary } from "../errors/errorSummary";
import { ESLintRuleOptions } from "../rules/types";
import { PackageManager, installationMessages } from "./packages/packageManagers";
import { RuleConversionResults } from "../rules/convertRules";

export type EditorSettingEntry = Pick<EditorSetting, "editorSettingName">;

Expand Down Expand Up @@ -69,16 +70,19 @@ export const logMissingConversionTarget = <T>(
};

export const logMissingPackages = (
plugins: Set<string>,
ruleConversionResults: Pick<RuleConversionResults, "missing" | "plugins">,
packageManager: PackageManager,
logger: Logger,
) => {
const packageNames = [
"@typescript-eslint/eslint-plugin",
"@typescript-eslint/parser",
ruleConversionResults.missing.length !== 0 && "@typescript-eslint/tslint-eslint-plugin",
"eslint",
...Array.from(plugins),
].sort();
...Array.from(ruleConversionResults.plugins),
]
.filter(Boolean)
.sort();

logger.stdout.write(chalk.cyanBright(`${EOL}⚡ ${packageNames.length}`));
logger.stdout.write(chalk.cyan(" packages are required for running with ESLint."));
Expand Down