midway-bin
this is a sub package for midway.
midway developer tool, extends [egg-bin].
Install
$ npm i midway-bin --save-dev
Usage
Add midway-bin
to package.json
scripts like [egg-bin], but just replace command by `midway-bin:
Command
midway-bin
add new command
- build
- clean
- doc
build
build typescript source file to dist directory like tsc
and copy js/css/html file to same place.
$ midway-bin build
options
--clean -c
clean dist directory before build--entrypoint <entrypoint-file>
bundle the output with the specified file as entrypoint
copy static file
we can copy static file when ts file compiling.
// in package.json "midway-bin-build": "include": "app/public" "app/view"
it will be copy src/app/public
to ${outDir}/app/public
.
The outDir
field is configured in the tsconfig.json
File, see compiler-options.
clean
clean a dist directory by build
$ midway-bin clean
doc
generate application document by typedoc
$ midway-bin doc
options
like typedoc, see link
--options [typedoc.js]
Specify a js option file that should be loaded.--out -o [outPath]
Specifies the location the documentation should be written to.--mode -m
default value isfile
, Specifies the output mode the project is used to be compiled with.--exclude
Exclude files by the given pattern when a path is provided as source.--theme
default value isdefault
Specify the path to the theme that should be used.--excludeExternals
default value istrue
Prevent externally resolved TypeScript files from being documented.--ignoreCompilerErrors
default value istrue
Generates documentation, even if the project does not TypeScript compile.--hideGenerator
default value istrue
Do not print the TypeDoc link at the end of the page.
Tips: If the options parameter is supplied, the other default parameters are invalid