Package skeleton for a JavaScript module.
npm install @makenew/jsmodule
Package skeleton for a JavaScript module.
Bootstrap a new JavaScript module in five minutes or less.
- Native [ECMAScript module] compatible with [Node.js].
- Package management with [npm].
- Examples with configurable options and arguments powered by [yargs] with [landlubber].
- Linting with the [JavaScript Standard Style] using [ESLint].
- [Prettier] code.
- Futuristic debuggable unit testing with [AVA].
- Code coverage reporting with [Istanbul] and [c8].
- Fully automated version management and package publishing with [semantic-release].
- Continuous checks and tests with [GitHub Actions].
- [Keep a CHANGELOG].
- Consistent coding with [EditorConfig].
- Badges from [Shields.io].
- Start coding instantly with [GitHub Codespaces].
[AVA]: https://github.com/avajs/ava
[ECMAScript module]: https://nodejs.org/api/esm.html
[ESLint]: https://eslint.org/
[EditorConfig]: https://editorconfig.org/
[GitHub Actions]: https://github.com/features/actions
[GitHub Codespaces]: https://github.com/features/codespaces
[Istanbul]: https://istanbul.js.org/
[JavaScript Standard Style]: https://standardjs.com/
[Keep a CHANGELOG]: https://keepachangelog.com/
[Node.js]: https://nodejs.org/
[Prettier]: https://prettier.io/
[Shields.io]: https://shields.io/
[c8]: https://github.com/bcoe/c8
[landlubber]: https://github.com/razor-x/landlubber
[npm]: https://www.npmjs.com/
[semantic-release]: https://semantic-release.gitbook.io/semantic-release/
[yargs]: https://yargs.js.org/
1. Create an empty (non-initialized) repository on GitHub.
2. Clone the main branch of this repository with
``
$ git clone --single-branch git@github.com:makenew/jsmodule.git
$ cd
Optionally, reset to the latest version with
$ git reset --hard
3. Run
$ ./makenew.sh
This will replace the boilerplate, delete itself,
remove the git remote, remove upstream tags,
and stage changes for commit.
4. Create the required GitHub repository secrets.
5. 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:
$ git push -u origin main
6. Ensure the GitHub action passes,
then publish the initial version of the package with
$ nvm install
$ npm install
$ npm version patch
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/jsmodule.git
You can then fetch and merge changes with
`
$ git fetch --no-tags upstream
$ git merge upstream/main
#### 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].
[Releases]: https://github.com/makenew/jsmodule/releases
Add this as a dependency to your project using [npm] with
`
$ npm install @makenew/jsmodule
[npm]: https://www.npmjs.com/
`
$ git clone https://github.com/makenew/jsmodule.git
$ cd jsmodule
$ nvm install
$ npm install
Run the command below in a separate terminal window:
`
$ npm run test:watch
Primary development tasks are defined under scripts in package.json
and available via .
View them with
`
$ npm run
The [source code] is hosted on GitHub.
Clone the project with
`
$ git clone git@github.com:makenew/jsmodule.git
[source code]: https://github.com/makenew/jsmodule
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
[Node.js]: https://nodejs.org/
[Node.js debugging]: https://nodejs.org/en/docs/guides/debugging-getting-started/
[npm]: https://www.npmjs.com/
[nvm]: https://github.com/creationix/nvm
New versions are created with [npm version][npm-version].
#### Automatic
New versions are released automatically with [semantic-release]
as long as commits follow the [Angular Commit Message Conventions].
[Angular Commit Message Conventions]: https://semantic-release.gitbook.io/semantic-release/#commit-message-format
[semantic-release]: https://semantic-release.gitbook.io/
#### Manual
Publish a new version by triggering a [version workflow_dispatch on GitHub Actions].
The version input will be passed as the first argument to [npm-version].
This may be done on the web or using the [GitHub CLI] with
`
$ gh workflow run version.yml --raw-field version=
[GitHub CLI]: https://cli.github.com/
[npm-version]: https://docs.npmjs.com/cli/version
[version workflow_dispatch on GitHub Actions]: https://github.com/makenew/jsmodule/actions?query=workflow%3Aversion
_GitHub Actions should already be configured: this section is for reference only._
The following repository secrets must be set on [GitHub Actions]:
- NPM_TOKEN: npm token for installing and publishing packages.
These must be set manually.
The version, format, generate, and semantic-release GitHub actions
require a user with write access to the repository.
Set these additional secrets to enable the action:
- GH_TOKEN: A personal access token for the user.GIT_USER_NAME
- : The GitHub user's real name.GIT_USER_EMAIL
- : The GitHub user's email.GPG_PRIVATE_KEY
- : The GitHub user's [GPG private key].GPG_PASSPHRASE
- : The GitHub user's GPG passphrase.
[GitHub Actions]: https://github.com/features/actions
[GPG private key]: https://github.com/marketplace/actions/import-gpg#prerequisites
Please submit and comment on bug reports and feature requests.
To submit a patch:
1. Fork it (https://github.com/makenew/jsmodule/fork).
2. Create your feature branch (git checkout -b my-new-feature).git commit -am 'Add some feature'
3. Make changes.
4. Commit your changes ().git push origin my-new-feature`).
5. Push to the branch (
6. Create a new Pull Request.
This npm package is licensed under the MIT license.
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.