forked from vuejs/vue-cli
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
copy docs/ja/core-plugins/typescript.md
- Loading branch information
1 parent
34512b0
commit 4f29567
Showing
1 changed file
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# @vue/cli-plugin-typescript | ||
|
||
> typescript plugin for vue-cli | ||
Uses TypeScript + `ts-loader` + [fork-ts-checker-webpack-plugin](https://github.com/Realytics/fork-ts-checker-webpack-plugin) for faster off-thread type checking. | ||
|
||
## Configuration | ||
|
||
TypeScript can be configured via `tsconfig.json`. | ||
|
||
Since `3.0.0-rc.6`, `typescript` is now a peer dependency of this package, so you can use a specific version of TypeScript by updating your project's `package.json`. | ||
|
||
This plugin can be used alongside `@vue/cli-plugin-babel`. When used with Babel, this plugin will output ES2015 and delegate the rest to Babel for auto polyfill based on browser targets. | ||
|
||
## Injected Commands | ||
|
||
If opted to use [TSLint](https://palantir.github.io/tslint/) during project creation, `vue-cli-service lint` will be injected. | ||
|
||
## Caching | ||
|
||
[cache-loader](https://github.com/webpack-contrib/cache-loader) is enabled by default and cache is stored in `<projectRoot>/node_modules/.cache/ts-loader`. | ||
|
||
## Parallelization | ||
|
||
[thread-loader](https://github.com/webpack-contrib/thread-loader) is enabled by default when the machine has more than 1 CPU cores. This can be turned off by setting `parallel: false` in `vue.config.js`. | ||
|
||
## Installing in an Already Created Project | ||
|
||
``` sh | ||
vue add typescript | ||
``` | ||
|
||
## Injected webpack-chain Rules | ||
|
||
- `config.rule('ts')` | ||
- `config.rule('ts').use('ts-loader')` | ||
- `config.rule('ts').use('babel-loader')` (when used alongside `@vue/cli-plugin-babel`) | ||
- `config.rule('ts').use('cache-loader')` | ||
- `config.plugin('fork-ts-checker')` |