Getting Started With Schematics

This repository is a basic Schematic implementation that sets up a default web page with a navbar, sidebar, content and footer.

Publishing

To publish, simply do:

npm run build                                       -> To make sure you have the latest version of the schematic
npm publish                                         -> Note that you need to be looged in and the name of the package must be unique, cannot be republished until 24 hours have passed.

To use the schematic, simply do:

ng new name-of-project                              -> It creates a new Angular app
cd name-of-project                                  -> It enters into the generated project
npm i rh-one-ui-schematic                           -> It installs the schematic
ng generate rh-one-ui-schematic:rh-one-ui-schematic -> It specifies the package name that contains the schematic (package.json) followed by a colon and then the name of the schematic itself (collection.json). It generates new code in the target project

npm install                                         -> It installs all the dependencies listed in package.json
npm run build                                       -> It builds the application
ng serve                                            -> It runs the application local on http://localhost:4200/

Temporarily for testing purposes

Running the schematic on the terminal

cd testProject
npm run build
ng serve                      
cd ..
npm run build
schematics .:rh-one-ui-schematic --dry-run=false -> It builds the project and runs the schematic. It copies the files under files/* into the default-project testProject.

cd testProject
ng serve

Making the schematic available to install locally

npm run build
npm link                                              -> It links the package, makes the lib available globally on the local system
ng new schematic-test                                 -> It creates a new Angular app in a totally different folder / add SCSS
cd schematic-test
npm link rh-one-ui-schematic                          -> It links to the local version of the schematic through npm
ng generate rh-one-ui-schematic:rh-one-ui-schematic

npm install
npm run build
ng serve

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.

Check the documentation with

schematics --help

Unit Testing

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

That's it!