refactor(models): dir のみオプションではなくする

Author: ysk8hori

src/graph/createGraph.ts

@@ -4,16 +4,15 @@ import { Graph, Meta, Node, OptionValues, Relation } from '../models';
 import { pipe, piped } from 'remeda';
 
 export function createGraph(
-  dir: string,
   /**
    * exclude で指定されたファイルの除外のみファイル読み込み時にも実施する。
    *
    * include をによる絞り込みを行わない理由は、include から参照される include 指定されていないファイルをここで除外したくないため。
    * exclude は、ユーザーが明確に不要と指定しているため、たとえ include に含まれたり include 対象ファイルと関連をもつファイルであったとしても除外して良い。
    **/
-  opt: Partial<Pick<OptionValues, 'exclude'>>,
+  opt: Pick<OptionValues, 'exclude' | 'dir' | 'tsconfig'>,
 ): { graph: Graph; meta: Meta } {
-  const configPath = ts.findConfigFile(dir, ts.sys.fileExists);
+  const configPath = ts.findConfigFile(opt.dir!, ts.sys.fileExists);
   if (!configPath) {
     throw new Error('Could not find a valid "tsconfig.json".');
   }

src/index.ts

@@ -33,7 +33,7 @@ program
   )
   .option(
     '-d, --dir <char>',
-    'Specify the TypeScript code base to be analyzed. if tsconfig.json is not found, specify the directory where tsconfig.json is located.',
+    'Specifies the root directory of the TypeScript project to analyze. It reads and uses the tsconfig.json file found in this directory.',
   )
   .option(
     '--include <char...>',
@@ -66,12 +66,13 @@ opt.include = [...program.args, ...(opt.include ?? [])];
 opt.include = opt.include.length === 0 ? undefined : opt.include;
 
 export async function main(
-  dir: string,
-  commandOptions: typeof opt & { executedScript: string },
+  commandOptions: OptionValues & { executedScript: string },
 ) {
-  setupConfig(path.join(dir, commandOptions.configFile ?? '.tsgrc.json'));
+  setupConfig(
+    path.join(commandOptions.dir, commandOptions.configFile ?? '.tsgrc.json'),
+  );
 
-  const { graph: fullGraph, meta } = createGraph(dir, commandOptions);
+  const { graph: fullGraph, meta } = createGraph(commandOptions);
 
   let couplingData: ReturnType<typeof measureInstability> = [];
   if (commandOptions.measureInstability) {
@@ -103,7 +104,5 @@ export async function main(
     couplingData,
   );
 }
-
-const dir = path.resolve(opt.dir ?? './');
 const executedScript = `tsg ${process.argv.slice(2).join(' ')}`;
-main(dir, { ...opt, executedScript });
+main({ ...opt, dir: path.resolve(opt.dir ?? './'), executedScript });

src/mermaidify.ts

@@ -8,7 +8,7 @@ type DirAndNodesTree = {
   nodes: Node[];
   children: DirAndNodesTree[];
 };
-type Options = Partial<OptionValues> & {
+type Options = OptionValues & {
   rootDir: string;
 };
 

src/models.ts

@@ -1,15 +1,15 @@
 export type OptionValues = {
-  md: string;
-  mermaidLink: boolean;
+  md?: string;
+  mermaidLink?: boolean;
   dir: string;
-  include: string[];
-  exclude: string[];
-  abstraction: string[];
-  highlight: string[];
-  LR: boolean;
-  TB: boolean;
-  configFile: string;
-  measureInstability: boolean;
+  include?: string[];
+  exclude?: string[];
+  abstraction?: string[];
+  highlight?: string[];
+  LR?: boolean;
+  TB?: boolean;
+  configFile?: string;
+  measureInstability?: boolean;
 };
 
 type FileName = string;

src/writeMarkdownFile.ts

@@ -2,7 +2,7 @@ import { createWriteStream } from 'fs';
 import mermaidify from './mermaidify';
 import { Graph, OptionValues, measureInstability } from './models';
 
-type Options = Partial<OptionValues> & {
+type Options = OptionValues & {
   rootDir: string;
   executedScript?: string;
 };