ES Module Package Skeleton
Package skeleton for an ES module.
Description
Bootstrap a new ES Module in five minutes or less.
Features
- Node.js's npm package structure.
- Examples with configurable options and arguments powered by examplr.
- Linting with the JavaScript Standard Style and JSON Lint.
- Automatically lint on changes with gulp.
- Futuristic debuggable unit testing with AVA.
- Code coverage reporting with Istanbul, nyc, and Codecov.
- Continuous testing and automated package publishing with CircleCI.
- Keep a CHANGELOG.
- Consistent coding with EditorConfig.
- Badges from Shields.io.
Bootstrapping a new project
- Create an empty (non-initialized) repository on GitHub.
- Clone the master branch of this repository with
Optionally, reset to the latest version with$ git clone --single-branch git@github.com:makenew/esmodule.git <new-node-lib> $ cd <new-node-lib>
$ git reset --hard <version-tag>
- Run
This will replace the boilerplate, delete itself, remove the git remote, remove upstream tags, and stage changes for commit.$ ./makenew.sh
- Create the required CircleCI environment variables with
$ .circleci/envvars.sh
- Review, commit, and push the changes to GitHub with
$ git diff --cached $ git commit -m "Replace makenew boilerplate" $ git remote add origin git@github.com:<user>/<new-node-lib>.git $ git push -u origin master
- Ensure the CircleCI build passes,
then publish the initial version of the package with
$ nvm install $ npm install $ npm version patch
Updating from this skeleton
If you want to pull in future updates from this skeleton, you can fetch and merge in changes from this repository.
Add this as a new remote with
$ git remote add upstream git@github.com:makenew/esmodule.git
You can then fetch and merge changes with
$ git fetch --no-tags upstream
$ git merge upstream/master
Changelog for this skeleton
Note that CHANGELOG.md
is just a template for this skeleton.
The actual changes for this project are documented in the commit history
and summarized under Releases.
Installation
Add this as a dependency to your project using npm with
$ npm install @makenew/esmodule
or using Yarn with
$ yarn add @makenew/esmodule
Development and Testing
Quickstart
$ git clone https://github.com/makenew/esmodule.git
$ cd esmodule
$ nvm install
$ npm install
Run each command below in a separate terminal window:
$ npm run lint:watch
$ npm run test:watch
Primary development tasks are defined under scripts
in package.json
and available via npm run
.
View them with
$ npm run
Source code
The source code is hosted on GitHub. Clone the project with
$ git clone git@github.com:makenew/esmodule.git
Requirements
You will need Node.js with npm and a Node.js debugging client.
Be sure that all commands run under the correct Node version, e.g., if using nvm, install the correct version with
$ nvm install
Set the active version for each shell session with
$ nvm use
Install the development dependencies with
$ npm install
CircleCI
CircleCI should already be configured: this section is for reference only.
The following environment variables must be set on CircleCI:
-
NPM_TOKEN
: npm token for installing and publishing packages. -
CODECOV_TOKEN
: Codecov token for uploading coverage reports (optional).
These may be set manually or by running the script ./circleci/envvars.sh
.
Contributing
Please submit and comment on bug reports and feature requests.
To submit a patch:
- Fork it (https://github.com/makenew/esmodule/fork).
- Create your feature branch (
git checkout -b my-new-feature
). - Make changes.
- Commit your changes (
git commit -am 'Add some feature'
). - Push to the branch (
git push origin my-new-feature
). - Create a new Pull Request.
License
This npm package is licensed under the MIT license.
Warranty
This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright holder or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.