diff --git a/addon/ng2/blueprints/ng2/files/.editorconfig b/addon/ng2/blueprints/ng2/files/.editorconfig index 20380c701c90..f3526162d642 100644 --- a/addon/ng2/blueprints/ng2/files/.editorconfig +++ b/addon/ng2/blueprints/ng2/files/.editorconfig @@ -1,4 +1,4 @@ -# http://editorconfig.org +# Editor configuration, see http://editorconfig.org root = true [*] diff --git a/addon/ng2/blueprints/ng2/files/README.md b/addon/ng2/blueprints/ng2/files/README.md index 9113dfdf9c64..33838bbe3127 100755 --- a/addon/ng2/blueprints/ng2/files/README.md +++ b/addon/ng2/blueprints/ng2/files/README.md @@ -15,11 +15,11 @@ Run `ng build` to build the project. The build artifacts will be stored in the ` ## Running unit tests -Run `ng test` to execute the unit tests via Karma. +Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). ## Running end-to-end tests -Run `ng e2e` to execute the end-to-end tests via Protractor. +Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/). Before running the tests make sure you are serving the app via `ng serve`. ## Deploying to Github Pages diff --git a/addon/ng2/blueprints/ng2/files/__path__/system-config.ts b/addon/ng2/blueprints/ng2/files/__path__/system-config.ts index cc549606a2a4..36e6f9403836 100644 --- a/addon/ng2/blueprints/ng2/files/__path__/system-config.ts +++ b/addon/ng2/blueprints/ng2/files/__path__/system-config.ts @@ -1,3 +1,7 @@ +// SystemJS configuration file, see links for more information +// https://github.com/systemjs/systemjs +// https://github.com/systemjs/systemjs/blob/master/docs/config-api.md + /*********************************************************************************************** * User Configuration. **********************************************************************************************/ diff --git a/addon/ng2/blueprints/ng2/files/__path__/typings.d.ts b/addon/ng2/blueprints/ng2/files/__path__/typings.d.ts index df29a85ca4a3..a58a428505dd 100644 --- a/addon/ng2/blueprints/ng2/files/__path__/typings.d.ts +++ b/addon/ng2/blueprints/ng2/files/__path__/typings.d.ts @@ -1,2 +1,6 @@ +// Typings reference file, see links for more information +// https://github.com/typings/typings +// https://www.typescriptlang.org/docs/handbook/writing-declaration-files.html + /// <% if(!isMobile) { %>declare var module: { id: string };<% } %> diff --git a/addon/ng2/blueprints/ng2/files/angular-cli-build.js b/addon/ng2/blueprints/ng2/files/angular-cli-build.js index daa7a4b54124..bd905df03188 100644 --- a/addon/ng2/blueprints/ng2/files/angular-cli-build.js +++ b/addon/ng2/blueprints/ng2/files/angular-cli-build.js @@ -1,3 +1,7 @@ +// Angular-CLI build configuration +// This file lists all the node_modules files that will be used in a build +// Also see https://github.com/angular/angular-cli/wiki/3rd-party-libs + /* global require, module */ var Angular2App = require('angular-cli/lib/broccoli/angular2-app'); diff --git a/addon/ng2/blueprints/ng2/files/config/environment.js b/addon/ng2/blueprints/ng2/files/config/environment.js index 4fa28880da9f..bb2170b8b1f7 100644 --- a/addon/ng2/blueprints/ng2/files/config/environment.js +++ b/addon/ng2/blueprints/ng2/files/config/environment.js @@ -1,3 +1,6 @@ +// Angular-CLI server configuration +// Unrelated to environment.dev|prod.ts + /* jshint node: true */ module.exports = function(environment) { diff --git a/addon/ng2/blueprints/ng2/files/config/karma-test-shim.js b/addon/ng2/blueprints/ng2/files/config/karma-test-shim.js index 05ffa152eb4d..3bbadb4952f8 100644 --- a/addon/ng2/blueprints/ng2/files/config/karma-test-shim.js +++ b/addon/ng2/blueprints/ng2/files/config/karma-test-shim.js @@ -1,3 +1,5 @@ +// Test shim for Karma, needed to load files via SystemJS + /*global jasmine, __karma__, window*/ Error.stackTraceLimit = Infinity; jasmine.DEFAULT_TIMEOUT_INTERVAL = 1000; diff --git a/addon/ng2/blueprints/ng2/files/config/karma.conf.js b/addon/ng2/blueprints/ng2/files/config/karma.conf.js index 91485a627372..ef294ceea32f 100644 --- a/addon/ng2/blueprints/ng2/files/config/karma.conf.js +++ b/addon/ng2/blueprints/ng2/files/config/karma.conf.js @@ -1,3 +1,6 @@ +// Karma configuration file, see link for more information +// https://karma-runner.github.io/0.13/config/configuration-file.html + module.exports = function (config) { config.set({ basePath: '..', diff --git a/addon/ng2/blueprints/ng2/files/config/protractor.conf.js b/addon/ng2/blueprints/ng2/files/config/protractor.conf.js index 39dd0ee64cc5..3019efc23d5b 100644 --- a/addon/ng2/blueprints/ng2/files/config/protractor.conf.js +++ b/addon/ng2/blueprints/ng2/files/config/protractor.conf.js @@ -1,3 +1,6 @@ +// Protractor configuration file, see link for more information +// https://github.com/angular/protractor/blob/master/docs/referenceConf.js + /*global jasmine */ var SpecReporter = require('jasmine-spec-reporter');