feat(allow-scripts): prototype of declaration file generation

This adds `.d.ts` generation to `@lavamoat/allow-scripts`.

- Many type defs added to `src/types` for those modules which do not have them (nor are there any published to DefinitelyTyped).  In the future, some of these could be submitted to DefinitelyTyped, if we wish.
- Upgrade `yargs`
- Create reusable TS configuration supporting incremental builds
- Declaration files generated at build time and shipped in the `types` folder (which is now in `.gitignore`)
- Created `.depcheckrc`
- Added, updated, removed and/or fixed many docstring types

Note: the uncommon `skipLibCheck = false` setting in this module's `tsconfig.json` enables typechecking of the `.d.ts` files themselves.  These files are not compiled.

.gitignore

@@ -114,3 +114,5 @@ temp/
 
 # JetBrains
 .idea
+
+packages/allow-scripts/types

config/tsconfig.base.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "checkJs": true,
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "composite": true,
+    "types": ["node"]
+  },
+  "extends": "@tsconfig/node14/tsconfig.json"
+}

package.json

@@ -9,6 +9,9 @@
     "@commitlint/cli": "^17.6.7",
     "@commitlint/config-conventional": "^17.6.7",
     "@metamask/eslint-config-nodejs": "^12.0.0",
+    "@tsconfig/node14": "^14.1.0",
+    "@types/node": "^20.4.1",
+    "@types/yargs": "^17.0.24",
     "ava": "^5.3.1",
     "conventional-changelog-conventionalcommits": "^6.1.0",
     "cross-env": "^7.0.3",
@@ -20,6 +23,7 @@
     "eslint-plugin-react": "^7.33.0",
     "husky": "^8.0.3",
     "lerna": "^7.1.4",
+    "typescript": "^5.1.6",
     "lint-staged": "^13.2.3"
   },
   "engines": {
@@ -32,8 +36,12 @@
     "lint:eslint": "eslint .",
     "lint:fix": "eslint . --fix",
     "lint:deps": "lerna run lint:deps",
-    "build": "npm -w @lavamoat/lavapack -w @lavamoat/viz -w @lavamoat/yarn-plugin-allow-scripts run build",
+    "build": "npm -w @lavamoat/lavapack -w @lavamoat/viz -w @lavamoat/yarn-plugin-allow-scripts run build && npm run build:types",
+    "build:types": "tsc -b",
+    "clean:types": "tsc -b --clean",
+    "watch:types": "tsc -b --watch",
     "rebuild": "npm -w @lavamoat/lavapack -w @lavamoat/viz -w @lavamoat/yarn-plugin-allow-scripts run rebuild",
+    "rebuild:types": "npm run clean:types; npm run build:types",
     "lint:staged": "lint-staged",
     "lint:commit": "commitlint",
     "postinstall": "husky install",

packages/allow-scripts/.depcheckrc

@@ -1,3 +1,7 @@
 ignores:
   # monorepo deps
   - 'ava'
+  - "@types/npmcli__promise-spawn"
+
+  # only types (from @types/npmcli__promise-spawn) are referenced
+  - "@npmcli/promise-spawn"

packages/allow-scripts/package.json

@@ -15,7 +15,7 @@
     "@npmcli/run-script": "^6.0.0",
     "bin-links": "4.0.1",
     "npm-normalize-package-bin": "^3.0.0",
-    "yargs": "^16.2.0"
+    "yargs": "^17.7.2"
   },
   "repository": {
     "type": "git",
@@ -29,6 +29,9 @@
   "directories": {
     "test": "test"
   },
+  "devDependencies": {
+    "@types/npmcli__promise-spawn": "^6.0.0"
+  },
   "scripts": {
     "test": "npm run test:prep && test:run",
     "test:run": "ava",
@@ -45,5 +48,6 @@
       "test/*.spec.js"
     ],
     "timeout": "30s"
-  }
+  },
+  "types": "./types/index.d.ts"
 }

packages/allow-scripts/src/cli.js

@@ -1,9 +1,10 @@
 #!/usr/bin/env node
 
-const yargs = require('yargs')
+const yargs = require('yargs/yargs')
+const { hideBin } = require('yargs/helpers')
 const { runAllowedPackages, setDefaultConfiguration, printPackagesList } = require('./index.js')
 const { writeRcFile, editPackageJson } = require('./setup.js')
-const { FEATURE } = require('./toggles') 
+const { FEATURE } = require('./toggles')
 
 start().catch((err) => {
   console.error(err)
@@ -46,7 +47,7 @@ async function start () {
 }
 
 function parseArgs () {
-  const argsParser = yargs
+  const argsParser = yargs(hideBin(process.argv))
     .usage('Usage: $0 <command> [options]')
     .command('$0', 'run the allowed scripts')
     .command('run', 'run the allowed scripts')
@@ -60,7 +61,7 @@ function parseArgs () {
     })
     .help()
 
-  const parsedArgs = argsParser.parse()
+  const parsedArgs = argsParser.parseSync()
   parsedArgs.command = parsedArgs._[0]
 
   return parsedArgs