Skip to content

Merge and deduplicate rule notices #141

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

Merged
merged 3 commits into from
Aug 13, 2019
Merged

Merge and deduplicate rule notices #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
06b6358
merge and deduplicate rule notices
Aug 12, 2019
abb5e87
small refactor
Aug 12, 2019
27d2257
make sure notices arent going to be undefined when theyre passed into…
Aug 13, 2019
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
90 changes: 90 additions & 0 deletions src/rules/convertRules.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,96 @@ describe("convertRules", () => {
);
});

it("merges and deduplicates rule notices", () => {
// Arrange
const tslintRule: TSLintRuleOptions = {
ruleArguments: [],
ruleName: "tslint-rule-a",
ruleSeverity: "error",
};
const conversionResult = {
rules: [
{
ruleName: "eslint-rule-a",
notices: ["notice-1", "notice-2"],
},
{
ruleName: "eslint-rule-a",
notices: ["notice-1"],
},
],
};
const mergedArguments = [{ merged: true }];
const converters = new Map([[tslintRule.ruleName, () => conversionResult]]);
const mergers = new Map([[conversionResult.rules[0].ruleName, () => mergedArguments]]);

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

// Assert
expect(converted).toEqual(
new Map([
[
"eslint-rule-a",
{
ruleArguments: mergedArguments,
ruleName: "eslint-rule-a",
ruleSeverity: "error",
notices: ["notice-1", "notice-2"],
},
],
]),
);
});

it("merges undefined notices", () => {
// Arrange
const tslintRule: TSLintRuleOptions = {
ruleArguments: [],
ruleName: "tslint-rule-a",
ruleSeverity: "error",
};
const conversionResult = {
rules: [
{
ruleName: "eslint-rule-a",
notices: undefined,
},
{
ruleName: "eslint-rule-a",
notices: undefined,
},
],
};
const mergedArguments = [{ merged: true }];
const converters = new Map([[tslintRule.ruleName, () => conversionResult]]);
const mergers = new Map([[conversionResult.rules[0].ruleName, () => mergedArguments]]);

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

// Assert
expect(converted).toEqual(
new Map([
[
"eslint-rule-a",
{
ruleArguments: mergedArguments,
ruleName: "eslint-rule-a",
ruleSeverity: "error",
notices: [],
},
],
]),
);
});

it("marks a new plugin when a conversion has a new plugin", () => {
// Arrange
const tslintRule: TSLintRuleOptions = {
Expand Down
2 changes: 1 addition & 1 deletion src/rules/convertRules.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ export const convertRules = (
existingConversion.ruleArguments,
newConversion.ruleArguments,
),
notices: [...existingNotices, ...newNotices],
notices: Array.from(new Set([...existingNotices, ...newNotices])),
});
}
}
Expand Down