feat: Add ImportDeclaration.removeDefaultImport()

dsherret · Sep 20, 2018 · 87dd9cf · 87dd9cf
1 parent 51fc63d
commit 87dd9cf
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 7 deletions.
diff --git a/docs/details/imports.md b/docs/details/imports.md
@@ -80,6 +80,7 @@ Set it:
 
 ```ts
 importDeclaration.setDefaultImport("MyClass");
+importDeclaration.removeDefaultImport();
 ```
 
 #### Example

diff --git a/src/compiler/file/ImportDeclaration.ts b/src/compiler/file/ImportDeclaration.ts
@@ -115,10 +115,7 @@ export class ImportDeclaration extends Statement<ts.ImportDeclaration> {
         const importClause = this.getImportClause();
         if (importClause == null)
             return undefined;
-        const firstChild = importClause.getFirstChild();
-        if (firstChild == null || firstChild.getKind() !== SyntaxKind.Identifier)
-            return undefined;
-        return firstChild as Identifier;
+        return importClause.getNodeProperty("name");
     }
 
     /**
@@ -184,6 +181,34 @@ export class ImportDeclaration extends Statement<ts.ImportDeclaration> {
         }
     }
 
+    /**
+     * Removes the default import.
+     */
+    removeDefaultImport() {
+        const importClause = this.getImportClause();
+        if (importClause == null)
+            return this;
+        const defaultImport = importClause.getNodeProperty("name");
+        if (defaultImport == null)
+            return;
+
+        const hasOnlyDefaultImport = importClause.getChildCount() === 1;
+        if (hasOnlyDefaultImport)
+            removeChildren({
+                children: [importClause, importClause.getNextSiblingIfKindOrThrow(SyntaxKind.FromKeyword)],
+                removePrecedingSpaces: true,
+                removePrecedingNewLines: true
+            });
+        else
+            removeChildren({
+                children: [defaultImport, defaultImport.getNextSiblingIfKindOrThrow(SyntaxKind.CommaToken)],
+                removePrecedingSpaces: true,
+                removePrecedingNewLines: true
+            });
+
+        return this;
+    }
+
     /**
      * Gets the namespace import if it exists or throws.
      */
@@ -337,14 +362,14 @@ export class ImportDeclaration extends Statement<ts.ImportDeclaration> {
     /**
      * Gets the import clause or throws if it doesn't exist.
      */
-    getImportClauseOrThrow(): Node {
+    getImportClauseOrThrow() {
         return errors.throwIfNullOrUndefined(this.getImportClause(), "Expected to find an import clause.");
     }
 
     /**
      * Gets the import clause or returns undefined if it doesn't exist.
      */
-    getImportClause(): Node | undefined {
+    getImportClause() {
         return this.getNodeFromCompilerNodeIfExists(this.compilerNode.importClause);
     }
 

diff --git a/src/tests/compiler/file/importDeclarationTests.ts b/src/tests/compiler/file/importDeclarationTests.ts
@@ -254,7 +254,31 @@ describe(nameof(ImportDeclaration), () => {
         });
     });
 
-    describe(nameof<ImportDeclaration>(n => n.getNamespaceImportOrThrow), () => {
+    describe(nameof<ImportDeclaration>(n => n.removeDefaultImport), () => {
+        function doTest(text: string, expected: string) {
+            const { firstChild, sourceFile } = getInfoFromText<ImportDeclaration>(text);
+            firstChild.removeDefaultImport();
+            expect(sourceFile.getText()).to.equal(expected);
+        }
+
+        it("should remove it when it exists", () => {
+            doTest(`import identifier from './file';`, `import './file';`);
+        });
+
+        it("should do nothing when it doesn't exists", () => {
+            doTest(`import './file';`, `import './file';`);
+        });
+
+        it("should remove it when a namespace import exists", () => {
+            doTest(`import name, * as identifier from './file';`, `import * as identifier from './file';`);
+        });
+
+        it("should remove it when named imports exists", () => {
+            doTest(`import name, { test } from './file';`, `import { test } from './file';`);
+        });
+    });
+
+    describe(nameof<ImportDeclaration>(n => n.removeNamespaceImport), () => {
         function doTest(text: string, expected: string) {
             const { firstChild, sourceFile } = getInfoFromText<ImportDeclaration>(text);
             firstChild.removeNamespaceImport();