grunt-tsreflect
v0.1.2
Published
Grunt plugin to generate TypeScript declaration files in JSON format for runtime type information.
Downloads
67
Maintainers
Readme
grunt-tsreflect
Grunt plugin to generate TypeScript declaration files in JSON format for runtime type information.
Getting Started
This plugin requires Grunt ~0.4.5
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-tsreflect --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-tsreflect');
The "tsreflect" task
This task uses the tsreflect-compiler to generate JSON files which contain type information from your TypeScript files. The generated files are similar to TypeScript's .d.ts declaration files but are in a JSON format and have the extension .d.json.
Overview
In your project's Gruntfile, add a section named tsreflect
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
tsreflect: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
}
}
});
Options
noCheck
Type: Boolean
Default value: false
Disable type checking. If you are sure that your code already compiles correctly with TypeScript, you can enable this option for slightly faster compile times.
noLib
Type: Boolean
Default value: false
Disable inclusion of default lib.d.ts.
removeComments
Type: Boolean
Default value: false
Do not include the description from JsDoc comments in compiled output.
noImplicitAny
Type: Boolean
Default value: false
Warn on expressions and declarations with an implied any type.
suppressImplicitAnyIndexErrors
Type: Boolean
Default value: false
Suppress warnings of an implied any type on index access.
removeAccessors
Type: Boolean
Default value: false
Do not emit property accessor declarations. Instead, emit as field declarations.
removeAnnotations
Type: Boolean
Default value: false
Do not emit custom annotations in output.
removePrivates
Type: Boolean
Default value: false
Do not emit private class member declarations.
removeTypesOnPrivates
Type: Boolean
Default value: false
Do not emit type information for private class members.
By default, full declarations for private class members (including all overloads) are emitted as long as the type of the member is accessible from outside of the module that contains the class. If the type of the member is not accessible, the type information will be silently excluded.
libPath
Type: String
Path to the lib.d.json file relative to compiler javascript source.
ignoreAnnotation
Type: [annotationName: String]: Boolean
Controls whether or not annotations with a given name are ignored.
By default all default JsDoc annotations are ignored when generating declaration files. The ignoreAnnotations option can be used to include an annotation that is ignored by default, or to ignore additional annotations. Please see examples below for more information.
Usage Examples
Compile files to output directory
grunt.initConfig({
tsreflect: {
files: {
src: [
'src/file1.ts',
'src/file2.ts',
'src/files3.d.ts'
],
dest: 'build/'
}
}
});
Compile to specified file
grunt.initConfig({
tsreflect: {
files: {
src: [
'src/file1.ts',
'src/file2.ts',
'src/files3.d.ts'
],
dest: 'build/file.d.json'
}
}
});
Compile to specified file and do not emit custom annotations
grunt.initConfig({
tsreflect: {
files: {
options: {
removeAnnotations: true
},
src: [
'src/file1.ts',
'src/file2.ts',
'src/files3.d.ts'
],
dest: 'build/file.d.json'
}
}
});
Ignore @label annotation
grunt.initConfig({
tsreflect: {
files: {
options: {
ignoreAnnotation: {
label: true
}
},
src: [
'src/file1.ts'
],
dest: 'build/'
}
}
});
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.