docs: add example projects

examples/auto/karma.conf.js

@@ -1,80 +1,19 @@
-// Karma configuration
-// Generated on Sat Apr 01 2017 23:17:19 GMT+0300 (שעון קיץ ירושלים)
 
 module.exports = function (config) {
     config.set({
 
-        // base path that will be used to resolve all patterns (eg. files, exclude)
-        basePath: '',
-
-
-        // frameworks to use
-        // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
-        frameworks: [],
-
-
-        // list of files / patterns to load in the browser
         files: [
             'test/**/*.spec.ts'
         ],
 
-
-        // list of files to exclude
-        // exclude: [],
-
-
-        // preprocess matching files before serving them to the browser
-        // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
         preprocessors: {
             'test/**/*.spec.ts': ['tslint']
         },
 
-        // karma-tslint config
-        // https://github.com/yisraelx/karma-tslint
         tslintPreprocessor: {
-            formatter: 'prose',
-            configuration: {
-                rules: {
-                    'no-var-keyword': true,
-                    'no-any': true
-                }
-            }
+            formatter: 'prose'
         },
 
-        // test results reporter to use
-        // 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
-        logLevel: config.LOG_DEBUG,
-
-
-        // enable / disable watching file and executing tests whenever any file changes
-        autoWatch: false,
-
-
-        // start these browsers
-        // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
-        browsers: [],
-
-
-        // Continuous Integration mode
-        // if true, Karma captures browsers, runs the tests and exits
-        singleRun: true,
-
-        // Concurrency level
-        // how many browser should be started simultaneous
-        concurrency: Infinity
+        logLevel: config.LOG_DEBUG
     })
 };

examples/auto/package.json

@@ -1,12 +1,12 @@
 {
-  "name": "karma-tslint-example",
+  "name": "karma-tslint-auto-example",
   "version": "0.0.1",
   "scripts": {
     "test": "karma start"
   },
   "devDependencies": {
-    "karma": "^1.5.0",
-    "karma-tslint": "file:///D:\\applications\\karma-tslint",
-    "tslint": "^5.0.0"
+    "karma": "*",
+    "karma-tslint": "../../",
+    "tslint": "*"
   }
 }

examples/auto/test/tslint.json

@@ -0,0 +1,6 @@
+{
+  "rules": {
+    "no-var-keyword": true,
+    "no-any": true
+  }
+}

examples/default/karma.conf.js

@@ -11,8 +11,10 @@ module.exports = function (config) {
         },
 
         tslintPreprocessor: {
-            formatter: 'prose'
-        }
+            formatter: 'verbose',
+            configuration: 'default'
+        },
 
+        logLevel: config.LOG_DEBUG,
     })
 };

examples/default/package.json

@@ -1,12 +1,12 @@
 {
-  "name": "karma-tslint-auto-example",
+  "name": "karma-tslint-default-example",
   "version": "0.0.1",
   "scripts": {
     "test": "karma start"
   },
   "devDependencies": {
-    "karma": "^1.5.0",
+    "karma": "*",
     "karma-tslint": "../../",
-    "tslint": "^5.0.0"
+    "tslint": "*"
   }
 }

examples/object/karma.conf.js

@@ -11,8 +11,13 @@ module.exports = function (config) {
         },
 
         tslintPreprocessor: {
-            formatter: 'verbose',
-            configuration: 'default'
+            formatter: 'vso',
+            configuration: {
+                rules: {
+                    'no-var-keyword': true,
+                    'no-any': true
+                }
+            }
         },
 
         logLevel: config.LOG_DEBUG,

examples/object/package.json

@@ -1,12 +1,12 @@
 {
-  "name": "karma-tslint-default-example",
+  "name": "karma-tslint-object-example",
   "version": "0.0.1",
   "scripts": {
     "test": "karma start"
   },
   "devDependencies": {
-    "karma": "^1.5.0",
+    "karma": "*",
     "karma-tslint": "../../",
-    "tslint": "^5.0.0"
+    "tslint": "*"
   }
 }

examples/path/karma.conf.js

@@ -11,13 +11,8 @@ module.exports = function (config) {
         },
 
         tslintPreprocessor: {
-            formatter: 'vso',
-            configuration: {
-                rules: {
-                    'no-var-keyword': true,
-                    'no-any': true
-                }
-            }
+            formatter: 'pmd',
+            configuration: './config/tslint-config.json'
         },
 
         logLevel: config.LOG_DEBUG,

examples/path/package.json

@@ -1,12 +1,12 @@
 {
-  "name": "karma-tslint-object-example",
+  "name": "karma-tslint-path-example",
   "version": "0.0.1",
   "scripts": {
     "test": "karma start"
   },
   "devDependencies": {
-    "karma": "^1.5.0",
+    "karma": "*",
     "karma-tslint": "../../",
-    "tslint": "^5.0.0"
+    "tslint": "*"
   }
 }