feat: ImportDeclaration and ExportDeclaration - isModuleSpecifierRela…

…tive()

docs/details/exports.md

@@ -78,6 +78,7 @@ exportDeclaration.getModuleSpecifier(); // returns: string | undefined
 exportDeclaration.setModuleSpecifier("./new-file");
 exportDeclaration.setModuleSpecifier(someSourceFile);
 exportDeclaration.hasModuleSpecifier(); // returns: boolean
+exportDeclaration.isModuleSpecifierRelative(); // if the module specifier starts with ./, ../, or /
 exportDeclaration.getModuleSpecifierSourceFile(); // returns: SourceFile | undefined
 ```
 

docs/details/imports.md

@@ -56,6 +56,14 @@ Get the referenced source file:
 const sourceFile = importDeclaration.getModuleSpecifierSourceFile(); // returns: SourceFile | undefined
 ```
 
+Get if the module specifier is for a relative or non-relative import:
+
+```ts
+importDeclaration.isModuleSpecifierRelative();
+```
+
+Note: Relative imports are imports that have module specifiers that start with `./`, `../`, or `/`.
+
 ### Default import
 
 Get it:

src/compiler/file/ExportDeclaration.ts

@@ -2,7 +2,7 @@ import {ts, SyntaxKind} from "./../../typescript";
 import * as errors from "./../../errors";
 import {ExportSpecifierStructure} from "./../../structures";
 import {insertIntoParentTextRange, verifyAndGetIndex, insertIntoCommaSeparatedNodes} from "./../../manipulation";
-import {ArrayUtils, TypeGuards} from "./../../utils";
+import {ArrayUtils, TypeGuards, StringUtils} from "./../../utils";
 import {Identifier} from "./../common";
 import {Statement} from "./../statement";
 import {ExportSpecifier} from "./ExportSpecifier";
@@ -80,6 +80,18 @@ export class ExportDeclaration extends Statement<ts.ExportDeclaration> {
         return declarations[0] as SourceFile;
     }
 
+    /**
+     * Gets if the module specifier starts with `/`, `./`, or `../`.
+     */
+    isModuleSpecifierRelative() {
+        const moduleSpecifier = this.getModuleSpecifier();
+        if (moduleSpecifier == null)
+            return false;
+        return StringUtils.startsWith(moduleSpecifier, "/") ||
+            StringUtils.startsWith(moduleSpecifier, "./") ||
+            StringUtils.startsWith(moduleSpecifier, "../");
+    }
+
     /**
      * Gets if the module specifier exists
      */

src/compiler/file/ImportDeclaration.ts

@@ -2,7 +2,7 @@ import {ts, SyntaxKind} from "./../../typescript";
 import * as errors from "./../../errors";
 import {ImportSpecifierStructure} from "./../../structures";
 import {insertIntoParentTextRange, verifyAndGetIndex, insertIntoCommaSeparatedNodes, removeChildren} from "./../../manipulation";
-import {ArrayUtils, TypeGuards} from "./../../utils";
+import {ArrayUtils, TypeGuards, StringUtils} from "./../../utils";
 import {Identifier} from "./../common";
 import {Statement} from "./../statement";
 import {ImportSpecifier} from "./ImportSpecifier";
@@ -63,6 +63,16 @@ export class ImportDeclaration extends Statement<ts.ImportDeclaration> {
         return declarations[0] as SourceFile;
     }
 
+    /**
+     * Gets if the module specifier starts with `/`, `./`, or `../`.
+     */
+    isModuleSpecifierRelative() {
+        const moduleSpecifier = this.getModuleSpecifier();
+        return StringUtils.startsWith(moduleSpecifier, "/") ||
+            StringUtils.startsWith(moduleSpecifier, "./") ||
+            StringUtils.startsWith(moduleSpecifier, "../");
+    }
+
     /**
      * Sets the default import.
      * @param text - Text to set as the default import.

src/tests/compiler/file/exportDeclarationTests.ts

@@ -165,6 +165,33 @@ describe(nameof(ExportDeclaration), () => {
         });
     });
 
+    describe(nameof<ExportDeclaration>(n => n.isModuleSpecifierRelative), () => {
+        function doTest(text: string, expected: boolean) {
+            const {firstChild} = getInfoFromText<ExportDeclaration>(text);
+            expect(firstChild.isModuleSpecifierRelative()).to.equal(expected);
+        }
+
+        it("should be when using ./", () => {
+            doTest("export * from './test'", true);
+        });
+
+        it("should be when using ../", () => {
+            doTest("export * from '../test'", true);
+        });
+
+        it("should be when using /", () => {
+            doTest("export * from '/test'", true);
+        });
+
+        it("should not be when not", () => {
+            doTest("export * from 'test'", false);
+        });
+
+        it("should not be when not existing", () => {
+            doTest("export {test}", false);
+        });
+    });
+
     describe(nameof<ExportDeclaration>(n => n.getNamedExports), () => {
         function doTest(text: string, expected: { name: string; alias?: string; }[]) {
             const {firstChild} = getInfoFromText<ExportDeclaration>(text);

src/tests/compiler/file/importDeclarationTests.ts

@@ -93,6 +93,29 @@ describe(nameof(ImportDeclaration), () => {
         });
     });
 
+    describe(nameof<ImportDeclaration>(n => n.isModuleSpecifierRelative), () => {
+        function doTest(text: string, expected: boolean) {
+            const {firstChild} = getInfoFromText<ImportDeclaration>(text);
+            expect(firstChild.isModuleSpecifierRelative()).to.equal(expected);
+        }
+
+        it("should be when using ./", () => {
+            doTest("import * as test from './test'", true);
+        });
+
+        it("should be when using ../", () => {
+            doTest("import * as test from '../test'", true);
+        });
+
+        it("should be when using /", () => {
+            doTest("import * as test from '/test'", true);
+        });
+
+        it("should not be when not", () => {
+            doTest("import * as test from 'test'", false);
+        });
+    });
+
     describe(nameof<ImportDeclaration>(n => n.setDefaultImport), () => {
         function doTest(text: string, newDefaultImport: string, expected: string) {
             const {firstChild, sourceFile} = getInfoFromText<ImportDeclaration>(text);