theluyuan/vue3-yuanma
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: document build --types

Browse Source
This commit is contained in:
Evan You 2019-09-03 12:22:56 -04:00
parent d92d310e0f
commit 1b6f0992d9
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.github/contributing.md vendored
View File

@ -88,6 +88,14 @@ Multiple formats can be specified as a comma-separated list:
yarn build runtime-core -f esm,cjs
```
#### Build with Type Declarations
The `--types` flag will generate type declarations during the build and in addition:
- Roll the declarations into a single `.dts` file for each package;
- Generate an API report in `<projectRoot>/temp/<packageName>.api.md`. This report contains potential warnings emitted by [api-extractor](https://api-extractor.com/).
- Generate an API model json in `<projectRoot>/temp/<packageName>.api.md`. This file can be used to generate a Markdown version of the exported APIs.
### `yarn dev`
The `dev` script bundles a target package (default: `vue`) in a specified format (default: `global`) in dev mode and watches for changes. This is useful when you want to load up a build in an HTML page for quick debugging: