sc0ttwad3 / node-scaffold

A starter for building node-based projects and libraries

node-scaffold

Made with ☕️ by Scott Wade

A starter for building node-based projects and libraries

Get started

npm install

Development zen

This starter includes a watch task which makes development faster and more interactive.

npm run start

View test coverage

It's a good idea to maintain 100% unit test coverage, and always test in the environments you target.

To generate and view test coverage, run:

npm run cover

This will create an HTML report of test coverage – source-mapped back to Typescript – and open it in your default browser.

Generate/update changelog & tag release

This project is tooled for Conventional Changelog to make managing releases easier. See the standard-version documentation for more information on the workflow, or CHANGELOG.md for an example.

# bump package.json version, update CHANGELOG.md, git tag the release
npm changelog

One-step publish preparation script

Notes

See latest POCKET links for some best practise npm and related articles that would be of use here.

And see if there is a reason to use this scaffold instead of one of the many *-cli tools?

Multiple builds (main, module)

Need to update this scaffold with updated HTML boilerplate. Module builds are coming soon.

Targeting older environments

Not sure that this is relevant anymore. Need to use README template.