Skip to content

Commit 4ad5bab

Browse files
ysk8horiysk8hori
committed
docs(readme): add tsconfig option
1 parent c50528a commit 4ad5bab

File tree

3 files changed

+34
-31
lines changed

3 files changed

+34
-31
lines changed

‎README.md‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -70,21 +70,22 @@ npm install --global @ysk8hori/typescript-graph
7070

7171
## Options
7272

73-
| Option | Description |
74-
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
75-
| `-V, --version` | Output the version number |
76-
| `--md <char>` | Specify the name of the markdown file to be output. The default is typescript-graph.md. |
77-
| `--mermaid-link` | (experimental) Generates a link on a node to open the corresponding file in VSCode. |
78-
| `-d, --dir <char>` | Specify the TypeScript codebase to be analyzed. |
79-
| `--include <char...>` | Specify file paths or parts of file paths to include in the graph (relative to the tsconfig directory, without `./`). |
80-
| `--exclude <char...>` | Specify file paths or parts of file paths to exclude from the graph (relative to the tsconfig directory, without `./`). |
81-
| `--abstraction <char...>` | Specify the paths of directories to be abstracted. Abstracted directories are treated as a single node. |
82-
| `--highlight <char...>` | Specify the path and file names to be highlighted. |
83-
| `--LR` | Set the flowchart orientation to Left-to-Right. |
84-
| `--TB` | Set the flowchart orientation to Top-to-Bottom. |
85-
| `--measure-instability` | Enable the beta feature to measure the instability of modules. |
86-
| `--config-file` | Specify the relative path to the config file (from the current directory or as specified by -d, --dir). The default is .tsgrc.json. |
87-
| `-h, --help` | Display help for the command. |
73+
| Option | Description |
74+
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
75+
| `-V, --version` | Output the version number |
76+
| `--md <char>` | Specify the name of the markdown file to be output. The default is typescript-graph.md. |
77+
| `--mermaid-link` | (experimental) Generates a link on a node to open the corresponding file in VSCode. |
78+
| `-d, --dir <char>` | Specifies the root directory of the TypeScript project to analyze. It reads and uses the tsconfig.json file found in this directory. |
79+
| `--tsconfig <char>` | Specifies the path to the tsconfig file to use for analysis. If this option is provided, -d, --dir will be ignored. |
80+
| `--include <char...>` | Specify file paths or parts of file paths to include in the graph (relative to the tsconfig directory, without `./`). |
81+
| `--exclude <char...>` | Specify file paths or parts of file paths to exclude from the graph (relative to the tsconfig directory, without `./`). |
82+
| `--abstraction <char...>` | Specify the paths of directories to be abstracted. Abstracted directories are treated as a single node. |
83+
| `--highlight <char...>` | Specify the path and file names to be highlighted. |
84+
| `--LR` | Set the flowchart orientation to Left-to-Right. |
85+
| `--TB` | Set the flowchart orientation to Top-to-Bottom. |
86+
| `--measure-instability` | Enable the beta feature to measure the instability of modules. |
87+
| `--config-file` | Specify the relative path to the config file (from the current directory or as specified by -d, --dir). The default is .tsgrc.json. |
88+
| `-h, --help` | Display help for the command. |
8889

8990
## usage
9091

‎docs/README_en.md‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -70,21 +70,22 @@ npm install --global @ysk8hori/typescript-graph
7070

7171
## Options
7272

73-
| Option | Description |
74-
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
75-
| `-V, --version` | Output the version number |
76-
| `--md <char>` | Specify the name of the markdown file to be output. The default is typescript-graph.md. |
77-
| `--mermaid-link` | (experimental) Generates a link on a node to open the corresponding file in VSCode. |
78-
| `-d, --dir <char>` | Specify the TypeScript codebase to be analyzed. |
79-
| `--include <char...>` | Specify file paths or parts of file paths to include in the graph (relative to the tsconfig directory, without `./`). |
80-
| `--exclude <char...>` | Specify file paths or parts of file paths to exclude from the graph (relative to the tsconfig directory, without `./`). |
81-
| `--abstraction <char...>` | Specify the paths of directories to be abstracted. Abstracted directories are treated as a single node. |
82-
| `--highlight <char...>` | Specify the path and file names to be highlighted. |
83-
| `--LR` | Set the flowchart orientation to Left-to-Right. |
84-
| `--TB` | Set the flowchart orientation to Top-to-Bottom. |
85-
| `--measure-instability` | Enable the beta feature to measure the instability of modules. |
86-
| `--config-file` | Specify the relative path to the config file (from the current directory or as specified by -d, --dir). The default is .tsgrc.json. |
87-
| `-h, --help` | Display help for the command. |
73+
| Option | Description |
74+
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
75+
| `-V, --version` | Output the version number |
76+
| `--md <char>` | Specify the name of the markdown file to be output. The default is typescript-graph.md. |
77+
| `--mermaid-link` | (experimental) Generates a link on a node to open the corresponding file in VSCode. |
78+
| `-d, --dir <char>` | Specifies the root directory of the TypeScript project to analyze. It reads and uses the tsconfig.json file found in this directory. |
79+
| `--tsconfig <char>` | Specifies the path to the tsconfig file to use for analysis. If this option is provided, -d, --dir will be ignored. |
80+
| `--include <char...>` | Specify file paths or parts of file paths to include in the graph (relative to the tsconfig directory, without `./`). |
81+
| `--exclude <char...>` | Specify file paths or parts of file paths to exclude from the graph (relative to the tsconfig directory, without `./`). |
82+
| `--abstraction <char...>` | Specify the paths of directories to be abstracted. Abstracted directories are treated as a single node. |
83+
| `--highlight <char...>` | Specify the path and file names to be highlighted. |
84+
| `--LR` | Set the flowchart orientation to Left-to-Right. |
85+
| `--TB` | Set the flowchart orientation to Top-to-Bottom. |
86+
| `--measure-instability` | Enable the beta feature to measure the instability of modules. |
87+
| `--config-file` | Specify the relative path to the config file (from the current directory or as specified by -d, --dir). The default is .tsgrc.json. |
88+
| `-h, --help` | Display help for the command. |
8889

8990
## usage
9091

‎docs/README_ja.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,8 @@ npm install --global @ysk8hori/typescript-graph
7575
| `-V, --version` | バージョン番号を出力 |
7676
| `--md <char>` | 出力するMarkdownファイルの名前を指定します。デフォルトは typescript-graph.md です。 |
7777
| `--mermaid-link` | (experimental) ノードにリンクを生成し、そのファイルをVSCodeで開けるようにします。 |
78-
| `-d, --dir <char>` | 解析対象のTypeScriptコードベースを指定します。 |
78+
| `-d, --dir <char>` | 解析対象のTypeScriptプロジェクトのルートディレクトリを指定します。そこにある tsconfig.json を読み取り、解析します。 |
79+
| `--tsconfig <char>` | 解析に使用する tsconfig ファイルのパスを指定します。これが指定された場合、`-d, --dir` を無視します。 |
7980
| `--include <char...>` | グラフに含めるファイルパスやその一部を指定します（tsconfig ディレクトリからの相対パスで、`./`は不要です）。 |
8081
| `--exclude <char...>` | グラフから除外するファイルパスやその一部を指定します（tsconfig ディレクトリからの相対パスで、`./`は不要です）。 |
8182
| `--abstraction <char...>` | 抽象化したいディレクトリのパスを指定します。抽象化したディレクトリは一つのノードとして扱います。 |

0 commit comments

Comments
 (0)