Skip to content

Support vue (experimental) #213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ysk8hori merged 10 commits into from
Nov 29, 2024
Merged

Support vue (experimental) #213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b946f34
chore(scripts): fix tsc:demo scripts
ysk8hori Nov 23, 2024
800277d
refactor(creategraph): ソースファイルをグラフにする部分を関数化
ysk8hori Nov 23, 2024
efb072c
test(integration): dummy_project に vue ファイルを追加
ysk8hori Nov 24, 2024
d39e54f
feat(creategraph): Vue を解析可能とする
ysk8hori Nov 26, 2024
61d9ebb
docs(readme): --vue について記載
ysk8hori Nov 28, 2024
5e8c09a
feat(option): vue フラグにより .vue ファイルを対象とするか否かを選択できる
ysk8hori Nov 29, 2024
f9488f7
test(integration): vue を対象とするテストを追加
ysk8hori Nov 29, 2024
9527318
chore(deps): update all minor and patch dependencies (#208)
renovate[bot] Nov 28, 2024
e1cf65c
chore(deps): update dependency typescript to v5.7.2 (#209)
renovate[bot] Nov 28, 2024
f0ca21b
chore(deps): update eslint related packages (#210)
renovate[bot] Nov 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 17 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,22 +70,23 @@ npm install --global @ysk8hori/typescript-graph

## Options

| Option | Description |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `-V, --version` | Output the version number |
| `--md <char>` | Specify the name of the markdown file to be output. The default is typescript-graph.md. |
| `--mermaid-link` | (experimental) Generates a link on a node to open the corresponding file in VSCode. |
| `-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. |
| `--tsconfig <char>` | Specifies the path to the tsconfig file to use for analysis. If this option is provided, -d, --dir will be ignored. |
| `--include <char...>` | Specify file paths or parts of file paths to include in the graph (relative to the tsconfig directory, without `./`). |
| `--exclude <char...>` | Specify file paths or parts of file paths to exclude from the graph (relative to the tsconfig directory, without `./`). |
| `--abstraction <char...>` | Specify the paths of directories to be abstracted. Abstracted directories are treated as a single node. |
| `--highlight <char...>` | Specify the path and file names to be highlighted. |
| `--LR` | Set the flowchart orientation to Left-to-Right. |
| `--TB` | Set the flowchart orientation to Top-to-Bottom. |
| `--measure-instability` | Enable the beta feature to measure the instability of modules. |
| `--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. |
| `-h, --help` | Display help for the command. |
| Option | Description |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-V, --version` | Output the version number |
| `--md <char>` | Specify the name of the markdown file to be output. The default is typescript-graph.md. |
| `--mermaid-link` | (experimental) Generates a link on a node to open the corresponding file in VSCode. |
| `-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. |
| `--tsconfig <char>` | Specifies the path to the tsconfig file to use for analysis. If this option is provided, -d, --dir will be ignored. |
| `--include <char...>` | Specify file paths or parts of file paths to include in the graph (relative to the tsconfig directory, without `./`). |
| `--exclude <char...>` | Specify file paths or parts of file paths to exclude from the graph (relative to the tsconfig directory, without `./`). |
| `--abstraction <char...>` | Specify the paths of directories to be abstracted. Abstracted directories are treated as a single node. |
| `--highlight <char...>` | Specify the path and file names to be highlighted. |
| `--LR` | Set the flowchart orientation to Left-to-Right. |
| `--TB` | Set the flowchart orientation to Top-to-Bottom. |
| `--measure-instability` | Enable the beta feature to measure the instability of modules. |
| `--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. |
| `--vue` (experimental) | `.vue` files are also included in the analysis. A temporary working directory is created using Node.js's `fs.mkdtempSync`, where all files targeted by `tsc` as well as `.vue` files are copied for processing. `.vue` files are renamed to `.vue.ts` unless a file with the same name already exists in the directory. |
| `-h, --help` | Display help for the command. |

## usage

Expand Down
33 changes: 17 additions & 16 deletions docs/README_en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,22 +70,23 @@ npm install --global @ysk8hori/typescript-graph

## Options

| Option | Description |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `-V, --version` | Output the version number |
| `--md <char>` | Specify the name of the markdown file to be output. The default is typescript-graph.md. |
| `--mermaid-link` | (experimental) Generates a link on a node to open the corresponding file in VSCode. |
| `-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. |
| `--tsconfig <char>` | Specifies the path to the tsconfig file to use for analysis. If this option is provided, -d, --dir will be ignored. |
| `--include <char...>` | Specify file paths or parts of file paths to include in the graph (relative to the tsconfig directory, without `./`). |
| `--exclude <char...>` | Specify file paths or parts of file paths to exclude from the graph (relative to the tsconfig directory, without `./`). |
| `--abstraction <char...>` | Specify the paths of directories to be abstracted. Abstracted directories are treated as a single node. |
| `--highlight <char...>` | Specify the path and file names to be highlighted. |
| `--LR` | Set the flowchart orientation to Left-to-Right. |
| `--TB` | Set the flowchart orientation to Top-to-Bottom. |
| `--measure-instability` | Enable the beta feature to measure the instability of modules. |
| `--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. |
| `-h, --help` | Display help for the command. |
| Option | Description |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-V, --version` | Output the version number |
| `--md <char>` | Specify the name of the markdown file to be output. The default is typescript-graph.md. |
| `--mermaid-link` | (experimental) Generates a link on a node to open the corresponding file in VSCode. |
| `-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. |
| `--tsconfig <char>` | Specifies the path to the tsconfig file to use for analysis. If this option is provided, -d, --dir will be ignored. |
| `--include <char...>` | Specify file paths or parts of file paths to include in the graph (relative to the tsconfig directory, without `./`). |
| `--exclude <char...>` | Specify file paths or parts of file paths to exclude from the graph (relative to the tsconfig directory, without `./`). |
| `--abstraction <char...>` | Specify the paths of directories to be abstracted. Abstracted directories are treated as a single node. |
| `--highlight <char...>` | Specify the path and file names to be highlighted. |
| `--LR` | Set the flowchart orientation to Left-to-Right. |
| `--TB` | Set the flowchart orientation to Top-to-Bottom. |
| `--measure-instability` | Enable the beta feature to measure the instability of modules. |
| `--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. |
| `--vue` (experimental) | `.vue` files are also included in the analysis. A temporary working directory is created using Node.js's `fs.mkdtempSync`, where all files targeted by `tsc` as well as `.vue` files are copied for processing. `.vue` files are renamed to `.vue.ts` unless a file with the same name already exists in the directory. |
| `-h, --help` | Display help for the command. |

## usage

Expand Down
Loading