ngx-butler v0.0.21
Schematics that wrap the Angular generate library schematics and provide all the standard boilerplate you need in order to create a neat Angular open-source project.
Usage
ng add @ngneat/lib @scope/toaster
Several files were created. Let's go over them:
Files
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- ISSUE_TEMPLATE.md
- LICENSE.md
- PULL_REQUEST_TEMPLATE.md
- README.md
Tools
Prettier, Commitizen, Standard Version, Travis, Spectator, All Contributors
Scripts
build:lib
- Builds the librarytest:lib
- Runs teststest:lib:headless
- Runs tests in headless mode with Chromerelease
- Releases a new version. This will bump the library's version, and update theCHANGE_LOG
file based on the commit messagerelease:first
- Creates the first releasecommit
- Creates a new commit message based on Angular commit messgae conventioncontributors:add
- Adds a new contributor to theREADME
file
Hooks
pre-commit
: Runs prettier on the staged files, and verifies that they don't containdebugger
,fit
, orfdescribe
pre-push
: Runs thetest:lib:headless
command
Extras
Running the
add
command updates thetsconfig.json
file so that you can import any files from the npm path (@scope/name
) rather than from relative paths.It also populates the library's
package.json
with the initial required information. Make sure you verify the data is accurate before proceeding.
Basic Working Flow
- Develop
- Write specs
- Run
npm run test:lib
, - Run
npm run commit
, and choosefix
orfeature
- Run
npm run release
- Run
npm run build:lib
- Go to the
dist
directory, and runnpm publish
Skipping the Library Creation
The schematics provide the --skip-lib flag for cases where we want to generate everything except the library.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!