1 | # definition-header
|
2 |
|
3 | [![Build Status](https://secure.travis-ci.org/DefinitelyTyped/definition-header.svg?branch=master)](http://travis-ci.org/DefinitelyTyped/definition-header) [![NPM version](https://badge.fury.io/js/definition-header.svg)](http://badge.fury.io/js/definition-header) [![Dependency Status](https://david-dm.org/DefinitelyTyped/definition-header.svg)](https://david-dm.org/DefinitelyTyped/definition-header) [![devDependency Status](https://david-dm.org/DefinitelyTyped/definition-header/dev-status.svg)](https://david-dm.org/DefinitelyTyped/definition-header#info=devDependencies)
|
4 |
|
5 | > DefinitelyTyped definition header utils
|
6 |
|
7 | Work with the headers in the definition files in the [DefinitelyTyped](https://github.com/borisyankov/DefinitelyTyped) repository.
|
8 |
|
9 | Bundles a parser, serialiser, interfaces, assertions and some utilities.
|
10 |
|
11 | :warning: Under construction, in-consistent, tests incomplete... :sunglasses:
|
12 |
|
13 | #### Type export
|
14 |
|
15 | This module is also test to figure out how to export type-info in a npm module (like via package.json etc).
|
16 |
|
17 | ## Format
|
18 |
|
19 | Classic header (from the [wiki](https://github.com/borisyankov/DefinitelyTyped/wiki/How-to-contribute))
|
20 |
|
21 | ````
|
22 | // Type definitions for [LIBRARY NAME]
|
23 | // Project: [LIBRARY URL]
|
24 | // Definitions by: [AUTHOR NAME] <[AUTHOR URL]>
|
25 | // Definitions: https://github.com/borisyankov/DefinitelyTyped
|
26 | ````
|
27 |
|
28 | ## Build
|
29 |
|
30 | Install development dependencies in your git checkout:
|
31 |
|
32 | ````bash
|
33 | $ npm install
|
34 | ````
|
35 |
|
36 | Build and run tests using [grunt](http://gruntjs.com):
|
37 |
|
38 | ````bash
|
39 | $ npm test
|
40 | ````
|
41 |
|
42 | See the `Gruntfile.js` for additional commands.
|
43 |
|
44 | ## History
|
45 |
|
46 | - 0.0.1 - First release
|
47 |
|
48 | ## License
|
49 |
|
50 | Copyright (c) 2014 Bart van der Schoor @ [DefinitelyTyped](https://github.com/DefinitelyTyped)
|
51 |
|
52 | Licensed under the MIT license.
|
53 |
|
\ | No newline at end of file |