Setup tslint on build and test to enforce good practices and consistent style.

Matt Mazzola · Matt Mazzola · commit b76364f13c93 · 2016-08-22T15:09:11.000-07:00
diff --git a/gulpfile.js b/gulpfile.js
@@ -4,7 +4,6 @@ var ghPages = require('gulp-gh-pages'),
     rename = require('gulp-rename'),
     concat = require('gulp-concat'),
     uglify = require('gulp-uglify'),
-    jshint = require('gulp-jshint'),
     replace = require('gulp-replace'),
     sourcemaps = require('gulp-sourcemaps'),
     tslint = require("gulp-tslint"),
@@ -86,6 +85,7 @@ gulp.task('lint', 'Lints all files', function (done) {
 
 gulp.task('test', 'Runs all tests', function (done) {
     runSequence(
+        'lint:ts',
         'config',
         'compile:spec',
         'test:js',
@@ -95,7 +95,7 @@ gulp.task('test', 'Runs all tests', function (done) {
 
 gulp.task('build', 'Runs a full build', function (done) {
     runSequence(
-        'lint',
+        'lint:ts',
         'clean',
         'config',
         ['compile:ts', 'compile:dts'],
@@ -142,8 +142,10 @@ gulp.task('clean:docs', 'Clean docs directory', function () {
 
 gulp.task('lint:ts', 'Lints all TypeScript', function() {
     return gulp.src(['./src/**/*.ts', './test/**/*.ts'])
-        .pipe(tslint())
-        .pipe(tslint.report("verbose"));
+        .pipe(tslint({
+            formatter: "verbose"
+        }))
+        .pipe(tslint.report());
 });
 
 gulp.task('min:js', 'Creates minified JavaScript file', function() {
@@ -181,7 +183,6 @@ gulp.task('compile:dts', 'Generate dts files from modules', function () {
         .pipe(gulp.dest('./dist'));
 });
 
-
 gulp.task('compile:spec', 'Compile spec tests', function () {
     return gulp.src(['./test/test.spec.ts'])
         .pipe(webpackStream(webpackTestConfig))
diff --git a/src/util.ts b/src/util.ts
@@ -7,7 +7,7 @@
  * @param {string} eventName
  * @param {*} eventData
  */
-export function raiseCustomEvent(element: HTMLElement, eventName: string, eventData: any):void {
+export function raiseCustomEvent(element: HTMLElement, eventName: string, eventData: any): void {
     let customEvent;
     if (typeof CustomEvent === 'function') {
         customEvent = new CustomEvent(eventName, {
diff --git a/test/utility/mockWpmp.ts b/test/utility/mockWpmp.ts
@@ -21,7 +21,7 @@ export const spyWpmp = {
   stop: jasmine.createSpy("stop"),
 
   onMessageReceived(event) {
-    let message:any = event.data;
+    let message: any = event.data;
 
     const handled = spyWpmp.handlers.some(handler => {
         if(handler.test(message)) {
diff --git a/tsconfig.json b/tsconfig.json
@@ -16,6 +16,7 @@
         "typings/index.d.ts",
         "demo",
         "dist",
+        "docs",
         "test",
         "tmp",
         ".publish"
diff --git a/tslint.json b/tslint.json
@@ -0,0 +1,26 @@
+{
+  "extends": "tslint:recommended",
+  "rules": {
+    "max-line-length": false,
+    "member-access": false,
+    "no-console": false,
+    "one-line": [
+      "check-whitespace",
+      "check-open-brace"
+    ],
+    "quotemark": [
+      "single",
+      "avoid-escape"
+    ],
+    "trailing-comma": false,
+    "whitespace": [
+      "check-branch",
+      "check-decl",
+      "check-operator",
+      "check-module",
+      "check-seperator",
+      "check-type"
+    ],
+    "object-literal-sort-keys": false
+  }
+}
