This starter project will standardize coding and publishing for your library, and implements following features:
git commit ...
Clone this repo:
git clone https://github.com/bndynet/typescript-lib-starter.git <your-location> --depth 1
Initialize your library:
npm i && npm run init
and type your package informations
Now, you can code your library and bellow commands to start your work:
npm start
npm run lint
npm run build
npm run docs
npm run test
npm run test:watch
npm run precommit
Commit your changes and push them to your REPO.
All commit message MUST follow https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
Format as:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
Note: The <type> can be found in ./commitlint.config.js file.
Add NPM_TOKEN in your repo -> Settings -> Secrets
If you enabled GitHub Actions, the action will publish your package to GitHub Package Registry automatically.