Fix organizing imports with type aliases (aljazsim#9)

Co-authored-by: Aljaz Simonic <aljaz.simonic@purple.telstra.com>

Author: aljazsim

src/elements/import-node.ts

@@ -11,7 +11,7 @@ export class ImportNode extends ElementNode
 
     public isModuleReference = false;
     public nameBinding: string | null = null;
-    public namedImports: string[] | null = null;
+    public namedImports: { type: boolean, name: string, alias: string | null }[] | null = null;
     public namespace: string | null = null;
     public source: string;
 
@@ -30,6 +30,7 @@ export class ImportNode extends ElementNode
 
         const isRelativeReference = this.source.startsWith(".") || this.source.startsWith("..");
         const isAbsoluteReference = !isRelativeReference && (this.source.indexOf("/") > -1 || this.source.indexOf("\\") > -1);
+
         this.isModuleReference = !isRelativeReference && !isAbsoluteReference;
     }
 
@@ -58,7 +59,12 @@ export class ImportNode extends ElementNode
                 }
                 else if (ts.isNamedImports(node.importClause?.namedBindings))
                 {
-                    this.namedImports = distinct(node.importClause?.namedBindings.elements.map(e => e.name.text.trim()));
+                    this.namedImports = distinct(node.importClause?.namedBindings.elements.map(e => (
+                        {
+                            type: e.isTypeOnly,
+                            name: e.name.text.trim(),
+                            alias: e.propertyName?.text.trim() ?? null
+                        })));
                 }
             }
 

src/helpers/array-helper.ts

@@ -10,7 +10,9 @@ export function add<T>(items: T[] | null | undefined, itemToAdd: T)
 
 export function distinct<T>(items: T[])
 {
-    return items.filter((value, index, array) => array.indexOf(value) === index);
+    return items.map(i => JSON.stringify(i))
+        .filter((value, index, array) => array.indexOf(value) === index)
+        .map(i => JSON.parse(i) as T);
 }
 
 export function except<T>(items1: T[] | null | undefined, items2: T[] | null | undefined)

src/source-code/source-code-organizer.ts

@@ -120,7 +120,7 @@ export class SourceCodeOrganizer
 
         if (configuration.sortImportsByName)
         {
-            imports.filter(i => i.namedImports).forEach(i => i.namedImports = i.namedImports!.sort((a, b) => compareStrings(a, b)));
+            imports.filter(i => i.namedImports).forEach(i => i.namedImports = i.namedImports!.sort((a, b) => compareStrings(a.name, b.name)));
         }
 
         if (configuration.groupImportsBySource)
@@ -274,7 +274,7 @@ export class SourceCodeOrganizer
             {
                 for (const identifier of import1.namedImports)
                 {
-                    if (!SourceCodeAnalyzer.hasReference(sourceFile, identifier))
+                    if (!SourceCodeAnalyzer.hasReference(sourceFile, identifier.name))
                     {
                         remove(import1.namedImports, identifier);
 

src/source-code/source-code-printer.ts

@@ -85,7 +85,7 @@ export class SourceCodePrinter
     {
         const source = node.source;
         const quote = configuration.quote === ImportSourceFilePathQuoteType.Single ? "'" : '"';
-        const namedImports = (node.namedImports ?? []).filter(ni => ni && ni.trim().length > 0);
+        const namedImports = (node.namedImports ?? []).filter(ni => ni && ni.name.trim().length > 0);
         const nameBinding = node.nameBinding;
         const namespace = node.namespace;
 
@@ -97,7 +97,7 @@ export class SourceCodePrinter
             }
             else if (namedImports.length > 0)
             {
-                return new SourceCode(`import ${nameBinding}, { ${namedImports.join(", ")} } from ${quote}${source}${quote};`);
+                return new SourceCode(`import ${nameBinding}, { ${namedImports.map(ni => (ni.type ? "type " : "") + (ni.alias ? (ni.alias + " as ") : "") + ni.name).join(", ")} } from ${quote}${source}${quote};`);
             }
             else
             {
@@ -110,7 +110,7 @@ export class SourceCodePrinter
         }
         else if (namedImports.length > 0)
         {
-            return new SourceCode(`import { ${namedImports.join(", ")} } from ${quote}${source}${quote};`);
+            return new SourceCode(`import { ${namedImports.map(ni => (ni.type ? "type " : "") + (ni.alias ? (ni.alias + " as ") : "") + ni.name).join(", ")} } from ${quote}${source}${quote};`);
         }
         else
         {

test/helpers/organize-test-helper.ts

@@ -2,7 +2,36 @@ import { getFileNameWithoutExtension, joinPath } from "../../src/helpers/file-sy
 import { getTestConfigurationFilePaths } from "./configuration-helper.js";
 import { OrganizeTestParameters } from "./organize-test-parameters.js";
 
-// #region Exported Functions (1)
+// #region Exported Functions (2)
+
+export function getOrganizeSpecialCaseTestParameters()
+{
+    const specialTestCaseOutputDirectoryPath = "./test/organize-files/special-cases";
+    const specialTestCase1tOutput = `${specialTestCaseOutputDirectoryPath}/special-test-case-1`;
+
+    const specialTestCaseInputDirectoryPath = './test/organize-files/special-cases';
+    const specialTestCase1Input = `${specialTestCaseInputDirectoryPath}/special-test-case-1/special-test-case-1.ts`;
+
+    const tests = [
+        { name: "Special Test Case 1", inputFilePath: specialTestCase1Input, outputDirectoryPath: specialTestCase1tOutput },
+    ];
+    const memberOrganizeParameters: OrganizeTestParameters[] = [];
+
+    for (const test of tests)
+    {
+        for (const configurationFilePath of getTestConfigurationFilePaths())
+        {
+            const description = `organize ${test.name}: ${getFileNameWithoutExtension(configurationFilePath).replaceAll("-", " ")}`;
+            const inputFilePath = test.inputFilePath;
+            const outputDirectoryPath = test.outputDirectoryPath;
+            const outputFilePath = joinPath(outputDirectoryPath, getFileNameWithoutExtension(configurationFilePath) + ".ts");
+
+            memberOrganizeParameters.push(new OrganizeTestParameters(description, configurationFilePath, inputFilePath, outputFilePath));
+        }
+    }
+
+    return memberOrganizeParameters;
+}
 
 export function getOrganizeTestParameters()
 {
@@ -13,7 +42,7 @@ export function getOrganizeTestParameters()
     const testOutputModuleDirectoryPath = `${testOutputDirectoryPath}/module`;
     const testOutputTypeDirectoryPath = `${testOutputDirectoryPath}/type`;
     const testOutputVariableDirectoryPath = `${testOutputDirectoryPath}/variable`;
-    
+
     const testInputDirectoryPath = './test/organize-files/ts-files';
     const testInputClassFilePath = `${testInputDirectoryPath}/class/test-class.ts`;
     const testInputFunctionFilePath = `${testInputDirectoryPath}/function/test-function.ts`;

test/organize-files/organize-files-special-cases.test.ts

@@ -0,0 +1,44 @@
+import { expect, test } from "vitest";
+
+import { Configuration } from "../../src/configuration/configuration.js";
+import { deleteFile, fileExists, readFile, writeFile } from "../../src/helpers/file-system-helper.js";
+import { SourceCodeOrganizer } from "../../src/source-code/source-code-organizer.js";
+import { getOrganizeSpecialCaseTestParameters } from "../helpers/organize-test-helper.js";
+
+for (const otp of getOrganizeSpecialCaseTestParameters())
+{
+    test(otp.description, async () =>
+    {
+        // arrange
+        const configuration = await Configuration.getConfiguration(otp.configurationFilePath);
+        const sourceCodeFilePath = otp.input;
+        const sourceCode = await readFile(sourceCodeFilePath);
+        const expectedOrganizedSourceCodeFilePath = otp.output;
+
+        // act
+        const organizedSourceCodeFilePath = expectedOrganizedSourceCodeFilePath + ".invalid";
+        const organizedSourceCode = await SourceCodeOrganizer.organizeSourceCode(sourceCodeFilePath, sourceCode, configuration);
+
+        if (!(await fileExists(expectedOrganizedSourceCodeFilePath)))
+        {
+            await writeFile(expectedOrganizedSourceCodeFilePath, organizedSourceCode, false);
+        }
+
+        const expectedOrganizedSourceCode = await readFile(expectedOrganizedSourceCodeFilePath);
+
+        if (organizedSourceCode === expectedOrganizedSourceCode)
+        {
+            if (await fileExists(organizedSourceCodeFilePath))
+            {
+                await deleteFile(organizedSourceCodeFilePath);
+            }
+        }
+        else
+        {
+            await writeFile(organizedSourceCodeFilePath, organizedSourceCode, true);
+        }
+
+        // assert
+        expect(organizedSourceCode).toBe(expectedOrganizedSourceCode);
+    });
+}

test/organize-files/special-cases/special-test-case-1/default-configuration-with-grouping-members-with-decorators.ts

@@ -0,0 +1,14 @@
+import { DateTime, type Duration } from "luxon";
+import { v4 as uuidv4 } from "uuid";
+
+export function gen(): string
+{
+    return uuidv4();
+}
+
+export function test(date: DateTime): Duration
+{
+    return date.diffNow('day');
+}
+
+test(DateTime.fromISO('2016-05-25T09:08:34.123+06:00'));

test/organize-files/special-cases/special-test-case-1/default-configuration-with-region-member-count-and-caption-in-region-end.ts

@@ -0,0 +1,18 @@
+import { DateTime, type Duration } from "luxon";
+import { v4 as uuidv4 } from "uuid";
+
+// #region Exported Functions (2)
+
+export function gen(): string
+{
+    return uuidv4();
+}
+
+export function test(date: DateTime): Duration
+{
+    return date.diffNow('day');
+}
+
+// #endregion Exported Functions
+
+test(DateTime.fromISO('2016-05-25T09:08:34.123+06:00'));

test/organize-files/special-cases/special-test-case-1/default-configuration-with-region-member-count.ts

@@ -0,0 +1,18 @@
+import { DateTime, type Duration } from "luxon";
+import { v4 as uuidv4 } from "uuid";
+
+// #region Exported Functions (2)
+
+export function gen(): string
+{
+    return uuidv4();
+}
+
+export function test(date: DateTime): Duration
+{
+    return date.diffNow('day');
+}
+
+// #endregion
+
+test(DateTime.fromISO('2016-05-25T09:08:34.123+06:00'));

test/organize-files/special-cases/special-test-case-1/default-configuration-with-regions.ts

@@ -0,0 +1,18 @@
+import { DateTime, type Duration } from "luxon";
+import { v4 as uuidv4 } from "uuid";
+
+// #region Exported Functions
+
+export function gen(): string
+{
+    return uuidv4();
+}
+
+export function test(date: DateTime): Duration
+{
+    return date.diffNow('day');
+}
+
+// #endregion
+
+test(DateTime.fromISO('2016-05-25T09:08:34.123+06:00'));

test/organize-files/special-cases/special-test-case-1/default-configuration-with-single-quotes-for-imports.ts

@@ -0,0 +1,14 @@
+import { DateTime, type Duration } from 'luxon';
+import { v4 as uuidv4 } from 'uuid';
+
+export function gen(): string
+{
+    return uuidv4();
+}
+
+export function test(date: DateTime): Duration
+{
+    return date.diffNow('day');
+}
+
+test(DateTime.fromISO('2016-05-25T09:08:34.123+06:00'));

test/organize-files/special-cases/special-test-case-1/default-configuration-without-grouping-imports-by-source.ts

@@ -0,0 +1,14 @@
+import { DateTime, type Duration } from "luxon";
+import { v4 as uuidv4 } from "uuid";
+
+export function gen(): string
+{
+    return uuidv4();
+}
+
+export function test(date: DateTime): Duration
+{
+    return date.diffNow('day');
+}
+
+test(DateTime.fromISO('2016-05-25T09:08:34.123+06:00'));

test/organize-files/special-cases/special-test-case-1/default-configuration-without-removing-unused-imports.ts

@@ -0,0 +1,14 @@
+import { DateTime, type Duration } from "luxon";
+import { v4 as uuidv4 } from "uuid";
+
+export function gen(): string
+{
+    return uuidv4();
+}
+
+export function test(date: DateTime): Duration
+{
+    return date.diffNow('day');
+}
+
+test(DateTime.fromISO('2016-05-25T09:08:34.123+06:00'));

test/organize-files/special-cases/special-test-case-1/default-configuration-without-separating-import-groups.ts

@@ -0,0 +1,14 @@
+import { DateTime, type Duration } from "luxon";
+import { v4 as uuidv4 } from "uuid";
+
+export function gen(): string
+{
+    return uuidv4();
+}
+
+export function test(date: DateTime): Duration
+{
+    return date.diffNow('day');
+}
+
+test(DateTime.fromISO('2016-05-25T09:08:34.123+06:00'));

test/organize-files/special-cases/special-test-case-1/default-configuration-without-sorting-imports-by-name.ts

@@ -0,0 +1,14 @@
+import { DateTime, type Duration } from "luxon";
+import { v4 as uuidv4 } from "uuid";
+
+export function gen(): string
+{
+    return uuidv4();
+}
+
+export function test(date: DateTime): Duration
+{
+    return date.diffNow('day');
+}
+
+test(DateTime.fromISO('2016-05-25T09:08:34.123+06:00'));

test/organize-files/special-cases/special-test-case-1/default-configuration-without-sorting-imports-by-source.ts

@@ -0,0 +1,14 @@
+import { DateTime, type Duration } from "luxon";
+import { v4 as uuidv4 } from "uuid";
+
+export function gen(): string
+{
+    return uuidv4();
+}
+
+export function test(date: DateTime): Duration
+{
+    return date.diffNow('day');
+}
+
+test(DateTime.fromISO('2016-05-25T09:08:34.123+06:00'));

test/organize-files/special-cases/special-test-case-1/default-configuration.ts

@@ -0,0 +1,14 @@
+import { DateTime, type Duration } from "luxon";
+import { v4 as uuidv4 } from "uuid";
+
+export function gen(): string
+{
+    return uuidv4();
+}
+
+export function test(date: DateTime): Duration
+{
+    return date.diffNow('day');
+}
+
+test(DateTime.fromISO('2016-05-25T09:08:34.123+06:00'));

test/organize-files/special-cases/special-test-case-1/members-grouped-by-individual-member-type-with-arrow-properties-as-methods.ts

@@ -0,0 +1,18 @@
+import { DateTime, type Duration } from "luxon";
+import { v4 as uuidv4 } from "uuid";
+
+// #region Exported Functions (2)
+
+export function gen(): string
+{
+    return uuidv4();
+}
+
+export function test(date: DateTime): Duration
+{
+    return date.diffNow('day');
+}
+
+// #endregion Exported Functions
+
+test(DateTime.fromISO('2016-05-25T09:08:34.123+06:00'));

test/organize-files/special-cases/special-test-case-1/members-grouped-by-individual-member-type-with-desc-sorting.ts

@@ -0,0 +1,18 @@
+import { DateTime, type Duration } from "luxon";
+import { v4 as uuidv4 } from "uuid";
+
+// #region Exported Functions (2)
+
+export function test(date: DateTime): Duration
+{
+    return date.diffNow('day');
+}
+
+export function gen(): string
+{
+    return uuidv4();
+}
+
+// #endregion Exported Functions
+
+test(DateTime.fromISO('2016-05-25T09:08:34.123+06:00'));