Merge pull request #36 from buildo/infer-quote

Respect existing quote type when possible

Author: gabro

src/rules/no-lib-imports.ts

@@ -1,4 +1,5 @@
-import { createRule } from "../utils";
+import { ASTUtils } from "@typescript-eslint/experimental-utils";
+import { createRule, inferQuote } from "../utils";
 
 export default createRule({
   name: "no-lib-imports",
@@ -20,18 +21,14 @@ export default createRule({
   create(context) {
     return {
       ImportDeclaration(node) {
-        const sourceValue = node.source.raw;
-        const openQuote = /^['"]{1}/;
-        const forbiddenImportPattern = /fp-ts\/lib\//;
+        const sourceValue = ASTUtils.getStringIfConstant(node.source);
+        const forbiddenImportPattern = /^fp-ts\/lib\//;
 
-        if (
-          sourceValue.match(openQuote.source + forbiddenImportPattern.source)
-        ) {
+        if (sourceValue?.match(forbiddenImportPattern.source)) {
           const fixedImportSource = sourceValue.replace(
             forbiddenImportPattern,
             "fp-ts/"
           );
-
           context.report({
             node: node.source,
             messageId: "importNotAllowed",
@@ -40,7 +37,12 @@ export default createRule({
               fixed: fixedImportSource,
             },
             fix(fixer) {
-              return fixer.replaceText(node.source, fixedImportSource);
+              const quote = inferQuote(node.source);
+
+              return fixer.replaceText(
+                node.source,
+                `${quote}${fixedImportSource}${quote}`
+              );
             },
           });
         }

src/rules/no-module-imports.ts

@@ -4,7 +4,7 @@ import {
 } from "@typescript-eslint/experimental-utils";
 import { array } from "fp-ts";
 import { pipe } from "fp-ts/function";
-import { contextUtils, createRule } from "../utils";
+import { contextUtils, createRule, inferQuote } from "../utils";
 
 type Options = [{ allowTypes?: boolean; allowedModules?: string[] }];
 
@@ -65,7 +65,7 @@ export default createRule<Options, MessageIds>({
 
     return {
       ImportDeclaration(node) {
-        const sourceValue = node.source.value?.toString();
+        const sourceValue = ASTUtils.getStringIfConstant(node.source);
         if (sourceValue) {
           const forbiddenImportPattern = /^fp-ts\/(.+)/;
           const matches = sourceValue.match(forbiddenImportPattern);
@@ -152,7 +152,12 @@ export default createRule<Options, MessageIds>({
 
                   return [
                     ...importFixes,
-                    ...addNamedImportIfNeeded(indexExport, "fp-ts", fixer),
+                    ...addNamedImportIfNeeded(
+                      indexExport,
+                      "fp-ts",
+                      inferQuote(node.source),
+                      fixer
+                    ),
                     ...referencesFixes,
                   ];
                 },

src/rules/no-pipeable.ts

@@ -1,5 +1,5 @@
 import { ASTUtils, TSESTree } from "@typescript-eslint/experimental-utils";
-import { createRule } from "../utils";
+import { createRule, inferQuote } from "../utils";
 
 export default createRule({
   name: "no-pipeable",
@@ -24,30 +24,31 @@ export default createRule({
     return {
       ImportDeclaration(node) {
         const sourceValue = ASTUtils.getStringIfConstant(node.source);
-        if (sourceValue) {
-          const pipeableSourcePattern = /^fp-ts\/(lib\/)?pipeable/;
-
-          if (sourceValue.match(pipeableSourcePattern)) {
-            if (
-              node.specifiers.find(
-                (importClause) =>
-                  (importClause as TSESTree.ImportSpecifier).imported?.name ===
-                  "pipe"
-              )
-            ) {
-              context.report({
-                node: node.source,
-                messageId: "importPipeFromFunction",
-                fix(fixer) {
-                  return fixer.replaceText(node.source, `"fp-ts/function"`);
-                },
-              });
-            } else {
-              context.report({
-                node: node.source,
-                messageId: "pipeableIsDeprecated",
-              });
-            }
+        const pipeableSourcePattern = /^fp-ts\/(lib\/)?pipeable/;
+        if (sourceValue?.match(pipeableSourcePattern)) {
+          if (
+            node.specifiers.find(
+              (importClause) =>
+                (importClause as TSESTree.ImportSpecifier).imported?.name ===
+                "pipe"
+            )
+          ) {
+            context.report({
+              node: node.source,
+              messageId: "importPipeFromFunction",
+              fix(fixer) {
+                const quote = inferQuote(node.source);
+                return fixer.replaceText(
+                  node.source,
+                  `${quote}fp-ts/function${quote}`
+                );
+              },
+            });
+          } else {
+            context.report({
+              node: node.source,
+              messageId: "pipeableIsDeprecated",
+            });
           }
         }
       },

src/utils.ts

@@ -160,6 +160,11 @@ export function inferIndent(node: TSESTree.Node): string {
   return new Array(node.loc.start.column + 1).join(" ");
 }
 
+type Quote = "'" | '"';
+export function inferQuote(node: TSESTree.Literal): Quote {
+  return node.raw[0] === "'" ? "'" : '"';
+}
+
 export const contextUtils = <
   TMessageIds extends string,
   TOptions extends readonly unknown[]
@@ -201,6 +206,7 @@ export const contextUtils = <
   function addNamedImportIfNeeded(
     name: string,
     moduleName: string,
+    quote: Quote,
     fixer: TSESLint.RuleFixer
   ): Array<TSESLint.RuleFix> {
     return pipe(
@@ -215,15 +221,15 @@ export const contextUtils = <
               () => [
                 fixer.insertTextAfterRange(
                   [0, 0],
-                  `import { ${name} } from "${moduleName}"\n`
+                  `import { ${name} } from ${quote}${moduleName}${quote}\n`
                 ),
               ],
               (lastImport) =>
                 // other imports founds in this file, insert the import after the last one
                 [
                   fixer.insertTextAfterRange(
                     [lastImport.range[0], lastImport.range[1] + 1],
-                    `import { ${name} } from "${moduleName}"\n`
+                    `import { ${name} } from ${quote}${moduleName}${quote}\n`
                   ),
                 ]
             )

tests/rules/no-module-imports.test.ts

@@ -125,5 +125,22 @@ ruleTester.run("no-module-imports", rule, {
         const z = option.fromNullable(null)
       `,
     },
+    {
+      code: stripIndent`
+        import { some } from 'fp-ts/Option'
+
+        const v = some(42)
+      `,
+      errors: [
+        {
+          messageId: "importNotAllowed",
+        },
+      ],
+      output: stripIndent`
+        import { option } from 'fp-ts'
+
+        const v = option.some(42)
+      `,
+    },
   ],
 });

tests/rules/no-pipeable.test.ts

@@ -32,6 +32,15 @@ ruleTester.run("no-pipeable", rule, {
       ],
       output: 'import { pipe } from "fp-ts/function"',
     },
+    {
+      code: "import { pipe } from 'fp-ts/pipeable'",
+      errors: [
+        {
+          messageId: "importPipeFromFunction",
+        },
+      ],
+      output: "import { pipe } from 'fp-ts/function'",
+    },
     {
       code: 'import { pipeable } from "fp-ts/pipeable"',
       errors: [