generator-deftyped

Yeoman generator for DefinitelyTyped typings - lets you quickly set up a typing directory with a minimal template.

⚠️ Under construction... be patient! 🌴

Dependencies

To execute the deftyped generator you will need some npm packages:

• Yeoman

$ npm install -g yo

• Typescript

npm install -g typescript

• Grunt CLI

npm install -g grunt-cli

Getting Started

This generator will sets up a new DefinitelyTyped typing template, generating the basic files you need to get started.

Clone this project

$ git clone git@github.com:DefinitelyTyped/generator-deftyped.git

Go to project directory and install npm dependencies

$ npm install

Build the typescript code using grunt

$ grunt

To run the generator to test while you still developing and improving the code you will need a symbolic link to project directory. To do that, run:

$ npm link

Goto another directory and execute the generator to test. Example:

$ yo deftyped

You will need to answer a little questions.

   ___ _____                  _
  |   \_   _|  _ _ __  ___ __| |
  | |) || || || | '_ \/ -_) _` |
  |___/ |_| \_, | .__/\___\__,_|
            |__/|_|

 Welcome to DefinitelyTyped typing boilerplate!

[?] Please, inform the typing name? jquery-abc
[?] What the typing version? 1.0.0
[?] What the project library url? http://jquery-abc.org
[?] Inform your Github name? Diullei

...

This will generate the following stuff:

- jquery-abc
   ├── jquery-abc.d.ts
   ├── jquery-abc-tests.ts
   └── jquery-abc-tests.ts.tscparams

Now all you need to do is edit the files, start to write the typing and send in a Pull Request!

TODO

To see what to do, please, take a look at issue list https://github.com/DefinitelyTyped/generator-deftyped/issues?page=1&state=open

License

Copyright (c) 2014 Diullei Gomes @ DefinitelyTyped

Licensed under the MIT license.