Skip to content

Properly use ruleSeverity properties of rule converters during conversion #1468

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 4 commits into from
May 3, 2022
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
82 changes: 81 additions & 1 deletion src/converters/lintConfigs/rules/convertRules.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { describe, expect, it, test } from "@jest/globals";

import { ConversionError } from "../../../errors/conversionError";
import { convertRules } from "./convertRules";
import { ConversionResult, RuleConverter } from "./ruleConverter";
import { ConversionResult, ConvertedRuleChanges, RuleConverter } from "./ruleConverter";
import { RuleMerger } from "./ruleMerger";
import { TSLintRuleOptions, TSLintRuleSeverity } from "./types";

Expand Down Expand Up @@ -353,6 +353,86 @@ describe("convertRules", () => {
]).toContainEqual(converted);
});

it("merges when a rule severity differs from its TSLint equivalent", () => {
// Arrange
const rules: ConvertedRuleChanges[] = [
{
ruleName: "eslint-rule-a",
ruleSeverity: "off",
},
];
const { tslintRule, converters, mergers } = setupConversionEnvironment({
ruleSeverity: "error",
conversionResult: { rules },
ruleToMerge: rules[0].ruleName,
});

// Act
const { converted } = convertRules(
{ ruleConverters: converters, ruleMergers: mergers },
{ [tslintRule.ruleName]: tslintRule },
new Map(),
);

// Assert
expect([
new Map([
[
"eslint-rule-a",
{
ruleName: "eslint-rule-a",
ruleSeverity: "off",
},
],
]),
]).toContainEqual(converted);
});

it("merges when rule severities inconsistently differ from their TSLint equivalent", () => {
// Arrange
const rules: ConvertedRuleChanges[] = [
{
ruleName: "eslint-rule-a",
ruleSeverity: "off",
},
{
ruleName: "eslint-rule-b",
},
];
const { tslintRule, converters, mergers } = setupConversionEnvironment({
ruleSeverity: "error",
conversionResult: { rules },
ruleToMerge: rules[0].ruleName,
});

// Act
const { converted } = convertRules(
{ ruleConverters: converters, ruleMergers: mergers },
{ [tslintRule.ruleName]: tslintRule },
new Map(),
);

// Assert
expect([
new Map([
[
"eslint-rule-a",
{
ruleName: "eslint-rule-a",
ruleSeverity: "off",
},
],
[
"eslint-rule-b",
{
ruleName: "eslint-rule-b",
ruleSeverity: "error",
},
],
]),
]).toContainEqual(converted);
});

it("marks a new plugin when a conversion has a new plugin", () => {
// Arrange
const conversionResult = {
Expand Down
3 changes: 2 additions & 1 deletion src/converters/lintConfigs/rules/convertRules.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ export const convertRules = (
const existingConversion = converted.get(changes.ruleName);
const newConversion = {
...changes,
ruleSeverity: convertTSLintRuleSeverity(tslintRule.ruleSeverity),
ruleSeverity:
changes.ruleSeverity ?? convertTSLintRuleSeverity(tslintRule.ruleSeverity),
};

// 4c. If this is the first time the output ESLint rule is seen, it's directly marked as converted.
Expand Down