@coara/schematics

This package provides a set of Angular schematics to enhance your development workflow with extended component generation capabilities.

Installation

npm install --save-dev @coara/schematics

Usage

You can use these schematics with the Angular CLI's ng generate command or directly with the schematics CLI.

Using with Angular CLI

ng generate @coara/schematics:component [name] [options]

Using with Schematics CLI

schematics @coara/schematics:component [name] [options]

Available Schematics

Component Schematic

Generates an extended Angular component with additional features.

ng generate @coara/schematics:component my-component

Options

| Option | Description | Type | Default | | ----------------- | --------------------------------------- | ---------- | --------- | ---------- | | name | The name of the component (required) | string | - | | path | The path to create the component | string | - | | project | The name of the project | string | - | | skipTests | Skip creating spec files | boolean | false | | prefix | The prefix for the component selector | string | - | | changeDetection | Change detection strategy | 'Default' | 'OnPush' | 'OnPush' | | style | Style file extension | string | 'scss' | | inlineStyle | Include styles inline in component.ts | boolean | false | | inlineTemplate | Include template inline in component.ts | boolean | false |

Examples

Generate a basic component:

ng g @coara/schematics:component my-feature

Generate a component with specific options:

ng g @coara/schematics:component my-feature --changeDetection=Default --skipTests

Generate a component with inline templates and styles:

ng g @coara/schematics:component my-feature --inlineTemplate --inlineStyle

Development

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

Publishing

To publish, simply do:

npm run build
npm publish