WebFormsComponents

This project was generated with Angular CLI version 9.1.11.

Code scaffolding

Run ng generate component component-name --project webformscomponents to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module --project webformscomponents.

Note: Don't forget to add --project webformscomponents or else it will be added to the default project in your angular.json file.

Build

Run ng build webformscomponents to build the project. The build artifacts will be stored in the dist/ directory.

Publishing

After building your library with ng build webformscomponents, go to the dist folder cd dist/webformscomponents and run npm publish.

Running unit tests

Run ng test webformscomponents to execute the unit tests via Karma.

Documentation

This project uses the framework compodoc to generate the documentation for the code.

For more information about compodoc.

For generate the documentation you must run the following script from \webformscomponents path:

npm run compodoc

outpath: \webformscomponents\documentation\index.html

For write documentation, you need to write in the JsDoc format.

You can see the support SJDoc tags by compodoc here.

If you write code, you need to write comments, because otherwise it is possible that the build will fail. Every time the build process is executed, the coverage of the comments is validated.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.