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
25 changes: 24 additions & 1 deletion src/rules/converters/ban-types.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,33 @@
import { RuleConverter } from "../converter";

export const convertBanTypes: RuleConverter = () => {
export const convertBanTypes: RuleConverter = tslintRule => {
type ConvertBanTypeArgument = {
message: string;
};

const bannedTypes: Record<string, ConvertBanTypeArgument | null> = {};

for (const rule of tslintRule.ruleArguments) {
if (!Array.isArray(rule)) {
break;
}

const [bannedType, message] = rule;
if (!bannedType) {
break;
}

bannedTypes[bannedType] = message ? { message } : null;
}

const ruleArguments =
Object.keys(bannedTypes).length === 0 ? undefined : [{ types: bannedTypes }];

return {
rules: [
{
ruleName: "@typescript-eslint/ban-types",
...{ ruleArguments },
},
],
};
Expand Down
69 changes: 69 additions & 0 deletions src/rules/converters/tests/ban-types.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,73 @@ describe(convertBanTypes, () => {
],
});
});

test("conversion with arguments", () => {
const result = convertBanTypes({
ruleArguments: [
["Object", "Use {} instead."],
["String"],
["Number"],
["Boolean", "Use 'boolean' instead."],
[], // empty array: this should be ignored
],
});

expect(result).toEqual({
rules: [
{
ruleName: "@typescript-eslint/ban-types",
ruleArguments: [
{
types: {
Object: {
message: "Use {} instead.",
},
String: null,
Number: null,
Boolean: {
message: "Use 'boolean' instead.",
},
},
},
],
},
],
});
});

test("conversion with duplicated arguments", () => {
const result = convertBanTypes({
ruleArguments: [["Object", "Use {} instead."], ["Object"]],
});

expect(result).toEqual({
rules: [
{
ruleName: "@typescript-eslint/ban-types",
ruleArguments: [
{
types: {
Object: null,
},
},
],
},
],
});
});

test("conversion with duplicated arguments", () => {
const result = convertBanTypes({
ruleArguments: ["!!!this-is-not-array!!!"],
});

expect(result).toEqual({
rules: [
{
ruleName: "@typescript-eslint/ban-types",
},
],
});
});
});