ngx-butler

Create whole environment for angular development

Usage no npm install needed!

<script type="module">
  import ngxButler from 'https://cdn.skypack.dev/ngx-butler';
</script>

README


MIT commitizen PRs styled with prettier All Contributors


Demo


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 library
  • test:lib - Runs tests
  • test:lib:headless - Runs tests in headless mode with Chrome
  • release - Releases a new version. This will bump the library's version, and update the CHANGE_LOG file based on the commit message
  • release:first - Creates the first release
  • commit - Creates a new commit message based on Angular commit messgae convention
  • contributors:add - Adds a new contributor to the README file

Hooks

  • pre-commit: Runs prettier on the staged files, and verifies that they don't contain debugger, fit, or fdescribe
  • pre-push: Runs the test:lib:headless command

Extras

  • Running the add command updates the tsconfig.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

  1. Develop
  2. Write specs
  3. Run npm run test:lib,
  4. Run npm run commit, and choose fix or feature
  5. Run npm run release
  6. Run npm run build:lib
  7. Go to the dist directory, and run npm 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):


Itay Oded
💻
Netanel Basal
📖 🤔 📆
Steven Harris
💻

This project follows the all-contributors specification. Contributions of any kind welcome!