@code-dependency/cli
v0.5.0
Published
It is a command line tool for using code-dependency library.
Downloads
23
Readme
@code-dependency/cli
Quick Start
code-dependency --source ./src
Option
-s --source** (required)
Source directory path
code-dependency --source ./src
code-dependency --source /home/app/src
-p --port
Server port number (default 3000).
code-dependency --source ./src --p 4000
code-dependency --source ./src --port 4000
--ts-config
tsconfig.json
path. see
code-dependency --source ./src --ts-config ./tsconfig.json
--webpack-config
webpack.config.js
path. (JavaScript only) see
code-dependency --source ./src --webpack-config webpack.config.js
code-dependency --source ./src --webpack-config your.config.js
--exclude
cruise ignore pattern (default: "node_modules"). see
code-dependency --source ./src --exclude node_modules
--export-static
generate static site.
code-dependency --source ./src --exclude node_modules --export-static ./docs
--public-path
code-dependency --source ./src --exclude node_modules --export-static ./docs --public-path /docs
# If export GitHub Pages
code-dependency --source ./src --exclude node_modules --export-static ./docs --public-path https://himenon.github.io/code-dependency/
Directory Structure
./docs/
├── assets // provide from @code-dependency/view
│ ├── scripts
│ └── stylesheets
└── project
└── src // `--source` target : Browser entrypoint -> /project/src/index.html
--engine
Use native graphviz engine. (https://www.graphviz.org/)
Option: dot
(recommended)
code-dependency --source ./src --exclude node_modules --export-static ./docs --public-path /docs --engine dot
--dry-run (experimental)
if failed generate static file and retry generate static file only unfinished path.
code-dependency --source ./src --exclude node_modules --export-static ./docs --dry-run
License
@code-dependency/cli is MIT licensed.