generator-d3-plugin-ts

1.0.0 • Public • Published

generator-d3-plugin-ts

MIT License NPM version Build Status Dependency Status Coverage percentage

Yeoman generator to scaffold out a D3 v4 plugin boilerplate with typescript

If you want to generate a d3 plugin boilerplate with javascript instead of typescript use the generator-d3-plugin from Akash Goswami.

Installation

First, install Yeoman and generator-d3-plugin-ts using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-d3-plugin-ts

Then generate your new project:

yo d3-plugin-ts

and follow the prompts.

Details

  • The plugins are build using rollup which is suggested by D3.

  • Unit test cases can be written in tape with typescript, tape is added in devDependencies by default.

  • The plugin can be tested using npm test.

    • TDD can be started using npm run test:tdd
    • Code Coverage can be started using npm run test:coverage
  • The plugin can be build using npm run prepublish.

  • The build is created in /build folder.

    • The typings are created in /build/typings folder.
    • The ES2015 module is created in /build/jsnext folder.
    • The UMD module is created in /build/ folder.
  • Local server with live reloading and TDD can be achieved by running npm start.

  • The examples are found in the /example folder. It is recommended that you use this folder to display an example of your plugin.

Read more

Read more about D3 v4 Plugin and reusable chart component for plugins.

Getting To Know Yeoman

  • Yeoman has a heart of gold.
  • Yeoman is a person with feelings and opinions, but is very easy to work with.
  • Yeoman can be too opinionated at times but is easily convinced not to be.
  • Feel free to learn more about Yeoman.

Package Sidebar

Install

npm i generator-d3-plugin-ts

Weekly Downloads

6

Version

1.0.0

License

BSD-3-Clause

Last publish

Collaborators

  • smartin85