feat: refactor ut

Author: Soontao

.vscode/launch.json

@@ -0,0 +1,20 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "name": "vscode-jest-tests",
+      "request": "launch",
+      "args": [
+        "--runInBand",
+        "--watchAll=false"
+      ],
+      "cwd": "${workspaceFolder}",
+      "sourceMaps": true,
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "disableOptimisticBPs": true,
+      "program": "${workspaceFolder}/node_modules/.bin/jest"
+    }
+  ]
+}

.vscode/settings.json

@@ -44,7 +44,9 @@
   "editor.tabSize": 2,
   "editor.fontSize": 14,
   "cSpell.words": [
+    "graphlib",
     "testfile",
+    "testproject",
     "Theo"
   ]
 }

src/cli.ts

@@ -31,7 +31,7 @@ try {
   const result = scanDirectoryWithResult(directory)
   if (result.haveCycle) {
     error(`Circular dependency existed in ${directory}`.red)
-    forEach(result.cyclies, (cycle, index) => {
+    forEach(result.cycleList, (cycle, index) => {
       error(`\ncycle ${index + 1}, size (${cycle.length}):${cycle.length === 1 ? " this file import itself".grey : " these files circular import each other".cyan}\n`)
       // @ts-ignore
       forEach(mapAbsPathesToRelPathes(cycle), c => error(`  ${c}`.red))

src/graph.ts

@@ -5,12 +5,12 @@ import { FileImportDescription } from "./type";
 /**
  * calculate cycle import file
  *
- * @param fileAbsPathes files absolutely path
+ * @param fileAbsPathList files absolutely path
  * @param imports each file's import
  */
-export const calculateCycleImport = (fileAbsPathes: string[], imports: FileImportDescription[]) => {
+export const calculateCycleImport = (fileAbsPathList: string[], imports: FileImportDescription[]) => {
   const new_graph = new Graph({ directed: true })
-  new_graph.setNodes(fileAbsPathes)
+  new_graph.setNodes(fileAbsPathList)
   forEach(imports, i => new_graph.setEdge(i.fromFile, i.importFile))
   return alg.findCycles(new_graph)
 }

src/processor.ts

@@ -1,6 +1,6 @@
 import { resolveFilePath } from "./file";
 import { FileImportDescription } from "./type";
-import {parse} from "@babel/parser";
+import { parse } from "@babel/parser";
 import traverse from "@babel/traverse";
 
 /**
@@ -21,7 +21,7 @@ export const findFileDependencies = (fileAbsolutePath: string, fileCodeString: s
     })
     traverse(ast, {
       ImportDeclaration: (p) => {
-        const {node} = p;
+        const { node } = p;
         if (node.source) {
           const sourceFile = resolveFilePath(fileAbsolutePath, node.source.value)
           if (sourceFile) {
@@ -34,7 +34,7 @@ export const findFileDependencies = (fileAbsolutePath: string, fileCodeString: s
         }
       },
       ExportNamedDeclaration: (p) => {
-        const {node} = p;
+        const { node } = p;
         if (node.source) {
           const sourceFile = resolveFilePath(fileAbsolutePath, node.source.value)
           if (sourceFile) {
@@ -47,7 +47,7 @@ export const findFileDependencies = (fileAbsolutePath: string, fileCodeString: s
         }
       },
       ExportAllDeclaration: (p) => {
-        const {node} = p;
+        const { node } = p;
         if (node.source) {
           const sourceFile = resolveFilePath(fileAbsolutePath, node.source.value)
           if (sourceFile) {
@@ -60,8 +60,8 @@ export const findFileDependencies = (fileAbsolutePath: string, fileCodeString: s
         }
       },
       CallExpression: (p) => {
-        const {node} = p;
-        if (node.callee.type === "Identifier" && node.callee.name === "require") {
+        const { node } = p;
+        if (node.callee.type === "Identifier" && (node.callee.name === "require" || node.callee.name === "import")) {
           if (node.arguments.length >= 1 && node.arguments[0].type === "StringLiteral") {
             const sourceFile = resolveFilePath(fileAbsolutePath, node.arguments[0].value)
             if (sourceFile) {

src/scanner.ts

@@ -27,14 +27,14 @@ export const scanDirectoryWithResult = (directory: string): ScanResult => {
   if (result && result.length > 0) {
     return {
       haveCycle: true,
-      cyclies: result,
+      cycleList: result,
       nodes: filePath,
       imports: filteredImports,
     }
   } else {
     return {
       haveCycle: false,
-      cyclies: [],
+      cycleList: [],
       nodes: filePath,
       imports: filteredImports,
     }

src/type.ts

@@ -14,7 +14,7 @@ export interface PackageJson {
 export type Extension = "js" | "ts" | "tsx" | "jsx" | "mjs"
 
 /**
- * circular dependent files
+ * circular dependent files, each item will be a absolute file path
  */
 export type Cycle = string[];
 
@@ -44,7 +44,7 @@ export interface ScanResult {
    * wether these files have cycle dependency
    */
   haveCycle: boolean;
-  cyclies?: Cycle[];
+  cycleList?: Cycle[];
   nodes?: string[];
   imports?: FileImportDescription[];
 }
@@ -54,11 +54,9 @@ export interface ScanResult {
  */
 export interface ReportVO {
   /**
-   * scnaed files
+   * scanned files
    */
-  nodes: {
-    name: string
-  }[];
+  nodes: { name: string  }[];
   /**
    * files' deps
    */
@@ -67,4 +65,4 @@ export interface ReportVO {
     target: string;
     value?: string;
   }[]
-}
+}

tests/scanner.spec.ts

@@ -1,5 +1,6 @@
 import { scanDirectoryWithResult } from "../src/scanner";
 import { join } from "path";
+import { testfile1AbsPath, testfile3AbsPath, testfile4AbsPath, testfile5AbsPath, testfile6AbsPath } from "./test.base";
 
 describe('scanner related test', () => {
 
@@ -8,5 +9,18 @@ describe('scanner related test', () => {
     expect(result.haveCycle).toEqual(false)
   })
 
+  test('should scan cycles in result', () => {
+    const result = scanDirectoryWithResult(join(__dirname, "./testproject"))
+    expect(result.haveCycle).toEqual(true)
+    expect(result.cycleList?.[0]).toStrictEqual([
+      testfile5AbsPath,
+      testfile1AbsPath,
+    ])
+    expect(result.cycleList?.[1]).toStrictEqual([
+      testfile3AbsPath,
+      testfile4AbsPath,
+      testfile6AbsPath,
+    ])
+  })
 
 })

tests/test.base.ts

@@ -3,7 +3,7 @@ import { FileImportDescription } from "../src/type";
 
 export const cwd: string = require("process").cwd();
 
-export const testfile1RelativePath = normalize("tests/testproject/d1/testfile.js")
+export const testfile1RelativePath = normalize("tests/testproject/d1/testfile.ts")
 export const testfile2RelativePath = normalize("tests/testproject/d2/testfile2.js")
 export const testfile3RelativePath = normalize("tests/testproject/d2/d3/testfile3.js")
 export const testfile4RelativePath = normalize("tests/testproject/d2/d3/testfile4.js")

tests/testproject/d1/testfile.js

@@ -0,0 +1 @@
+import "../testfile5.ts"

tests/testproject/d1/testfile.ts

@@ -1 +1 @@
-import "../testfile4"
+import "../testfile4"

tests/testproject/d2/d3/d4/testfile6.js

@@ -1 +1,2 @@
-import "./d1/testfile"
+export * from "./d1/testfile"
+export const a = 15;

tests/testproject/testfile5.ts

@@ -9,7 +9,8 @@
       "dom"
     ],
     "module": "commonjs",
-    "target": "es5",
+    "target": "ES2015",
+    "sourceMap": true,
     "moduleResolution": "node",
     "charset": "utf-8",
     "emitDecoratorMetadata": true,