@martin_hotell/schematics

@martin_hotell/schematics

Scaffolding library for Angular applications with better defaults.

@martin_hotell/schematics provides blueprints for generating Angular apps with better defaults/tooling. Built on top of Schematics, it integrates with the Angular CLI to make setting up Angular applications easier.

Installation

npm i @martin_hotell/schematics -D

or

yarn add @martin_hotell/schematics -D

Dependencies

None :)

Default Schematics Collection

To use @martin_hotell/schematics as the default collection in your Angular CLI project, add it to your .angular-cli.json:

ng set defaults.schematics.collection=@martin_hotell/schematics

The collection schema also has aliases to the most common blueprints used to generate files.

App Setup

Generate new Angualr app with better defaults/tools!

NOTE:

There is ongoing issue with schematics/angularCLI so custom collections doesn't work when installed globally for booting new apps.

Follow this issue to get updated on the status.

You need to do following nasty workaround to make it work:

mkdir -p /usr/local/lib/node_modules/@angular/cli/node_modules/@martin_hotell/schematics

cp -R /usr/local/lib/node_modules/@martin_hotell/schematics/* /usr/local/lib/node_modules/@angular/cli/node_modules/@martin_hotell/schematics

👉 update your path to global npm packages accordingly to your environment /usr/local/lib/node_modules

npx -p @angular-devkit/schematics-cli -p @angular-devkit/schematics -p @angular-devkit/core -p @angular/cli -p typescript -p @martin_hotell/schematics -c "ng new my-app --collection @martin_hotell/schematics"

or if you like to pollute your global environment:

Install:

npm i -g @angular/cli @martin_hotell/schematics

ng new my-app --collection @martin_hotell/schematics
# or
ng new my-app -c @martin_hotell/schematics

Blueprints

• Application

Testing

To test locally, install @angular-devkit/schematics-cli globally and use the schematics command line tool. That tool acts the same as the generate command of the Angular CLI, but also has a debug mode turned on.

Check the documentation with

schematics --help

Unit Testing

npm test will run the unit tests, using Jest as a runner and test framework.

Publishing

To publish, simply do:

npm run release

git push --follow-tags origin master

npm publish

That's it! 🖖