lint, tooling, and other misc. changes (#304)

ofrobots · web-flow · commit f13d122718ff · 2017-07-07T15:29:16.000-07:00
* Remove jshint files and devDependency
* Update tslint config. Use typechecked lint. Remove options that are subsumed
  by the compiler now.
* Start shipping type definitions.
* Address newly found lint errors.
* Formatting.
diff --git a/.jshintignore b/.jshintignore
diff --git a/.jshintrc b/.jshintrc
diff --git a/bin/run-test.sh b/bin/run-test.sh
@@ -18,10 +18,6 @@ while true; do
   shift
 done
 
-# Lint
-# TODO: Re-enable this when the transition to Typescript is complete
-# $(npm bin)/jshint . || exit 1
-
 # Get test/coverage command
 counter=0
 function run {
diff --git a/gulpfile.js b/gulpfile.js
@@ -54,10 +54,14 @@ gulp.task('format', () => {
 });
 
 gulp.task('test.check-lint', () => {
+  const program = require('tslint').Linter.createProgram('./tsconfig.json');
   return gulp.src(sources)
-      .pipe(tslint(
-          {configuration: tslintPath, formatter: 'verbose'}))
-      .pipe(tslint.report())
+    .pipe(tslint(
+      {
+        configuration: tslintPath,
+        formatter: 'prose', program
+      }))
+    .pipe(tslint.report())
       .on('warning', onError);
 });
 
diff --git a/package.json b/package.json
@@ -4,6 +4,7 @@
   "author": "Google Inc.",
   "description": "Stackdriver Debug Agent for Node.js",
   "main": "./build/src/index.js",
+  "types": "./build/types/index.d.ts",
   "repository": "googlecloudplatform/cloud-debug-nodejs",
   "keywords": [
     "google",
@@ -41,7 +42,6 @@
     "gulp-tslint": "^8.1.1",
     "gulp-typescript": "^3.1.6",
     "istanbul": "^0.4.1",
-    "jshint": "^2.7.0",
     "merge2": "^1.0.3",
     "mocha": "^3.0.0",
     "nock": "^9.0.0",
@@ -74,6 +74,7 @@
     "CHANGELOG.md",
     "LICENSE",
     "README.md",
-    "build/src"
+    "build/src",
+    "build/types"
   ]
 }
diff --git a/src/agent/sourcemapper.ts b/src/agent/sourcemapper.ts
@@ -34,27 +34,6 @@ export interface MapInfoOutput {
   column?: number;
 }
 
-export function create(
-    sourcemapPaths: string[],
-    callback: (err: Error|null, mapper?: SourceMapper) => void): void {
-  const mapper = new SourceMapper();
-  const callList =
-      Array.prototype.slice.call(sourcemapPaths).map(function(p: string) {
-        return function(cb: (err: Error|null) => void) {
-          processSourcemap(mapper.infoMap_, p, cb);
-        };
-      });
-
-  async.parallelLimit(callList, 10, function(err) {
-    if (err) {
-      return callback(new Error(
-          'An error occurred while processing the sourcemap files' + err));
-    }
-
-    callback(null, mapper);
-  });
-}
-
 /**
  * @param {!Map} infoMap The map that maps input source files to
  *  SourceMapConsumer objects that are used to calculate mapping information
@@ -236,3 +215,24 @@ export class SourceMapper {
     };
   }
 }
+
+export function create(
+    sourcemapPaths: string[],
+    callback: (err: Error|null, mapper?: SourceMapper) => void): void {
+  const mapper = new SourceMapper();
+  const callList =
+      Array.prototype.slice.call(sourcemapPaths).map(function(p: string) {
+        return function(cb: (err: Error|null) => void) {
+          processSourcemap(mapper.infoMap_, p, cb);
+        };
+      });
+
+  async.parallelLimit(callList, 10, function(err) {
+    if (err) {
+      return callback(new Error(
+          'An error occurred while processing the sourcemap files' + err));
+    }
+
+    callback(null, mapper);
+  });
+}
diff --git a/src/agent/state.ts b/src/agent/state.ts
@@ -40,19 +40,6 @@ const NATIVE_PROPERTY_MESSAGE_INDEX = 1;
 const GETTER_MESSAGE_INDEX = 2;
 const ARG_LOCAL_LIMIT_MESSAGE_INDEX = 3;
 
-/**
- * Captures the stack and current execution state.
- *
- * @return an object with stackFrames, variableTable, and
- *         evaluatedExpressions fields
- */
-export function capture(
-    execState: v8Types.ExecutionState, expressions: string[],
-    config: DebugAgentConfig, v8: v8Types.Debug): apiTypes.Breakpoint {
-  return (new StateResolver(execState, expressions, config, v8)).capture_();
-}
-
-
 /**
  * Checks that the provided expressions will not have side effects and
  * then evaluates the expression in the current execution context.
@@ -582,3 +569,15 @@ class StateResolver {
 export function testAssert(): void {
   assert.equal(0, 1);
 }
+
+/**
+ * Captures the stack and current execution state.
+ *
+ * @return an object with stackFrames, variableTable, and
+ *         evaluatedExpressions fields
+ */
+export function capture(
+    execState: v8Types.ExecutionState, expressions: string[],
+    config: DebugAgentConfig, v8: v8Types.Debug): apiTypes.Breakpoint {
+  return (new StateResolver(execState, expressions, config, v8)).capture_();
+}
diff --git a/src/agent/v8debugapi.ts b/src/agent/v8debugapi.ts
@@ -67,12 +67,15 @@ export interface V8DebugApi {
   numListeners_: () => number;
 }
 
-interface BreakPointData {
-  v8Breakpoint: v8Types.BreakPoint;
-  // TODO: The code in this method assumes this method exists.  Verify that
-  //       is correct.
-  // TODO: Update this so that `null|` is not needed here.
-  compile: null|((text: string) => string);
+class BreakpointData {
+  constructor(
+      public apiBreakpoint: apiTypes.Breakpoint,
+      public v8Breakpoint: v8Types.BreakPoint,
+      public parsedCondition: estree.Node,
+      // TODO: The code in this method assumes that `compile` exists.  Verify
+      // that is correct.
+      // TODO: Update this so that `null|` is not needed for `compile`.
+      public compile: null|((src: string) => string)) {}
 }
 
 /**
@@ -99,7 +102,7 @@ export function create(
   let logger: Logger|null = null;
   let config: DebugAgentConfig|null = null;
   let fileStats: ScanStats|null = null;
-  let breakpoints: {[id: string]: BreakPointData} = {};
+  let breakpoints: {[id: string]: BreakpointData} = {};
   let sourcemapper: SourceMapper|null = null;
   // Entries map breakpoint id to { enabled: <bool>, listener: <function> }
   // TODO: Determine if the listener type is correct
@@ -659,25 +662,6 @@ export function create(
     };  // intentional !!
   }
 
-  class BreakpointData {
-    apiBreakpoint: apiTypes.Breakpoint;
-    v8Breakpoint: v8Types.BreakPoint;
-    parsedCondition: estree.Node;
-    compile: null|((src: string) => string);
-
-    /**
-     * @constructor
-     */
-    constructor(
-        apiBreakpoint: apiTypes.Breakpoint, v8Breakpoint: v8Types.BreakPoint,
-        parsedCondition: estree.Node, compile: null|((src: string) => string)) {
-      this.apiBreakpoint = apiBreakpoint;
-      this.v8Breakpoint = v8Breakpoint;
-      this.parsedCondition = parsedCondition;
-      this.compile = compile;
-    }
-  }
-
   function setErrorStatusAndCallback(
       fn: (err: Error|null) => void, breakpoint: apiTypes.Breakpoint,
       refersTo: apiTypes.Reference, message: string): void {
diff --git a/tslint.json b/tslint.json
@@ -7,22 +7,18 @@
     "indent": [true, "spaces"],
     "jsdoc-format": true,
     "label-position": true,
-    "label-undefined": true,
     "no-arg": true,
     "no-conditional-assignment": true,
     "no-construct": true,
     "no-debugger": true,
-    "no-duplicate-key": true,
     "no-duplicate-variable": true,
     "no-empty": true,
     "no-inferrable-types": true,
     "no-internal-module": true,
     "no-shadowed-variable": true,
     "no-switch-case-fall-through": true,
     "no-trailing-whitespace": true,
-    "no-unreachable": true,
     "no-unused-expression": true,
-    "no-unused-variable": true,
     "no-use-before-declare": true,
     "no-var-keyword": true,
     "quotemark": [true, "single"],
