chore: add config comments (angular#1082)

filipesilva · web-flow · commit 1c5cd9befdaa · 2016-06-14T19:37:15.000+01:00
diff --git 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
@@ -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
@@ -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
@@ -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
+
 /// <reference path="<%= refToTypings %>/typings/browser.d.ts" />
 <% 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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');
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# http://editorconfig.org`
	`1`	`+# Editor configuration, see http://editorconfig.org`
`2`	`2`	`root = true`
`3`	`3`
`4`	`4`	`[*]`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+// Test shim for Karma, needed to load files via SystemJS`
	`2`	`+`
`1`	`3`	`/global jasmine, __karma__, window/`
`2`	`4`	`Error.stackTraceLimit = Infinity;`
`3`	`5`	`jasmine.DEFAULT_TIMEOUT_INTERVAL = 1000;`