Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 2.18 KB

README.md

File metadata and controls

61 lines (39 loc) · 2.18 KB

grunt-dts-bundle

Grunt plugin to export TypeScript .d.ts files as an external module definition with dts-bundle

Build Status NPM version Dependency Status devDependency Status

Simple wrapper for dts-bundle

Getting Started

This plugin requires Grunt ~0.4.1

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-dts-bundle --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-dts-bundle');

The "grunt-dts-bundle" task

Default Options

All options are passed directly to dts-bundle

grunt.initConfig({
	dts_bundle: {
		build: {
			options: {
				name: 'my-project',
				main: 'build/index.d.ts'
			}
		}
	}
});

History

  • 0.3.0 - Updated to dts-bundle v0.3.0
  • 0.2.0 - Updated to dts-bundle v0.2.0
  • 0.1.0 - First release

Contributing

Contributions are very welcome, please create an Issue before doing something major.

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

License

Copyright (c) 2014 Bart van der Schoor

Licensed under the MIT license.