95 lines
2.6 KiB
Markdown
95 lines
2.6 KiB
Markdown
|
grunt-typescript [![Build Status](https://travis-ci.org/k-maru/grunt-typescript.png?branch=master)](https://travis-ci.org/k-maru/grunt-typescript)
|
||
|
================
|
||
|
|
||
|
Compile TypeScript
|
||
|
|
||
|
## Documentation
|
||
|
You'll need to install `grunt-typescript` first:
|
||
|
|
||
|
npm install grunt-typescript --save-dev
|
||
|
|
||
|
Then modify your `Gruntfile.js` file by adding the following line:
|
||
|
|
||
|
grunt.loadNpmTasks('grunt-typescript');
|
||
|
|
||
|
Then add some configuration for the plugin like so:
|
||
|
|
||
|
grunt.initConfig({
|
||
|
...
|
||
|
typescript: {
|
||
|
base: {
|
||
|
src: ['path/to/typescript/files/**/*.ts'],
|
||
|
dest: 'where/you/want/your/js/files',
|
||
|
options: {
|
||
|
module: 'amd', //or commonjs
|
||
|
target: 'es5', //or es3
|
||
|
base_path: 'path/to/typescript/files',
|
||
|
sourcemap: true,
|
||
|
declaration: true
|
||
|
}
|
||
|
}
|
||
|
},
|
||
|
...
|
||
|
});
|
||
|
|
||
|
If you want to create a js file that is a concatenation of all the ts file (like -out option from tsc),
|
||
|
you should specify the name of the file with the '.js' extension to dest option.
|
||
|
|
||
|
grunt.initConfig({
|
||
|
...
|
||
|
typescript: {
|
||
|
base: {
|
||
|
src: ['path/to/typescript/files/**/*.ts'],
|
||
|
dest: 'where/you/want/your/js/file.js',
|
||
|
options: {
|
||
|
module: 'amd', //or commonjs
|
||
|
}
|
||
|
}
|
||
|
},
|
||
|
...
|
||
|
});
|
||
|
|
||
|
##Options
|
||
|
|
||
|
###nolib `boolean`
|
||
|
Do not include a default lib.d.ts with global declarations
|
||
|
|
||
|
###target `string`
|
||
|
Specify ECMAScript target version: "ES3" (default) or "ES5"
|
||
|
|
||
|
###module `string`
|
||
|
Specify module code generation: "commonjs" (default) or "amd"
|
||
|
|
||
|
###sourcemap `boolean`
|
||
|
Generates corresponding .map files
|
||
|
|
||
|
###declaration `boolean`
|
||
|
Generates corresponding .d.ts file
|
||
|
|
||
|
###comments `boolean`
|
||
|
Emit comments to output
|
||
|
|
||
|
###noImplicitAny `boolean`
|
||
|
Warn on expressions and declarations with an implied 'any' type.
|
||
|
|
||
|
##Original Options
|
||
|
|
||
|
###newLine `string`
|
||
|
Specify newline code: "auto" (default) or "crlf" or "lf". This options is experimental.
|
||
|
|
||
|
###indentStep `number`
|
||
|
Specify space indent count for code generation: This value will be disregarded if the useTabIndent option is specified. This options is experimental.
|
||
|
|
||
|
###useTabIndent `boolean`
|
||
|
Specify tab indent for code generation: false (default) or true. This options is experimental.
|
||
|
|
||
|
###ignoreTypeCheck `boolean`
|
||
|
Default value is true. This options is experimental.
|
||
|
|
||
|
###disallowAsi `boolean`
|
||
|
Do not allow auto semicolon insertion. This options is experimental.
|
||
|
|
||
|
###base_path `string`
|
||
|
|
||
|
※I'm sorry for poor English
|