[fix] running lint as a seperate CI task and fixes all errors to ensure CI passes

.eslintrc.js

@@ -13,6 +13,7 @@ module.exports = {
   rules: {
     'no-var': 'error',
     'no-console': 'off',
+    'no-unused-vars': 'off', // this is turned off because of the lack of scope analysis on imported types (https://github.com/typescript-eslint/typescript-eslint/issues/1856)
     'no-process-exit': 'off',
     'object-shorthand': 'error',
     'prettier/prettier': ['error', require('./prettier.config')],

.github/workflows/nodejs.yml

@@ -4,14 +4,14 @@ on:
   pull_request:
   push:
     # filtering branches here, prevents duplicate builds from pull_request and push
-    branches: 
+    branches:
       - master
       - 'v*'
     # always run CI for tags
     tags:
       - '*'
-      
-  # early issue detection, run CI weekly on Sundays  
+
+  # early issue detection, run CI weekly on Sundays
   schedule:
   - cron:  '0 6 * * 0'
 
@@ -26,17 +26,20 @@ jobs:
 
     steps:
     - uses: actions/checkout@v1
-    
+
     - name: Use Node.js ${{ matrix.node_version }}
       uses: actions/setup-node@v1
       with:
         version: ${{ matrix.node_version }}
-  
+
     - name:  install yarn
       run: npm install -g yarn cross-env
 
     - name: install dependencies
       run: yarn install --frozen-lockfile
 
+    - name: lint
+      run: yarn lint
+
     - name: test
-      run: cross-env CI=true yarn test
+      run: cross-env CI=true yarn test

lib/builder.ts

@@ -339,7 +339,9 @@ class Builder extends EventEmitter {
 
     for (let nodeWrapper of this._nodeWrappers.values()) {
       if (nodeWrapper.nodeInfo.nodeType === 'transform') {
-        (nodeWrapper as TransformNodeWrapper).inputPaths = nodeWrapper.inputNodeWrappers.map((nw: any) => nw.outputPath);
+        (nodeWrapper as TransformNodeWrapper).inputPaths = nodeWrapper.inputNodeWrappers.map(
+          (nw: any) => nw.outputPath
+        );
         nodeWrapper.outputPath = this.mkTmpDir(nodeWrapper, 'out');
 
         if (nodeWrapper.nodeInfo.needsCache) {

lib/dummy-watcher.ts

@@ -4,7 +4,7 @@ class Watcher extends EventEmitter {
   builder: any;
   currentBuild: any;
   _lifetimeDeferred: {
-    promise?: Promise<void>,
+    promise?: Promise<void>;
     resolve?: (value?: any) => void;
     reject?: (error?: any) => void;
   };
@@ -34,6 +34,6 @@ class Watcher extends EventEmitter {
       this._lifetimeDeferred.resolve();
     }
   }
-};
+}
 
-export = Watcher;
+export = Watcher;

lib/errors/build.ts

@@ -4,7 +4,7 @@ import wrapPrimitiveErrors from '../utils/wrap-primitive-errors';
 
 interface BroccoliPayloadError {
   originalError: Error;
-  originalMessage: string,
+  originalMessage: string;
   nodeId: number;
   nodeLabel: string;
   nodeName: string;
@@ -15,7 +15,7 @@ interface BroccoliPayloadError {
     treeDir: string;
     line: number;
     column: number;
-  },
+  };
 }
 
 export default class BuildError extends BuilderError {
@@ -87,4 +87,4 @@ export default class BuildError extends BuilderError {
       },
     };
   }
-};
+}

lib/errors/builder.ts

@@ -11,4 +11,4 @@ export default class BuilderError extends Error {
 
     this.isBuilderError = true;
   }
-};
+}

lib/errors/cancelation.ts

@@ -13,4 +13,4 @@ export default class Cancelation extends Error {
     this.isCancelation = true;
     this.isSilent = true;
   }
-};
+}

lib/errors/cli.ts

@@ -1,2 +1,2 @@
 // Base class for cli errors
-export default class CliError extends Error {};
+export default class CliError extends Error {}

lib/errors/node-setup.ts

@@ -19,4 +19,4 @@ export default class NodeSetupError extends BuilderError {
     // The stack will have the original exception name, but that's OK
     this.stack = originalError.stack;
   }
-};
+}

lib/index.d.ts

@@ -1,9 +1,9 @@
 export interface BrocfileOptions {
-    /**
-     * Environment setting. Default: development
-     * This option is set by the --environment/--prod/--dev CLI argument.
-     * This option can be used to conditionally affect a build pipeline in order to load different plugins for
-     * development/production/testing
-     */
-    env: string;
+  /**
+   * Environment setting. Default: development
+   * This option is set by the --environment/--prod/--dev CLI argument.
+   * This option can be used to conditionally affect a build pipeline in order to load different plugins for
+   * development/production/testing
+   */
+  env: string;
 }

lib/load_brocfile.ts

@@ -40,6 +40,7 @@ function requireBrocfile(brocfilePath: string) {
   }
 
   // ESM `export default X` is represented as module.exports = { default: X }
+  // eslint-disable-next-line no-prototype-builtins
   if (brocfile !== null && typeof brocfile === 'object' && brocfile.hasOwnProperty('default')) {
     brocfile = brocfile.default;
   }

lib/middleware.ts

@@ -33,8 +33,14 @@ interface MiddlewareOptions {
 // Supported options:
 //   autoIndex (default: true) - set to false to disable directory listings
 //   liveReloadPath - LiveReload script URL for error pages
-function handleRequest(outputPath: string, request: any, response: any, next: any, options: MiddlewareOptions) {
-  const urlObj = url.parse(request.url);
+function handleRequest(
+  outputPath: string,
+  request: any,
+  response: any,
+  next: any,
+  options: MiddlewareOptions
+) {
+  const urlObj = url.URL(request.url);
   let pathname = urlObj.pathname || '';
   let filename: string, stat, lastModified, buffer;
 
@@ -87,21 +93,21 @@ function handleRequest(outputPath: string, request: any, response: any, next: an
       const context = {
         url: request.url,
         files: fs
-        .readdirSync(filename)
-        .sort()
-        .map(child => {
-          const stat = fs.statSync(path.join(filename, child)),
-            isDir = stat.isDirectory();
-          return {
-            href: child + (isDir ? '/' : ''),
-            type: isDir
-              ? 'dir'
-              : path
-              .extname(child)
-              .replace('.', '')
-              .toLowerCase(),
-          };
-        }),
+          .readdirSync(filename)
+          .sort()
+          .map(child => {
+            const stat = fs.statSync(path.join(filename, child)),
+              isDir = stat.isDirectory();
+            return {
+              href: child + (isDir ? '/' : ''),
+              type: isDir
+                ? 'dir'
+                : path
+                    .extname(child)
+                    .replace('.', '')
+                    .toLowerCase(),
+            };
+          }),
         liveReloadPath: options.liveReloadPath,
       };
       response.setHeader('Content-Type', 'text/html; charset=utf-8');

lib/server.ts

@@ -24,7 +24,16 @@ class Server extends EventEmitter {
   _started: boolean;
   ui: any;
 
-  constructor(watcher: Watcher, host: string, port: string, connect = require('connect'), ui: UI, ssl: boolean, sslKey: string, sslCert: string) {
+  constructor(
+    watcher: Watcher,
+    host: string,
+    port: string,
+    connect = require('connect'),
+    ui: UI,
+    ssl: boolean,
+    sslKey: string,
+    sslCert: string
+  ) {
     super();
 
     this._watcher = watcher;
@@ -158,9 +167,9 @@ function serve(
       ui.writeError(err);
       _process.exit(1);
     });
-};
+}
 
 export = {
   Server,
-  serve
-}
+  serve,
+};

lib/utils/bind-file-event.ts

@@ -18,4 +18,4 @@ export default function bindFileEvent(
     node.revise();
     adapter.emit('change', event, filepath, root);
   });
-}
+}

lib/utils/calculate-summary.ts

@@ -33,12 +33,12 @@ export default function calculateSummary(tree: HeimdallNode) {
   let totalTime = 0;
   let nodes: BaseNode[] = [];
   let groupedNodes: GroupedNode[] = [];
-  let nodesGroupedByName: { [key: string]: GroupedNode; } = {};
+  let nodesGroupedByName: { [key: string]: GroupedNode } = {};
 
   // calculate times
-  tree.visitPostOrder((node) => {
+  tree.visitPostOrder(node => {
     let nonbroccoliChildrenTime = 0;
-    node.forEachChild((childNode) => {
+    node.forEachChild(childNode => {
       // subsume non-broccoli nodes as their ancestor broccoli nodes'
       // broccoliSelfTime
       if (!childNode.id.broccoliNode) {
@@ -89,4 +89,4 @@ export default function calculateSummary(tree: HeimdallNode) {
     nodes,
     groupedNodes,
   };
-};
+}

lib/utils/filter-map.ts

@@ -6,4 +6,4 @@ export default function filterMap<T>(iterator: Iterable<T>, cb: (entry: T) => bo
     }
   }
   return result;
-};
+}

lib/utils/slow-trees.ts

@@ -60,7 +60,7 @@ export default function printSlowNodes(tree: HeimdallNode, factor: number, ui: U
     ui.writeLine('Error when printing slow nodes', 'ERROR');
     ui.writeError(e);
   }
-};
+}
 
 function pad(str: string, len: number, char?: string, dir?: 'left' | 'both') {
   if (!char) {

lib/utils/undefined-to-null.ts

@@ -1,9 +1,10 @@
 // Replace all `undefined` values with `null`, so that they show up in JSON output
 export default function undefinedToNull(obj: { [index: string]: any }) {
   for (const key in obj) {
+    // eslint-disable-next-line no-prototype-builtins
     if (obj.hasOwnProperty(key) && obj[key] === undefined) {
       obj[key] = null;
     }
   }
   return obj;
-};
+}

lib/utils/wrap-primitive-errors.ts

@@ -6,4 +6,4 @@ export default function wrapPrimitiveErrors(err: Error): Error {
     // that the stack trace is not useful, or even set the .stack to null.
     return new Error(err + '');
   }
-};
+}

lib/watcher.ts

@@ -22,7 +22,7 @@ class Watcher extends EventEmitter {
   _ready: boolean;
   _quittingPromise: Promise<void> | null;
   _lifetime: {
-    promise?: Promise<void>,
+    promise?: Promise<void>;
     resolve?: (value: any) => void;
     reject?: (error: any) => void;
   } | null;

lib/watcher_adapter.ts

@@ -67,7 +67,7 @@ class WatcherAdapter extends EventEmitter {
 
   quit() {
     let closing = this.watchers.map(
-      (watcher: sane.Watcher) => 
+      (watcher: sane.Watcher) =>
         new Promise((resolve, reject) =>
           // @ts-ignore
           watcher.close((err: any) => {
@@ -79,6 +79,6 @@ class WatcherAdapter extends EventEmitter {
     this.watchers.length = 0;
     return Promise.all(closing).then(() => {});
   }
-};
+}
 
-export = WatcherAdapter;
+export = WatcherAdapter;

lib/wrappers/node.ts

@@ -48,5 +48,5 @@ export default class NodeWrapper {
 
   nodeInfoToJSON() {
     return {};
-  };
-};
+  }
+}

lib/wrappers/source-node.ts

@@ -41,4 +41,4 @@ export default class SourceNodeWrapper extends NodeWrapper {
       // leave out instantiationStack
     });
   }
-};
+}

lib/wrappers/transform-node.ts

@@ -7,7 +7,7 @@ import { TransformNodeInfo, CallbackObject } from 'broccoli-node-api';
 const logger = require('heimdalljs-logger')('broccoli:transform-node');
 
 export default class TransformNodeWrapper extends NodeWrapper {
-  inputRevisions!: WeakMap<any, { revision: number, changed: boolean }>;
+  inputRevisions!: WeakMap<any, { revision: number; changed: boolean }>;
   callbackObject!: CallbackObject;
   inputPaths!: string[];
   nodeInfo!: TransformNodeInfo;
@@ -69,7 +69,7 @@ export default class TransformNodeWrapper extends NodeWrapper {
 
     if (!this.shouldBuild()) {
       this.buildState.built = false;
-      return // Noop the build since inputs did not change
+      return; // Noop the build since inputs did not change
     }
 
     if (!this.nodeInfo.persistentOutput) {
@@ -100,11 +100,7 @@ export default class TransformNodeWrapper extends NodeWrapper {
     }
 
     if (this.buildState.selfTime >= 100) {
-      logger.debug(
-        `Node build execution time: %ds %dms`,
-        endTime[0],
-        Math.round(endTime[1] / 1e6)
-      );
+      logger.debug(`Node build execution time: %ds %dms`, endTime[0], Math.round(endTime[1] / 1e6));
     }
   }
 
@@ -131,4 +127,4 @@ export default class TransformNodeWrapper extends NodeWrapper {
       // leave out instantiationStack (too long), inputNodes, and callbacks
     });
   }
-};
+}