Run ESLint over our JS files, fix all lints (microsoft#50172)

Author: jakebailey

.eslintignore

@@ -2,3 +2,5 @@
 /tests/**
 /lib/**
 /src/lib/*.generated.d.ts
+/scripts/*.js
+/scripts/eslint/built/**

.eslintrc.json

@@ -13,6 +13,17 @@
     "plugins": [
         "@typescript-eslint", "jsdoc", "no-null", "import"
     ],
+    "overrides": [
+        // By default, the ESLint CLI only looks at .js files. But, it will also look at
+        // any files which are referenced in an override config. Most users of typescript-eslint
+        // get this behavior by default by extending a recommended typescript-eslint config, which 
+        // just so happens to override some core ESLint rules. We don't extend from any config, so
+        // explicitly reference TS files here so the CLI picks them up.
+        //
+        // ESLint in VS Code will lint any opened file (so long as it's not eslintignore'd), so
+        // that will work regardless of the below.
+        { "files": ["*.ts"] }
+    ],
     "rules": {
         "@typescript-eslint/adjacent-overload-signatures": "error",
         "@typescript-eslint/array-type": "error",

.vscode/settings.template.json

@@ -6,7 +6,6 @@
     ],
     "eslint.options": {
         "rulePaths": ["./scripts/eslint/built/rules/"],
-        "extensions": [".ts"]
     },
     // To use the last-known-good (LKG) compiler version:
     // "typescript.tsdk": "lib"

Gulpfile.js

@@ -358,7 +358,6 @@ const eslint = (folder) => async () => {
         "--cache-location", `${folder}/.eslintcache`,
         "--format", formatter,
         "--rulesdir", "scripts/eslint/built/rules",
-        "--ext", ".ts",
     ];
 
     if (cmdLineOptions.fix) {

package-lock.json

@@ -88,6 +88,7 @@
         "typescript": "^4.5.5",
         "vinyl": "latest",
         "vinyl-sourcemaps-apply": "latest",
+        "which": "^2.0.2",
         "xml2js": "^0.4.23"
     },
     "overrides": {

package.json

@@ -7,6 +7,7 @@ module.exports = minimist(process.argv.slice(2), {
     boolean: ["dirty", "light", "colors", "lint", "lkg", "soft", "fix", "failed", "keepFailed", "force", "built"],
     string: ["browser", "tests", "break", "host", "reporter", "stackTraceLimit", "timeout", "shards", "shardId"],
     alias: {
+        /* eslint-disable quote-props */
         "b": "browser",
         "i": ["inspect", "inspect-brk", "break", "debug", "debug-brk"],
         "t": ["tests", "test"],
@@ -16,6 +17,7 @@ module.exports = minimist(process.argv.slice(2), {
         "skippercent": "skipPercent",
         "w": "workers",
         "f": "fix"
+        /* eslint-enable quote-props */
     },
     default: {
         soft: false,

scripts/build/options.js

@@ -1,6 +1,5 @@
 // @ts-check
 const stream = require("stream");
-const Vinyl = require("vinyl");
 const ts = require("../../lib/typescript");
 const fs = require("fs");
 const { base64VLQFormatEncode } = require("./sourcemaps");
@@ -43,13 +42,14 @@ function prepend(data) {
                         sourcesContent: input.sourcesContent
                     };
                 }
+                // eslint-disable-next-line boolean-trivia, no-null/no-null
                 return cb(null, output);
             }
             catch (e) {
                 return cb(e);
             }
         }
-    })
+    });
 }
 exports.prepend = prepend;
 
@@ -59,6 +59,6 @@ exports.prepend = prepend;
 function prependFile(file) {
     const data = typeof file === "string" ? fs.readFileSync(file, "utf8") :
         vinyl => fs.readFileSync(file(vinyl), "utf8");
-    return prepend(data)
+    return prepend(data);
 }
-exports.prependFile = prependFile;
+exports.prependFile = prependFile;

scripts/build/prepend.js

@@ -35,7 +35,7 @@ class ProjectQueue {
     }
 }
 
-const execTsc = (lkg, ...args) =>
+const execTsc = (/** @type {boolean} */ lkg, /** @type {string[]} */ ...args) =>
     exec(process.execPath,
          [resolve(findUpRoot(), lkg ? "./lib/tsc" : "./built/local/tsc"),
           "-b", ...args],
@@ -45,7 +45,7 @@ const projectBuilder = new ProjectQueue((projects, lkg, force) => execTsc(lkg, .
 
 /**
  * @param {string} project
- * @param {object} [options]
+ * @param {object} options
  * @param {boolean} [options.lkg=true]
  * @param {boolean} [options.force=false]
  */
@@ -58,11 +58,11 @@ const projectCleaner = new ProjectQueue((projects, lkg) => execTsc(lkg, "--clean
  */
 exports.cleanProject = (project) => projectCleaner.enqueue(project);
 
-const projectWatcher = new ProjectQueue((projects) => execTsc(true, "--watch", ...projects));
+const projectWatcher = new ProjectQueue((projects) => execTsc(/*lkg*/ true, "--watch", ...projects));
 
 /**
  * @param {string} project
- * @param {object} [options]
+ * @param {object} options
  * @param {boolean} [options.lkg=true]
  */
 exports.watchProject = (project, { lkg } = {}) => projectWatcher.enqueue(project, { lkg });

scripts/build/projects.js

@@ -45,4 +45,6 @@ function base64VLQFormatEncode(value) {
 
     return result;
 }
-exports.base64VLQFormatEncode = base64VLQFormatEncode;
+exports.base64VLQFormatEncode = base64VLQFormatEncode;
+
+/** @typedef {object} RawSourceMap */