Template for making easy-to-work-with tempates
- Copy this template
- Clone to a local directory (eg
git clone https://github.com/me/my-repository/ && cd my-repository)
yarn && yarn setupto initialize the node package (Get rid of template strings - and this readme!)
- Happy Coding!
yarn buildwill build using typescript pre-configured to node-compatible defaults
yarn docswill auto-generate a README.md that starts with TOP.md, then adds CLI documentation (via commanderdoc) for any tool you have set up, and then library documentation after that.
yarn testis pre-configured to test for typescript errors
yarn watchwill watch the codebase for changes and rebuild (using livelink)
Git code protections
git commitwill be blocked on the
mainbranch unless you set the environment variable
ALLOWMAIN=1Branch commits and PRs are thus encouraged
git commitalso tests messages for meeting the commitline standard conventions.
git commitblocks pushes that do not pass
yarn test(as a base case, they must pass typescript compilation)
npm publishwill always rebuild the code, the documentation, and push those changes back to the repository.
npm publishwill only publish the lib and src directories - any others are no
A note on "main"
I made a deliberate choice to change the primary branch from
main for reasons that are obvious to some. This repository endeavors to make that just automatic.
PRs and feedback welcome via GitHub issues.
npx @raydeck/registry-manager-cli [options] [path]
Get registry options from serverless source path
@raydeck/registry-manager-cli - v1.0.2
path: string): any
Defined in index.ts:7