Implement no-submodule-imports converter (#223)

* Implement no-submodule-imports converter

* Add pattern to rule arguments on submodule imports

Author: KingDarBoja

src/rules/converters.ts

@@ -76,6 +76,7 @@ import { convertNoShadowedVariable } from "./converters/no-shadowed-variable";
 import { convertNoSparseArrays } from "./converters/no-sparse-arrays";
 import { convertNoStringLiteral } from "./converters/no-string-literal";
 import { convertNoStringThrow } from "./converters/no-string-throw";
+import { convertNoSubmoduleImports } from "./converters/no-submodule-imports";
 import { convertNoSwitchCaseFallThrough } from "./converters/no-switch-case-fall-through";
 import { convertNoThisAssignment } from "./converters/no-this-assignment";
 import { convertNoTrailingWhitespace } from "./converters/no-trailing-whitespace";
@@ -200,6 +201,7 @@ export const converters = new Map([
     ["no-sparse-arrays", convertNoSparseArrays],
     ["no-string-literal", convertNoStringLiteral],
     ["no-string-throw", convertNoStringThrow],
+    ["no-submodule-imports", convertNoSubmoduleImports],
     ["no-switch-case-fall-through", convertNoSwitchCaseFallThrough],
     ["no-this-assignment", convertNoThisAssignment],
     ["no-trailing-whitespace", convertNoTrailingWhitespace],

src/rules/converters/no-submodule-imports.ts

@@ -0,0 +1,35 @@
+import { RuleConverter } from "../converter";
+
+export const convertNoSubmoduleImports: RuleConverter = tslintRule => {
+    const ruleArguments: string[] = [];
+
+    if (
+        !(
+            tslintRule.ruleArguments.length === 0 ||
+            tslintRule.ruleArguments[0] === false ||
+            tslintRule.ruleArguments.length < 2
+        )
+    ) {
+        ruleArguments.push(
+            ...tslintRule.ruleArguments.map(ruleArg => {
+                if (typeof ruleArg === "string") {
+                    return ruleArg.concat("/*");
+                }
+                return ruleArg;
+            }),
+        );
+    }
+
+    return {
+        rules: [
+            {
+                ruleName: "import/no-internal-modules",
+                ...{
+                    ruleArguments:
+                        ruleArguments.length > 0 ? [{ allow: ruleArguments }] : undefined,
+                },
+            },
+        ],
+        plugins: ["eslint-plugin-import"],
+    };
+};

src/rules/converters/tests/no-submodule-imports.test.ts

@@ -0,0 +1,34 @@
+import { convertNoSubmoduleImports } from "../no-submodule-imports";
+
+describe(convertNoSubmoduleImports, () => {
+    test("conversion without arguments", () => {
+        const result = convertNoSubmoduleImports({
+            ruleArguments: [],
+        });
+
+        expect(result).toEqual({
+            rules: [
+                {
+                    ruleName: "import/no-internal-modules",
+                },
+            ],
+            plugins: ["eslint-plugin-import"],
+        });
+    });
+
+    test("conversion with arguments", () => {
+        const result = convertNoSubmoduleImports({
+            ruleArguments: [true, "rxjs"],
+        });
+
+        expect(result).toEqual({
+            rules: [
+                {
+                    ruleName: "import/no-internal-modules",
+                    ruleArguments: [{ allow: [true, "rxjs/*"] }],
+                },
+            ],
+            plugins: ["eslint-plugin-import"],
+        });
+    });
+});