@taito/npm-template v0.0.2
NPM template
Template to start creating npm packages. Aims to simplify the creation of npm packages by giving a common structure and workflow with github actions to automate the publishing process.
Developing
Click "Use this template" and create a new repository for your package.
During developement it is recommended to run npm link command in your package repository (instead of pushing to npm during developement), and npm link <package-name> in another project for testing the usage.
foo@bar mypackage % npm link
foo@bar mypackage % cd /testproject
foo@bar testproject % npm link <package-name>Note: npm link <package-name> refers to the name of the package (ie. name in package.json)
Publishing to npm
Generate an automation access token from npm https://docs.npmjs.com/about-access-tokens
Set the token with the name NPM_TOKEN to github secrets in your package repository.
About secrets: https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions
Use the publish-npm action to push changes to the npm registry.
important: double check your package version, trying to push same version to npm registry will fail.
Finally
Delete all of the above in this README and document your package below.
Table of contents
What
Short description of what this package does
Install
Installation instructions
Usage
How to use the package