backbase-schematics

Getting Started With Schematics

This repository is a basic Schematic implementation that serves as a starting point to create and publish Schematics to NPM.

Testing

To test locally, install @angular-devkit/schematics 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.

Check the documentation with

schematics --help

Unit Testing

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

Publishing

To publish, simply do:

npm run build
npm publish

That's it!

This repo is created from schematics generator:

schematics @schematics/schematics:schematic --name=my-name

Usage

To run a schematic from the backbase-schematics collection via ng generate:

npm install -g backbase-schematics
# Then in your angular project folder run: 
ng generate <schematic-name> --collection backbase-schematics [parameters]

For example:

ng generate data-module --collection backbase-schematics --name TodoData --ramlPath ./spec/path/api.raml
# or shorten form of the command: 
ng g dm -c backbase-schematics TodoData  -rp ./spec/path/api.raml

To scaffold a new data-module via backbase-schematics collection.