d3plus-dev

d3plus-dev

A collection of scripts for developing D3plus modules.

Installing

If you use NPM, run npm install d3plus-dev --save. Otherwise, download the latest release. The released bundle supports AMD, CommonJS, and vanilla environments. You can also load directly from d3plus.org:

<script src="https://d3plus.org/js/d3plus-dev.v0.6.full.min.js"></script>

API Reference

Scripts

• d3plus-build - Compiles all files for distribution.
• d3plus-dev - Spins up the development environment.
• d3plus-docs - Generates documentation based on code comments.
• d3plus-env - Creates/updates shares repository files and issue labels.
• d3plus-examples - Generates example images and HTML.
• d3plus-release - Publishes a release for a module.
• d3plus-test - Runs linting and unit/browser tests on source files.

---

d3plus-build <>

This script will compile 2 builds, one with all dependencies includes (full) and one with only the core code. Next, each of those builds is minified using uglifyjs. Finally, all those builds, along with the LICENSE and README, are compressed into a .zip file.

This is a script accessible from the node environment.

---

d3plus-dev <>

Initializes the development server, which will open a connection on localhost:4000 and continuously watch the ./src directory for file changes. When a change is detected, it will rebundle the full javascript build and refresh any open web browsers.

This is a script accessible from the node environment.

---

d3plus-docs <>

Generates the READEME.md documentation based on the JSDoc comments in the codebase. This script will overwrite README.md, but will not do any interaction with Github (commit, push, etc).

This is a script accessible from the node environment.

# d3plus.~finishDocs() <>

This is a inner method of d3plus-docs.

---

d3plus-env <>

This script will create all of the repository files shared across d3plus modules, including: ignore files, travis-ci configuration, LICENSE, and github templates. Additionally, this will also standardize the issue labels available on Github.

This is a script accessible from the node environment.

---

d3plus-examples <>

Parses any markdown files in the ./example directory and transforms them into an HTML file usable on the web and takes a screenshot to be used as a thumbnail.

This is a script accessible from the node environment.

---

d3plus-release <>

If the version number in the package.json has been bumped, this script will compile the release, publish it to NPM, update all documentation and examples, and tag and publish release notes on Github.

This is a script accessible from the node environment.

---

d3plus-test <>

Based on the .eslintrc file provided by the d3plus-env script, all source files will be linted and then passed to any browser/unit tests that have been written.

This is a script accessible from the node environment.

---

_{Documentation generated on Tue, 12 Feb 2019 19:04:55 GMT}