ng2g v0.0.4

Code Generators for Angular 2

This is an ultra-simple cli tool for generating Angular2 component, directive, service and pipe scaffolding, with naming conventions taken from the Angular 2 Style Guide

This project is an extension of michaelbromley/cmpg and is inspired by angular-cli.

Templates

Currently the templates for a webpack-based build using Sass for styles. A good enhancement would be to somehow allow different template files to be specified.

Sass-loader configuration for webpack project: { test: /\.scss$/, exclude: /node_modules/, loader: 'to-string!css-loader!postcss-loader!sass-loader' }

Usage

npm install -g ng2g

Component Generator

> ng2g component component-selector, use kebab case for the component selector.

Service Generator

> ng2g service ServiceName, use pascal or camel case for the service name.

Pipe Generator

> ng2g pipe pipeName, use pascal or camel case for the pipe name.

Directive Generator

> ng2g directive directiveName, use pascal or camel case for the directive name.

Example

That will generate a TypeScript component, test, HTML and Sass file named according to the argument passed:

> ng2g component foo-selector

result:

./foo-selector/
  |- foo-selector.component.ts
  |- foo-selector.component.spec.ts
  |- foo-selector.component.html
  |- foo-selector.scss

The TypeScript file will look like this:

import { Component } from '@angular/core';

@Component({
  selector: 'foo-selector',
  template: require('./foo-selector.component.html'),
  styles: [require('./foo-selector.scss')]
})
export class FooSelectorComponent {
}

If the templates are not to your liking, just go in templates/ and edit away. Make sure to run step 2 again after making any changes.

That's it.

License: MIT