Generator-cc-angular NPM

#generator-cc-angular

BDD of Enterprise AngularJS projects with pleasure.

This generator is a fork of cg-angular, which is an amazing project! It did not perfectly fit to my needs so I improved it for my purposes:

clearer separation of config and sources by putting all the application-code in the src folder
integration of protractor, executing matching e2e tests just like the unit tests
Angular 1.3.x: updated all the bower-components and npm libs, dropped angular-bootstrap for that (supports only 1.2.x at the moment)
using ui.router by default
Styleguide compliance: try to stick to the very good AngularJS Style Guide(https://github .com/johnpapa/angularjs-styleguide) from JohnPapa, e.g.: No globals, put everything in closures Use ControllerAs-Syntax * Use Named functions instead of anonymous
Support for child states
Exception Handling and logging
Coverage report for unit tests

In the end, there where so many changes, that I decided to rename the generator to "cc-angular" where "cc" stands for "clean code".

Features

Provides a directory structure geared towards large Angular projects.
- Each controller, service, filter, and directive are placed in their own file.
- All files related to a conceptual unit are placed together. For example, the controller, HTML, LESS, and e2e/unit test for a partial are placed together in the same directory.
Provides a ready-made Grunt build that produces an extremely optimized distribution.
- Build uses grunt-ng-annotate
- grunt serve task allows you to run a simple development server with watch/livereload enabled. Additionally, JSHint and the appropriate unit tests are run for the changed files.
Integrates Bower for package management
Includes Yeoman subgenerators for directives, services, partials, filters, and modules.
Integrates LESS and includes Bootstrap via the source LESS files allowing you to reuse Bootstrap vars/mixins/etc.
Easily Testable - Each sub-generator creates a skeleton unit test. Unit tests can be run via grunt test and they run automatically during the grunt watch that is active during grunt serve.
- partials with routes generate an e2e skeleton test
- e2e tests are written in Gherkin, cucumber.js is included.

Directory Layout

All subgenerators prompt the user to specify where to save the new files. Thus you can create any directory structure you desire, including nesting. The generator will create a handful of files in the root of your project including index.html, app.js, and app.less. You determine how the rest of the project will be structured but the generator makes educated suggestions.

Getting Started

Prerequisites: Node, Grunt, Yeoman, and Bower. Once Node is installed, do:

npm install -g grunt-cli yo bower

Next, install this generator:

# for global use, otherwise install in project
npm install -g generator-cc-angular

To create a project:

mkdir MyNewAwesomeApp
cd MyNewAwesomeApp

#if not installed globally, install it in the project
npm install generator-cc-angular

# let's generate the app
yo cc-angular

#we need webdriver for protractor
./node_modules/grunt-protractor-runner/node_modules/protractor/bin/webdriver-manager update

Grunt Tasks

Now that the project is created, you have 3 simple Grunt commands available:

grunt serve   #This will run a development server with watch & livereload enabled.
grunt test    #Run local unit tests.
grunt build   #Places a fully optimized (minified, concatenated, and more) in /dist

When grunt serve is running, any changed javascript files will be linted using JSHint as well as have their appropriate unit tests executed. Only the unit tests that correspond to the changed file will be run. This allows for an efficient test driven workflow.

Yeoman Subgenerators

There are a set of subgenerators to initialize empty Angular components. Each of these generators will:

Create one or more skeleton files (javascript, LESS, html, spec etc) for the component type.
Update index.html and add the necessary script tags.
Update app.less and add the @import as needed.
For partials, update the app.js, adding the necessary route call if a route was entered in the generator prompts.

There are generators for directive,partial,service, filter, and module.

Running a generator:

yo cc-angular:directive my-awesome-directive
yo cc-angular:partial my-partial
yo cc-angular:service my-service
yo cc-angular:filter my-filter
yo cc-angular:module my-module

The name paramater passed (i.e. 'my-awesome-directive') will be used as the file names. The generators will derive appropriate class names from this parameter (ex. 'my-awesome-directive' will convert to a class name of 'MyAwesomeDirective'). Each sub-generator will ask for the folder in which to create the new skeleton files. You may override the default folder for each sub-generator in the .yo-rc.json file.

Subgenerators are also customizable. Please read CUSTOMIZING.md for details.

Submodules

Submodules allow you to more explicitly separate parts of your application. Use the yo cc-angular:module my-module command and specify a new subdirectory to place the module into. Once you've created a submodule, running other subgenerators will now prompt you to select the module in which to place the new component. Also submodules have the appCore.module as dependency, because this module manages all 3thrd party dependencies

Preconfigured Libraries

The new app will have a handful of preconfigured libraries included. This includes Angular 1.3, Bootstrap 3, AngularUI Utils, FontAwesome 4, JQuery 2, Underscore 1.7, LESS 1.6, and Moment 2.5. You may of course add to or remove any of these libraries. But the work to integrate them into the app and into the build process has already been done for you.

Build Process

The project will include a ready-made Grunt build that will:

Build all the LESS files into one minified CSS file.
Uses grunt-angular-templates to turn all your partials into Javascript.
Uses grunt-ng-annotate to preprocess all Angular injectable methods and make them minification safe. Thus you don't have to use the array syntax.
Concatenates and minifies all Javascript into one file.
Replaces all appropriate script references in index.html with the minified CSS and JS files.
(Optionally) Minifies any images in /img.
Minifies the index.html.
Copies any extra files necessary for a distributable build (ex. Font-Awesome font files, etc).

The resulting build loads only a few highly compressed files.

The build process uses grunt-dom-munger to pull script references from the index.html. This means that your index.html is the single source of truth about what makes up your app. Adding a new library, new controller, new directive, etc does not require that you update the build file. Also the order of the scripts in your index.html will be maintained when they're concatenated.

Importantly, grunt-dom-munger uses CSS attribute selectors to manage the parsing of the script and link tags. Its very easy to exclude certain scripts or stylesheets from the concatenated files. This is often the case if you're using a CDN. This can also be used to prevent certain development scripts from being included in the final build.

To prevent a script or stylesheet from being included in concatenation, put a data-concat="false" attribute on the link or script tag. This is currently applied for the livereload.js and less.js script tags.
To prevent a script or link tag from being removed from the finalized index.html, use a data-remove="false" attribute.

E2E Testing

The generator comes with E2E tests in Gherkin, compiled to JS with cucumber.js. This makes it easy to elaborate these tests as part of the "feature contract" together with a non tech person (product owner, customer...).

cc-angular generates .feature files for partial with a route and puts it in the same directory as the partial file. The step defninitions should be in a sub folder step_definitions of the partial folder, because this way, the whole module contains all files needed to be placed in another app created with cc-angular.

Naming convention for step files: PARTIALNAME.steps.js

Thanks

Thanks to leanovate.de I'm able to spend 10 - 15% of my time to work on open source projects. Leanovate rocks!

Release History

04/28/15 - v1.0.3 - fixed "adding partials to root module
04/01/15 - v1.0.2 - fixed wrong template-url for directive
03/25/15 - v1.0.1 - fixed bug in logger.js
03/12/15 - v1.0.0 - fixed missing angular param in closure in some files
03/04/15 - v0.9.14 - bugfix for missing step files for e2e tests, step-file change triggers feature test
03/02/15 - v0.9.13 - html5 mode enabled, less compiling in watch instead of browser based compiling, reload of css only on less change
03/02/15 - v0.9.12 - switched to Gherkin / cucumber.js for E2E tests, some bug fixes, added route-helper
02/10/15 - v0.9.11 - removed bindonce, because of native support for one time bindings since 1.3
02/09/15 - v0.9.8 - moved src/_bc to bower_components for a clearer separation of third party and own code
02/09/15 - v0.9.6 - included bindonce, some more styleguide compliance, using logger and exception handler from john papa, coverage report
02/04/15 - v0.9.1 - now "reasonably tested" ;-), fixed some "src dir" - bugs
02/04/15 - v0.9.0 - fairly tested fork of cg-angular with all the changes mentioned above