feat: add --includeOnly

azu · Aug 13, 2021 · 1177873 · 1177873
1 parent 4820df4
commit 1177873
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/src/cli.ts b/src/cli.ts
@@ -8,6 +8,7 @@ export const cli = meow(
       $ express-router-dependency-graph --rootDir=path/to/project
  
     Options
+      --includeOnly           [String] only include modules satisfying a pattern. https://github.com/sverweij/dependency-cruiser/blob/develop/doc/cli.md#--include-only-only-include-modules-satisfying-a-pattern 
       --rootDir               [Path:String] path to root dir of source code [required]
       --rootBaseUrl           [Path:String] if pass it, replace rootDir with rootDirBaseURL in output.
       --format                ["json" | "markdown"] output format. Default: json
@@ -25,6 +26,9 @@ export const cli = meow(
                 type: "string",
                 default: ""
             },
+            includeOnly: {
+                type: "string"
+            },
             format: {
                 type: "string",
                 default: "json"
@@ -42,7 +46,8 @@ export const run = async (
     const result = await analyzeDependency({
         rootDir: path.resolve(process.cwd(), flags.rootDir),
         rootBaseUrl: flags.rootBaseUrl,
-        outputFormat: flags.format as "json" | "markdown"
+        outputFormat: flags.format as "json" | "markdown",
+        includeOnly: flags.includeOnly
     });
     return {
         stdout: flags.format === "json" ? JSON.stringify(result) : result,

diff --git a/src/index.ts b/src/index.ts
@@ -63,11 +63,13 @@ const findRouting = async (filePath: string) => {
 export async function analyzeDependency({
     outputFormat,
     rootDir,
-    rootBaseUrl = ""
+    rootBaseUrl = "",
+    includeOnly
 }: {
     rootDir: string;
     rootBaseUrl: string;
     outputFormat: "markdown" | "json";
+    includeOnly?: string | string[];
 }) {
     const ROOT_DIR = rootDir;
     const hasImportExpress = (dep: IDependency) => {
@@ -88,7 +90,9 @@ export async function analyzeDependency({
         return path.relative(ROOT_DIR, toAbsolute(f));
     };
     const ARRAY_OF_FILES_AND_DIRS_TO_CRUISE: string[] = [ROOT_DIR];
-    const cruiseResult: IReporterOutput = cruise(ARRAY_OF_FILES_AND_DIRS_TO_CRUISE);
+    const cruiseResult: IReporterOutput = cruise(ARRAY_OF_FILES_AND_DIRS_TO_CRUISE, {
+        includeOnly
+    });
     if (typeof cruiseResult.output !== "object") {
         throw new Error("NO OUTPUT");
     }