Enable @ts-check to work (again) and add it to some files (#941)

.gitignore

@@ -6,6 +6,4 @@ dist/
 dist-build/
 dist-ssr/
 dist-start/
-.eslintcache
 yarn.lock
-tsconfig.tsbuildinfo

package.json

@@ -5,8 +5,8 @@
   "scripts": {
     "postinstall": "node ./postinstall.js",
     "prepare": "husky",
-    "lint": "concurrently -c auto --group 'pnpm:lint:*'",
-    "lint:eslint": "eslint --cache .",
+    "lint": "pnpm run '/^lint:.*/'",
+    "lint:eslint": "eslint --cache --cache-location 'node_modules/.cache/eslint/.eslintcache' .",
     "lint:prettier": "prettier --cache --list-different '**/*.{js,ts,tsx,md,less,css}'",
     "lint:tsc": "tsc",
     "check": "pnpm install --frozen-lockfile && echo 'Ignore paths from lint-staged'",
@@ -47,7 +47,6 @@
     "@tsconfig/node-lts": "^18.12.3",
     "@types/jest": "^29.0.0",
     "@types/node": "^18.16.19",
-    "concurrently": "^8.2.1",
     "debug": "^4.3.1",
     "dedent": "^1.5.1",
     "eslint": "^8.41.0",

packages/sku/lib/allocatePort.js

@@ -1,9 +1,10 @@
+// @ts-check
 const { yellow, bold } = require('chalk');
 const getPort = require('get-port');
 const debug = require('debug')('sku:allocatePort');
 
 /**
- * @param {{ port?: number, host?: string }}
+ * @param {{ port?: number, host?: string }} options
  */
 const allocatePort = async ({ port, host }) => {
   debug(`Finding available port with request for ${port}`);

packages/sku/lib/buildFileUtils.js

@@ -1,3 +1,4 @@
+// @ts-check
 const path = require('node:path');
 const fs = require('node:fs/promises');
 const { rimraf } = require('rimraf');

packages/sku/lib/copyDirContents.js

@@ -1,3 +1,4 @@
+// @ts-check
 const path = require('node:path');
 const fs = require('node:fs/promises');
 const exists = require('./exists');

packages/sku/lib/createServer.js

@@ -1,3 +1,4 @@
+// @ts-check
 const http = require('node:http');
 const https = require('node:https');
 

packages/sku/lib/cwd.js

@@ -1,3 +1,4 @@
+// @ts-check
 const path = require('node:path');
 
 let currentCwd = process.cwd();

packages/sku/lib/env.js

@@ -1,3 +1,4 @@
+// @ts-check
 const args = require('../config/args');
 
 /**

packages/sku/lib/exists.js

@@ -1,3 +1,4 @@
+// @ts-check
 const { access } = require('node:fs/promises');
 
 /**

packages/sku/lib/getSiteForHost.js

@@ -1,3 +1,4 @@
+// @ts-check
 const { sites } = require('../context');
 
 /**

packages/sku/lib/install.js

@@ -1,9 +1,11 @@
+// @ts-check
 const { getAddCommand } = require('./packageManager');
 
 const spawn = require('cross-spawn');
 
 /**
  * @param {import("../lib/packageManager").GetAddCommandOptions} options
+ * @returns {Promise<void>}
  */
 module.exports = ({ deps, type, logLevel, exact = true }) =>
   new Promise((resolve, reject) => {

packages/sku/lib/isCI.js

@@ -1 +1,2 @@
+// @ts-check
 module.exports = Boolean(process.env.CI || process.env.BUILDKITE_BUILD_ID);

packages/sku/lib/isCompilePackage.js

@@ -1,3 +1,4 @@
+// @ts-check
 const { getPathFromCwd } = require('./cwd');
 
 const isCompilePackage = () => {

packages/sku/lib/isEmptyDir.js

@@ -1,3 +1,4 @@
+// @ts-check
 const { statSync, readdirSync } = require('node:fs');
 
 /**

packages/sku/lib/parseArgs.js

@@ -1,10 +1,11 @@
+// @ts-check
 const minimist = require('minimist');
 
 /**
  * Supports parsing args that look like:
  * [/path/to/node/node, /path/to/sku, scriptName, arg1, arg2]
  *
- * @param {string[]} args - should look like process.argv
+ * @param {string[]} processArgv - should look like process.argv
  */
 module.exports = (processArgv) => {
   /**
@@ -48,6 +49,8 @@ module.exports = (processArgv) => {
       // need to track them ourselves
       unknown: (arg) => {
         unknown.push(arg);
+
+        return true;
       },
     },
   );

packages/sku/lib/routeMatcher.js

@@ -1,3 +1,4 @@
+// @ts-check
 const { match } = require('path-to-regexp');
 
 /**

packages/sku/lib/runBin.js

@@ -1,3 +1,4 @@
+// @ts-check
 const path = require('node:path');
 const spawn = require('cross-spawn');
 
@@ -45,13 +46,13 @@ const spawnPromise = (commandPath, args, options) => {
  */
 
 /**
- * @param {Options}
+ * @param {Options} options
  */
 const runBin = ({ packageName, binName, args, options }) =>
   spawnPromise(resolveBin(packageName, binName), args, options);
 
 /**
- * @param {Options}
+ * @param {Options} options
  */
 const startBin = ({ packageName, binName, args, options }) => {
   const childProcess = spawn(resolveBin(packageName, binName), args, options);

packages/sku/lib/runTsc.js

@@ -1,3 +1,4 @@
+// @ts-check
 const chalk = require('chalk');
 const { runBin } = require('./runBin');
 const { cwd } = require('./cwd');

packages/sku/lib/runVocab.js

@@ -1,3 +1,4 @@
+// @ts-check
 const { compile } = require('@vocab/core');
 const { getVocabConfig } = require('../config/vocab/vocab');
 

packages/sku/lib/storybook.js

@@ -1,3 +1,4 @@
+// @ts-check
 const path = require('node:path');
 const fs = require('node:fs/promises');
 const debug = require('debug');

packages/sku/lib/suggestScript.js

@@ -1,3 +1,4 @@
+// @ts-check
 const { getRunCommand, getExecuteCommand } = require('./packageManager');
 
 const chalk = require('chalk');

packages/sku/package.json

@@ -130,7 +130,9 @@
   },
   "devDependencies": {
     "@types/cross-spawn": "^6.0.3",
+    "@types/debug": "^4.1.12",
     "@types/express": "^4.17.11",
+    "@types/minimist": "^1.2.5",
     "@types/react": "^18.2.3",
     "@types/react-dom": "^18.2.3",
     "@types/which": "^3.0.0",

tsconfig.json

@@ -5,7 +5,9 @@
     "allowJs": true,
     "jsx": "react-jsx",
     "noEmit": true,
+    // Output incremental build info to node_modules
+    "outDir": "node_modules/.cache/typescript",
     "incremental": true
   },
-  "include": ["tests/**/*", "test-utils/**/*"]
+  "exclude": ["node_modules", "fixtures", "packages/sku/template"]
 }