style(init): reformat the config templates

joshski · Dec 8, 2013 · b500f94 · b500f94
1 parent 29f5cf2
commit b500f94
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 29 deletions.
diff --git a/config.tpl.coffee b/config.tpl.coffee
@@ -4,17 +4,21 @@
 module.exports = (config) ->
   config.set
 
-    # base path, that will be used to resolve all patterns, eg. files, exclude
+    # base path that will be used to resolve all patterns (eg. files, exclude)
     basePath: '%BASE_PATH%'
 
+
     # frameworks to use
+    # available frameworks: https://npmjs.org/browse/keyword/karma-adapter
     frameworks: [%FRAMEWORKS%]
 
+
     # list of files / patterns to load in the browser
     files: [
       %FILES%
     ]
 
+
     # list of files to exclude
     exclude: [
       %EXCLUDE%
@@ -27,35 +31,38 @@ module.exports = (config) ->
 
 
     # test results reporter to use
-    # possible values: 'dots', 'progress', 'junit', 'growl', 'coverage'
+    # possible values: 'dots', 'progress'
+    # available reporters: https://npmjs.org/browse/keyword/karma-reporter
     reporters: ['progress']
 
+
     # web server port
     port: 9876
 
+
     # enable / disable colors in the output (reporters and logs)
     colors: true
 
+
     # level of logging
-    # possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
+    # possible values:
+    # - config.LOG_DISABLE
+    # - config.LOG_ERROR
+    # - config.LOG_WARN
+    # - config.LOG_INFO
+    # - config.LOG_DEBUG
     logLevel: config.LOG_INFO
 
+
     # enable / disable watching file and executing tests whenever any file changes
     autoWatch: %AUTO_WATCH%
 
-    # Start these browsers, currently available:
-    # - Chrome
-    # - ChromeCanary
-    # - Firefox
-    # - Opera (has to be installed with `npm install karma-opera-launcher`)
-    # - Safari (only Mac; has to be installed with `npm install karma-safari-launcher`)
-    # - PhantomJS
-    # - IE (only Windows; has to be installed with `npm install karma-ie-launcher`)
+
+    # satart these browsers
+    # available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
     browsers: [%BROWSERS%]
 
-    # If browser does not capture in given timeout [ms], kill it
-    captureTimeout: 60000
 
     # Continuous Integration mode
-    # if true, it capture browsers, run tests and exit
+    # if true, Karma captures browsers, runs the tests and exits
     singleRun: false
diff --git a/config.tpl.js b/config.tpl.js
@@ -4,11 +4,12 @@
 module.exports = function(config) {
   config.set({
 
-    // base path, that will be used to resolve files and exclude
+    // base path that will be used to resolve all patterns (eg. files, exclude)
     basePath: '%BASE_PATH%',
 
 
     // frameworks to use
+    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
     frameworks: [%FRAMEWORKS%],
 
 
@@ -30,7 +31,8 @@ module.exports = function(config) {
 
 
     // test results reporter to use
-    // possible values: 'dots', 'progress', 'junit', 'growl', 'coverage'
+    // possible values: 'dots', 'progress'
+    // available reporters: https://npmjs.org/browse/keyword/karma-reporter
     reporters: ['progress'],
 
 
@@ -51,23 +53,13 @@ module.exports = function(config) {
     autoWatch: %AUTO_WATCH%,
 
 
-    // Start these browsers, currently available:
-    // - Chrome
-    // - ChromeCanary
-    // - Firefox
-    // - Opera (has to be installed with `npm install karma-opera-launcher`)
-    // - Safari (only Mac; has to be installed with `npm install karma-safari-launcher`)
-    // - PhantomJS
-    // - IE (only Windows; has to be installed with `npm install karma-ie-launcher`)
+    // start these browsers
+    // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
     browsers: [%BROWSERS%],
 
 
-    // If browser does not capture in given timeout [ms], kill it
-    captureTimeout: 60000,
-
-
     // Continuous Integration mode
-    // if true, it capture browsers, run tests and exit
+    // if true, Karma captures browsers, runs the tests and exits
     singleRun: false
   });
 };