TypeScript loader for Vue-loader

Type-check your script in your Vue-loader. Easier importing .ts file in vue's SFC.

Getting Started

Tutorials and examples can be found here.

Installation

npm install vue-ts-loader

You will also need to install TypeScript if you have not already.

npm install typescript

or if you want to install TypeScript globally

npm install typescript -g
npm link typescript

You also need install vue-loader and friends. Please refer to vue-loader's documentation.

Upgrading

Take advantage of the Changelog and Upgrade Guide.

Running

Use webpack like normal, including webpack --watch and webpack-dev-server, or through another build system using the Node.js API.

Compatibility

The current version is compatible with TypeScript 1.8.

Configuration

1. Create or update webpack.config.js like so:

   1module.exports = {
   2  entry: './app.vue',
   3  output: {
   4    filename: 'bundle.js'
   5  },
   6  resolve: {
   7    // Add `.ts` and `.vue` as a resolvable extension.
   8    extensions: ['', '.ts', '.vue']
   9  },
   10  module: {
   11    loaders: [
   12      // all files with a `.ts` or `.tsx` extension will be handled by `ts-loader`
   13      { test: /\.vue$/, loader: 'vue-loader' },
   14      { test: /\.tsx?$/, loader: 'vue-ts-loader' }
   15    ]
   16  },
   17  vue: {
   18    loaders: {
   19      ts: 'vue-ts-loader'
   20    }
   21  },
   22}

2. Add a tsconfig.json file.

   1{
   2  "compilerOptions": {
   3    "target": "es5",
   4    "sourceMap": true
   5  },
   6  "exclude": [
   7    "node_modules"
   8  ]
   9}

The tsconfig.json file controls TypeScript-related options so that your IDE, the tsc command, and this loader all share the same options. TypeScript files from all subdirectories will get included except the ones matching exclude.

Failing the build on TypeScript compilation error

When the build fails (i.e. at least one typescript compile error occured), vue-ts-loader does not propagate the build failure to webpack. The upshot of this is you can fail to notice an erroring build. This is inconvenient; particularly in continuous integration scenarios. If you want to ensure that the build failure is propogated it is advised that you make use of the webpack-fail-plugin. This plugin that will make the process return status code 1 when it finishes with errors in single-run mode. Et voilà! Build failure.

For more background have a read of this issue.

Options

There are two types of options: TypeScript options (aka "compiler options") and loader options. TypeScript options should be set using a tsconfig.json file. Loader options can be set either using a query when specifying the loader or through the ts property in the webpack configuration.

1module.exports = {
2  ...
3  module: {
4    loaders: [
5      // specify option using query
6      { test: /\.tsx?$/, loader: 'vue-ts-loader?compiler=ntypescript' }
7    ]
8  },
9  // specify option using `ts` property
10  ts: {
11    compiler: 'ntypescript'
12  }
13}

transpileOnly (boolean) (default=false)

If you want to speed up compilation significantly you can set this flag. However, many of the benefits you get from static type checking between different dependencies in your application will be lost. You should also set the isolatedModules TypeScript option if you plan to ever make use of this.

silent (boolean) (default=false)

If true, no console.log messages will be emitted. Note that most error messages are emitted via webpack which is not affected by this flag.

ignoreDiagnostics (number[]) (default=[])

You can squelch certain TypeScript errors by specifying an array of diagnostic codes to ignore.

compiler (string) (default='typescript')

Allows use of TypeScript compilers other than the official one. Should be set to the NPM name of the compiler, eg ntypescript.

configFileName (string) (default='tsconfig.json')

Allows you to specify a custom configuration file.

compilerOptions (object) (default={})

Allows overriding TypeScript options. Should be specified in the same format as you would do for the compilerOptions property in tsconfig.json.

instance (string)

Advanced option to force files to go through different instances of the TypeScript compiler. Can be used to force segregation between different parts of your code.

Loading other resources and code splitting

Loading css and other resources is possible but you will need to make sure that you have defined the require function in a declaration file.

1declare var require: {
2    <T>(path: string): T;
3    (paths: string[], callback: (...modules: any[]) => void): void;
4    ensure: (paths: string[], callback: (require: <T>(path: string) => T) => void) => void;
5};

Then you can simply require assets or chunks per the webpack documentation.

1require('!style!css!./style.css');

The same basic process is required for code splitting. In this case, you import modules you need but you don't directly use them. Instead you require them at split points. See this example for more details.

Contributing

Please see the contributer's guide.

License

MIT License