README
d3plus-dev
A collection of scripts for developing D3plus modules.
Installing
If you use NPM, npm install d3plus-dev. Otherwise, download the latest release. You can also load d3plus-dev as a standalone library or as part of D3plus. ES modules, AMD, CommonJS, and vanilla environments are supported. In vanilla, a d3plus global is exported:
<script src="https://cdn.jsdelivr.net/npm/d3plus-dev@1"></script>
<script>
console.log(d3plus);
</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-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-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-release <>
If the version number in the package.json has been bumped, this script will compile the release, publish it to NPM, update README documentation, 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.