feat: Add general type-aware linting (#1497)

* Support type-aware linting by environment variable
  * `ENDO_LINT_TYPES=SRC`: Limit to "src" directories (increases time ~50%).
  * `ENDO_LINT_TYPES=FULL`: Include all files (increases time **greatly**).

Author: gibson042

jsconfig.eslint-base.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "checkJs": false,
+    "noEmit": true,
+    "downlevelIteration": true,
+    "strictNullChecks": true,
+    "moduleResolution": "node"
+  },
+  "include": [],
+  "exclude": ["packages/test262-runner/test262"]
+}

jsconfig.eslint-full.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./jsconfig.eslint-base.json",
+  "include": [
+    "**/*.js",
+    "**/*.ts"
+  ]
+}

jsconfig.eslint-src.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./jsconfig.eslint-base.json",
+  "include": [
+    "*.js",
+    "*.ts",
+    "packages/*/*.js",
+    "packages/*/*.ts",
+    "packages/*/src/**/*.js",
+    "packages/*/src/**/*.ts"
+  ]
+}

package.json

@@ -10,6 +10,7 @@
   },
   "devDependencies": {
     "@octokit/core": "^3.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.53.0",
     "ava": "^5.2.0",
     "eslint": "^7.32.0",
     "eslint-config-airbnb-base": "^14.0.0",
@@ -20,7 +21,7 @@
     "eslint-plugin-prettier": "^3.4.1",
     "lerna": "^5.6.2",
     "lerna-update-wizard": "^0.17.5",
-    "typescript": "~4.9.4"
+    "typescript": "~4.9.5"
   },
   "scripts": {
     "clean": "lerna clean",
@@ -37,7 +38,7 @@
     "build": "lerna run build"
   },
   "dependencies": {
-    "@typescript-eslint/parser": "^5.27.0",
+    "@typescript-eslint/parser": "^5.53.0",
     "conventional-changelog-conventionalcommits": "^4.6.0",
     "patch-package": "^6.2.2"
   }

packages/base64/package.json

@@ -50,7 +50,7 @@
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-prettier": "^3.4.1",
     "prettier": "^2.8.0",
-    "typescript": "~4.9.4"
+    "typescript": "~4.9.5"
   },
   "files": [
     "LICENSE*",

packages/bundle-source/src/index.js

@@ -32,7 +32,12 @@ const textEncoder = new TextEncoder();
 const textDecoder = new TextDecoder();
 const readPowers = makeReadPowers({ fs, url, crypto });
 
-// Find the longest common prefix of an array of strings.
+/**
+ * Finds the longest common prefix in an array of strings.
+ *
+ * @param {string[]} strings
+ * @returns {string}
+ */
 function longestCommonPrefix(strings) {
   if (strings.length === 0) {
     return '';
@@ -255,6 +260,10 @@ async function bundleNestedEvaluateAndGetExports(
     throw Error('No entrypoint found in output bundle');
   }
 
+  /**
+   * @param {string} a
+   * @param {string} b
+   */
   const strcmp = (a, b) => {
     if (a < b) {
       return -1;

packages/bundle-source/src/tool.js

@@ -10,6 +10,14 @@ const { details: X, quote: q } = assert;
 const USAGE =
   'bundle-source [--cache-js | --cache-json] cache/ module1.js bundleName1 module2.js bundleName2 ...';
 
+/**
+ * @typedef {object} BundleMeta
+ * @property {string} bundleFileName
+ * @property {string} bundleTime ISO format
+ * @property {{ relative: string, absolute: string }} moduleSource
+ * @property {Array<{ relativePath: string, mtime: string }>} contents
+ */
+
 export const makeFileReader = (fileName, { fs, path }) => {
   const make = there => makeFileReader(there, { fs, path });
   return harden({
@@ -68,6 +76,7 @@ export const makeBundleCache = (wr, cwd, readPowers, opts) => {
         try {
           const itemRd = cwd.neighbor(new URL(loc).pathname);
           const ref = srcRd.relative(itemRd.absolute());
+          /** @type {import('fs').Stats} */
           const { mtime } = await itemRd.stat();
           modTimeByPath.set(ref, mtime);
           // console.log({ loc, mtime, ref });
@@ -91,8 +100,10 @@ export const makeBundleCache = (wr, cwd, readPowers, opts) => {
     const bundleFileName = toBundleName(targetName);
     const bundleWr = wr.neighbor(bundleFileName);
     await bundleWr.writeText(code);
+    /** @type {import('fs').Stats} */
     const { mtime: bundleTime } = await bundleWr.readOnly().stat();
 
+    /** @type {BundleMeta} */
     const meta = {
       bundleFileName,
       bundleTime: bundleTime.toISOString(),
@@ -122,6 +133,7 @@ export const makeBundleCache = (wr, cwd, readPowers, opts) => {
         X`${q(targetName)}: cannot read bundle metadata: ${q(ioErr)}`,
       );
     }
+    /** @type {BundleMeta} */
     const meta = JSON.parse(txt);
     const {
       bundleFileName,
@@ -130,6 +142,7 @@ export const makeBundleCache = (wr, cwd, readPowers, opts) => {
       moduleSource: { absolute: moduleSource },
     } = meta;
     assert.equal(bundleFileName, toBundleName(targetName));
+    /** @type {import('fs').Stats} */
     const { mtime: actualBundleTime } = await wr
       .readOnly()
       .neighbor(bundleFileName)
@@ -139,6 +152,7 @@ export const makeBundleCache = (wr, cwd, readPowers, opts) => {
     const actualTimes = await Promise.all(
       contents.map(async ({ relativePath }) => {
         const itemRd = moduleRd.neighbor(relativePath);
+        /** @type {import('fs').Stats} */
         const { mtime } = await itemRd.stat();
         return { relativePath, mtime: mtime.toISOString() };
       }),
@@ -195,6 +209,11 @@ export const makeBundleCache = (wr, cwd, readPowers, opts) => {
   });
 };
 
+/**
+ * @param {[string, string, string[]]} args
+ * @param {*} powers
+ * @returns {void}
+ */
 export const main = async (args, { fs, url, crypto, path }) => {
   const [to, dest, ...pairs] = args;
   if (!(dest && pairs.length > 0 && pairs.length % 2 === 0)) {

packages/check-bundle/package.json

@@ -55,7 +55,7 @@
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-prettier": "^3.4.1",
     "prettier": "^2.8.0",
-    "typescript": "~4.9.4"
+    "typescript": "~4.9.5"
   },
   "files": [
     "*.js",

packages/cjs-module-analyzer/package.json

@@ -40,7 +40,7 @@
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-prettier": "^3.4.1",
     "prettier": "^2.8.0",
-    "typescript": "~4.9.4"
+    "typescript": "~4.9.5"
   },
   "files": [
     "LICENSE*",

packages/cli/package.json

@@ -45,7 +45,7 @@
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-prettier": "^3.4.1",
     "prettier": "^2.8.0",
-    "typescript": "~4.9.4"
+    "typescript": "~4.9.5"
   },
   "files": [
     "LICENSE*",