Add support for type checked rules.

panuhorsmalahti · Aug 2, 2016 · da6024a · da6024a · alexeagle · Sep 21, 2016
1 parent cc1e597
commit da6024a
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -152,6 +152,20 @@ npm install tslint@next
 }));
 ```
 
+Type checked rules
+------------------
+
+Type checked rules require a TypeScript program object to be provided to the linter in the options. For more information see tslint documentation.
+
+```javascript
+var gulpTslint = require("gulp-tslint");
+var tslint = require("tslint");
+var program = tslint.createProgram("./tsconfig.json");
+
+// ...
+.pipe(gulpTslint({ program }))
+```
+
 All default tslint options
 --------------------------
 
@@ -161,7 +175,8 @@ const tslintOptions = {
     formatter: "prose",
     formattersDirectory: null,
     rulesDirectory: null,
-    tslint: null
+    tslint: null,
+    program: null
 };
 ```
 

diff --git a/gulpfile.js b/gulpfile.js
@@ -1,14 +1,19 @@
 var gulp = require("gulp");
-var tslint = require("./index");
+var gulpTslint = require("./index");
+var tslint = require("tslint");
 var ts = require("gulp-typescript");
 var tsProject = ts.createProject("tsconfig.json");
 
+// To enable rules that work with the type checker
+var program = tslint.createProgram("./tsconfig.json");
+
 gulp.task("default", function() {
     var tsResult = tsProject.src()
-        .pipe(tslint({
-            formatter: "prose"
+        .pipe(gulpTslint({
+            formatter: "prose",
+            program: program
         }))
-        .pipe(tslint.report({
+        .pipe(gulpTslint.report({
             emitError: false
         }))
         .pipe(ts(tsProject));

diff --git a/index.d.ts b/index.d.ts
@@ -1,9 +1,10 @@
 export interface PluginOptions {
     configuration?: any;
-    formatter?: string | Function;
+    formatter?: string;
     formattersDirectory?: string;
     rulesDirectory?: string;
     tslint?: any;
+    program?: any;
 }
 export interface ReportOptions {
     emitError?: boolean;

diff --git a/index.js b/index.js
@@ -90,6 +90,7 @@ var tslintPlugin = function (pluginOptions) {
             configuration: pluginOptions.configuration,
             formatter: pluginOptions.formatter || "prose",
             formattersDirectory: pluginOptions.formattersDirectory || null,
+            program: pluginOptions.program || null,
             rulesDirectory: pluginOptions.rulesDirectory || null
         };
         var linter = getTslint(pluginOptions);
@@ -99,7 +100,7 @@ var tslintPlugin = function (pluginOptions) {
             // configuration can be a file path or null, if it's unknown
             options.configuration = linter.findConfiguration(pluginOptions.configuration || null, file.path);
         }
-        tslint = new linter(file.relative, file.contents.toString("utf8"), options);
+        tslint = new linter(file.relative, file.contents.toString("utf8"), options, options.program);
         file.tslint = tslint.lint();
         // Pass file
         cb(null, file);

diff --git a/index.ts b/index.ts
@@ -17,6 +17,9 @@ export interface PluginOptions {
     formattersDirectory?: string;
     rulesDirectory?: string;
     tslint?: any;
+
+    // ts.program, used for type checked rules
+    program?: any;
 }
 
 export interface ReportOptions {
@@ -137,6 +140,7 @@ const tslintPlugin = <TslintPlugin> function(pluginOptions?: PluginOptions) {
             configuration: pluginOptions.configuration,
             formatter: pluginOptions.formatter || "prose",
             formattersDirectory: pluginOptions.formattersDirectory || null,
+            program: pluginOptions.program || null,
             rulesDirectory: pluginOptions.rulesDirectory || null
         };
 
@@ -152,7 +156,7 @@ const tslintPlugin = <TslintPlugin> function(pluginOptions?: PluginOptions) {
             );
         }
 
-        tslint = new linter(file.relative, file.contents.toString("utf8"), options);
+        tslint = new linter(file.relative, file.contents.toString("utf8"), options, options.program);
         file.tslint = tslint.lint();
 
         // Pass file

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "gulp-tslint",
   "preferGlobal": false,
-  "version": "6.0.3",
+  "version": "6.1.0",
   "author": "Panu Horsmalahti <panu.horsmalahti@iki.fi>",
   "description": "TypeScript linter Gulp plugin",
   "contributors": [

diff --git a/tslint.json b/tslint.json
@@ -41,6 +41,7 @@
     "no-use-before-declare": true,
     "no-var-keyword": true,
     "object-literal-sort-keys": true,
+    "no-for-in-array": true,
     "one-line": [true,
       "check-open-brace",
       "check-catch",