fix(deps): add type declarations for 20 of 29 untyped dependencies (#7049)

serhalp · web-flow · commit b56095b1218a · 2025-02-20T20:09:21.000Z
* chore(deps): replace untyped better-opn package * fix(deps): remove unixify dependency * types: add missing DefinitelyTyped type declarations * fix(deps): upgrade cookie package v1 adds types: https://github.com/jshttp/cookie/releases/tag/v1.0.0 * fix: fix typo in error message * fix(deps): pin new deps
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -89,7 +89,6 @@
     "ansi-to-html": "0.7.2",
     "ascii-table": "0.0.9",
     "backoff": "2.5.0",
-    "better-opn": "3.0.2",
     "boxen": "8.0.1",
     "chalk": "5.4.1",
     "chokidar": "3.6.0",
@@ -99,7 +98,7 @@
     "comment-json": "4.2.5",
     "configstore": "7.0.0",
     "content-type": "1.0.5",
-    "cookie": "0.7.2",
+    "cookie": "1.0.2",
     "cron-parser": "4.9.0",
     "debug": "4.4.0",
     "decache": "4.6.2",
@@ -147,6 +146,7 @@
     "netlify": "13.3.3",
     "netlify-redirector": "0.5.0",
     "node-fetch": "3.3.2",
+    "open": "10.1.0",
     "ora": "8.2.0",
     "p-filter": "4.1.0",
     "p-map": "7.0.3",
@@ -170,7 +170,6 @@
     "toml": "3.0.0",
     "tomlify-j0.4": "3.0.0",
     "ulid": "2.3.0",
-    "unixify": "1.0.0",
     "update-notifier": "7.3.1",
     "uuid": "11.0.5",
     "wait-port": "1.1.0",
@@ -183,14 +182,31 @@
     "@netlify/eslint-config-node": "7.0.1",
     "@netlify/functions": "3.0.0",
     "@sindresorhus/slugify": "2.2.1",
+    "@types/configstore": "^6.0.2",
+    "@types/content-type": "^1.1.8",
+    "@types/debug": "^4.1.12",
+    "@types/envinfo": "^7.8.4",
+    "@types/etag": "^1.8.3",
+    "@types/flush-write-stream": "^1.0.2",
+    "@types/folder-walker": "^3.2.4",
+    "@types/gitconfiglocal": "^2.0.3",
     "@types/inquirer": "9.0.7",
+    "@types/inquirer-autocomplete-prompt": "^3.0.3",
     "@types/jsonwebtoken": "9.0.8",
     "@types/lodash": "4.17.15",
+    "@types/multiparty": "^4.2.1",
     "@types/node": "22.10.7",
     "@types/node-fetch": "2.6.12",
+    "@types/parallel-transform": "^1.1.4",
+    "@types/parse-github-url": "^1.0.3",
     "@types/parse-gitignore": "1.0.2",
     "@types/prettyjson": "0.0.33",
+    "@types/pump": "^1.1.3",
     "@types/semver": "7.5.8",
+    "@types/source-map-support": "^0.5.10",
+    "@types/tabtab": "^3.0.4",
+    "@types/through2-map": "^3.0.4",
+    "@types/write-file-atomic": "^4.0.3",
     "@types/ws": "8.5.14",
     "@vitest/coverage-v8": "1.6.1",
     "c8": "10.1.3",
diff --git a/src/commands/base-command.ts b/src/commands/base-command.ts
@@ -8,11 +8,9 @@ import { NodeFS, NoopLogger } from '@netlify/build-info/node'
 import { resolveConfig } from '@netlify/config'
 import { isCI } from 'ci-info'
 import { Command, Help, Option } from 'commander'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'debu... Remove this comment to see the full error message
 import debug from 'debug'
 import { findUp } from 'find-up'
 import inquirer from 'inquirer'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'inqu... Remove this comment to see the full error message
 import inquirerAutocompletePrompt from 'inquirer-autocomplete-prompt'
 import merge from 'lodash/merge.js'
 import { NetlifyAPI } from 'netlify'
diff --git a/src/commands/completion/completion.ts b/src/commands/completion/completion.ts
@@ -5,7 +5,6 @@ import { fileURLToPath } from 'url'
 import inquirer from 'inquirer'
 
 import { OptionValues } from 'commander'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'tabt... Remove this comment to see the full error message
 import { install, uninstall } from 'tabtab'
 
 import { generateAutocompletion } from '../../lib/completion/index.js'
diff --git a/src/commands/main.ts b/src/commands/main.ts
@@ -1,7 +1,6 @@
 import process from 'process'
 
 import { Option } from 'commander'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'envi... Remove this comment to see the full error message
 import envinfo from 'envinfo'
 import { closest } from 'fastest-levenshtein'
 import inquirer from 'inquirer'
diff --git a/src/lib/completion/script.ts b/src/lib/completion/script.ts
@@ -6,7 +6,6 @@
 import { existsSync, readFileSync } from 'fs'
 import process from 'process'
 
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'tabt... Remove this comment to see the full error message
 import { log, parseEnv } from 'tabtab'
 
 import { AUTOCOMPLETION_FILE } from './constants.js'
diff --git a/src/lib/functions/form-submissions-handler.ts b/src/lib/functions/form-submissions-handler.ts
@@ -1,9 +1,7 @@
 import { Readable } from 'stream'
 
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'cont... Remove this comment to see the full error message
 import { parse as parseContentType } from 'content-type'
 import type { RequestHandler } from 'express'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'mult... Remove this comment to see the full error message
 import multiparty from 'multiparty'
 import getRawBody from 'raw-body'
 
diff --git a/src/lib/functions/runtimes/js/builders/zisi.ts b/src/lib/functions/runtimes/js/builders/zisi.ts
@@ -5,7 +5,6 @@ import path from 'path'
 import { zipFunction, listFunction } from '@netlify/zip-it-and-ship-it'
 import decache from 'decache'
 import { readPackageUp } from 'read-package-up'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'sour... Remove this comment to see the full error message
 import sourceMapSupport from 'source-map-support'
 
 import { NETLIFYDEVERR } from '../../../../../utils/command-helpers.js'
diff --git a/src/lib/functions/runtimes/js/worker.ts b/src/lib/functions/runtimes/js/worker.ts
@@ -4,7 +4,6 @@ import { isMainThread, workerData, parentPort } from 'worker_threads'
 
 import { isStream } from 'is-stream'
 import lambdaLocal from 'lambda-local'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'sour... Remove this comment to see the full error message
 import sourceMapSupport from 'source-map-support'
 
 if (isMainThread) {
diff --git a/src/recipes/vscode/settings.ts b/src/recipes/vscode/settings.ts
@@ -1,13 +1,15 @@
 import { mkdir, readFile, stat, writeFile } from 'fs/promises'
-import { dirname, relative } from 'path'
+import { dirname, posix, relative } from 'path'
 
 import * as JSONC from 'comment-json'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'unix... Remove this comment to see the full error message
-import unixify from 'unixify'
+
+const toUnixPath = (path: string): string => path.replace(/\\/g, '/')
 
 // @ts-expect-error TS(7006) FIXME: Parameter 'existingSettings' implicitly has an 'an... Remove this comment to see the full error message
 export const applySettings = (existingSettings, { denoBinary, edgeFunctionsPath, repositoryRoot }) => {
-  const relativeEdgeFunctionsPath = unixify(relative(repositoryRoot, edgeFunctionsPath))
+  // TODO(serhalp) I'm not convinced we want to convert to Unix paths on Windows? Does this even work? Was this a
+  // workaround for something, perhaps https://github.com/denoland/vscode_deno/pull/745?
+  const relativeEdgeFunctionsPath = toUnixPath(posix.normalize(relative(repositoryRoot, edgeFunctionsPath)))
   const settings = JSONC.assign(existingSettings, {
     'deno.enable': true,
     'deno.enablePaths': existingSettings['deno.enablePaths'] || [],
diff --git a/src/utils/deploy/hash-files.ts b/src/utils/deploy/hash-files.ts
@@ -1,13 +1,13 @@
 import { promisify } from 'util'
 
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'fold... Remove this comment to see the full error message
 import walker from 'folder-walker'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'pump... Remove this comment to see the full error message
-import pumpModule from 'pump'
+import pumpModule, { type Stream } from 'pump'
 
 import { fileFilterCtor, fileNormalizerCtor, hasherCtor, manifestCollectorCtor } from './hasher-segments.js'
 
-const pump = promisify(pumpModule)
+// Explicitly passing type parameter because inference isn't playing nicely with incompatible patterns for typing
+// function spread parameters + function overloading
+const pump = promisify<Stream[]>(pumpModule)
 
 const hashFiles = async ({
   assetType = 'file',
@@ -37,7 +37,7 @@ const hashFiles = async ({
   const filesShaMap = {}
   const manifestCollector = manifestCollectorCtor(files, filesShaMap, { statusCb, assetType })
 
-  await pump(fileStream, fileFilter, hasher, fileNormalizer, manifestCollector)
+  await pump([fileStream, fileFilter, hasher, fileNormalizer, manifestCollector] as const)
 
   return { files, filesShaMap }
 }
diff --git a/src/utils/deploy/hash-fns.ts b/src/utils/deploy/hash-fns.ts
@@ -5,16 +5,17 @@ import { promisify } from 'util'
 import { zipFunctions, type FunctionResult, type TrafficRules } from '@netlify/zip-it-and-ship-it'
 // @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'from... Remove this comment to see the full error message
 import fromArray from 'from2-array'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'pump... Remove this comment to see the full error message
-import pumpModule from 'pump'
+import pumpModule, { type Stream } from 'pump'
 
 import BaseCommand from '../../commands/base-command.js'
 import { $TSFixMe } from '../../commands/types.js'
 import { INTERNAL_FUNCTIONS_FOLDER } from '../functions/functions.js'
 
 import { hasherCtor, manifestCollectorCtor } from './hasher-segments.js'
 
-const pump = promisify(pumpModule)
+// Explicitly passing type parameter because inference isn't playing nicely with incompatible patterns for typing
+// function spread parameters + function overloading
+const pump = promisify<Stream[]>(pumpModule)
 
 // Maximum age of functions manifest (2 minutes).
 const MANIFEST_FILE_TTL = 12e4
@@ -226,7 +227,7 @@ const hashFns = async (
   const fnShaMap = {}
   const manifestCollector = manifestCollectorCtor(functions, fnShaMap, { statusCb, assetType })
 
-  await pump(functionStream, hasher, manifestCollector)
+  await pump([functionStream, hasher, manifestCollector] as const)
   return { functionSchedules, functions, functionsWithNativeModules, fnShaMap, fnConfig }
 }
 
diff --git a/src/utils/deploy/hasher-segments.ts b/src/utils/deploy/hasher-segments.ts
@@ -2,13 +2,10 @@ import { createHash } from 'node:crypto'
 import { createReadStream } from 'node:fs'
 import { pipeline } from 'node:stream/promises'
 
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'flus... Remove this comment to see the full error message
 import flushWriteStream from 'flush-write-stream'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'para... Remove this comment to see the full error message
 import transform from 'parallel-transform'
 // @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'thro... Remove this comment to see the full error message
 import { objCtor as objFilterCtor } from 'through2-filter'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'thro... Remove this comment to see the full error message
 import { obj as map } from 'through2-map'
 
 import { normalizePath } from './util.js'
@@ -26,22 +23,20 @@ const hashFile = async (filePath: string, algorithm: string) => {
 // @ts-expect-error TS(7031) FIXME: Binding element 'concurrentHash' implicitly has an... Remove this comment to see the full error message
 export const hasherCtor = ({ concurrentHash, hashAlgorithm }) => {
   if (!concurrentHash) throw new Error('Missing required opts')
-  // @ts-expect-error TS(7006) FIXME: Parameter 'fileObj' implicitly has an 'any' type.
   return transform(concurrentHash, { objectMode: true }, async (fileObj, cb) => {
     try {
       const hash = await hashFile(fileObj.filepath, hashAlgorithm)
       // insert hash and asset type to file obj
       return cb(null, { ...fileObj, hash })
     } catch (error) {
-      return cb(error)
+      return cb(error as Error)
     }
   })
 }
 
 // Inject normalized file names into normalizedPath and assetType
 // @ts-expect-error TS(7031) FIXME: Binding element 'assetType' implicitly has an 'any... Remove this comment to see the full error message
 export const fileNormalizerCtor = ({ assetType, normalizer: normalizeFunction }) =>
-  // @ts-expect-error TS(7006) FIXME: Parameter 'fileObj' implicitly has an 'any' type.
   map((fileObj) => {
     const normalizedFile = { ...fileObj, assetType, normalizedPath: normalizePath(fileObj.relname) }
 
@@ -56,7 +51,6 @@ export const fileNormalizerCtor = ({ assetType, normalizer: normalizeFunction })
 // @ts-expect-error TS(7006) FIXME: Parameter 'filesObj' implicitly has an 'any' type.
 export const manifestCollectorCtor = (filesObj, shaMap, { assetType, statusCb }) => {
   if (!statusCb || !assetType) throw new Error('Missing required options')
-  // @ts-expect-error TS(7006) FIXME: Parameter 'fileObj' implicitly has an 'any' type.
   return flushWriteStream.obj((fileObj, _, cb) => {
     filesObj[fileObj.normalizedPath] = fileObj.hash
 
@@ -73,7 +67,7 @@ export const manifestCollectorCtor = (filesObj, shaMap, { assetType, statusCb })
       msg: `Hashing ${fileObj.relname}`,
       phase: 'progress',
     })
-    cb(null)
+    cb()
   })
 }
 /* eslint-enable promise/prefer-await-to-callbacks */
diff --git a/src/utils/get-global-config.ts b/src/utils/get-global-config.ts
@@ -1,6 +1,5 @@
 import { readFile } from 'fs/promises'
 
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'conf... Remove this comment to see the full error message
 import Configstore from 'configstore'
 import { v4 as uuidv4 } from 'uuid'
 
@@ -34,7 +33,8 @@ const getGlobalConfig = async function () {
     } catch {}
     // Use legacy config as default values
     const defaults = { ...globalConfigDefaults, ...legacyConfig }
-    configStore = new Configstore(null, defaults, { configPath })
+    // The id param is only used when not passing `configPath` but the type def requires it
+    configStore = new Configstore('unused-id', defaults, { configPath })
   }
 
   return configStore
diff --git a/src/utils/get-repo-data.ts b/src/utils/get-repo-data.ts
@@ -3,10 +3,8 @@ import util from 'util'
 
 import { findUp } from 'find-up'
 import gitRepoInfo from 'git-repo-info'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'gitc... Remove this comment to see the full error message
 import gitconfiglocal from 'gitconfiglocal'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'pars... Remove this comment to see the full error message
-import parseGitRemote from 'parse-github-url'
+import parseGithubUrl from 'parse-github-url'
 
 import { log } from './command-helpers.js'
 
@@ -51,16 +49,19 @@ const getRepoData = async function ({ remoteName, workingDir }: { remoteName?: s
     }
 
     const { url } = gitConfig.remote[remoteName]
-    const { host, name, owner, repo } = parseGitRemote(url)
+    const parsedUrl = parseGithubUrl(url)
+    if (parsedUrl == null) {
+      throw new Error(`The specified Git remote ${remoteName} is not a valid URL: ${url}`)
+    }
+    const { host, name, owner, repo } = parsedUrl
     const { branch } = gitRepoInfo()
     return {
       name,
       owner,
       repo,
       url,
       branch,
-      // @ts-expect-error TS(7053) FIXME: Element implicitly has an 'any' type because expre... Remove this comment to see the full error message
-      provider: PROVIDERS[host] || host,
+      provider: host != null ? PROVIDERS[host] ?? host : host,
       httpsUrl: `https://${host}/${repo}`,
     }
   } catch (error) {
@@ -71,7 +72,7 @@ const getRepoData = async function ({ remoteName, workingDir }: { remoteName?: s
   }
 }
 
-const PROVIDERS = {
+const PROVIDERS: Record<string, string> = {
   'github.com': 'github',
   'gitlab.com': 'gitlab',
 }
diff --git a/src/utils/open-browser.ts b/src/utils/open-browser.ts
@@ -1,7 +1,6 @@
 import process from 'process'
 
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'bett... Remove this comment to see the full error message
-import open from 'better-opn'
+import open from 'open'
 import isDockerContainer from 'is-docker'
 
 import { chalk, log } from './command-helpers.js'
diff --git a/src/utils/proxy.ts b/src/utils/proxy.ts
@@ -11,12 +11,9 @@ import { Duplex } from 'stream'
 import util from 'util'
 import zlib from 'zlib'
 
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'cont... Remove this comment to see the full error message
 import contentType from 'content-type'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'cook... Remove this comment to see the full error message
 import cookie from 'cookie'
 import { getProperty } from 'dot-prop'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'etag... Remove this comment to see the full error message
 import generateETag from 'etag'
 import getAvailablePort from 'get-port'
 import httpProxy from 'http-proxy'
diff --git a/src/utils/rules-proxy.ts b/src/utils/rules-proxy.ts
@@ -1,7 +1,6 @@
 import path from 'path'
 
 import chokidar from 'chokidar'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'cook... Remove this comment to see the full error message
 import cookie from 'cookie'
 import redirector from 'netlify-redirector'
 import type { Match, RedirectMatcher } from 'netlify-redirector'
diff --git a/src/utils/sites/create-template.ts b/src/utils/sites/create-template.ts
@@ -1,6 +1,5 @@
 import { OptionValues } from 'commander'
 import inquirer from 'inquirer'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'pars... Remove this comment to see the full error message
 import parseGitHubUrl from 'parse-github-url'
 
 import { log } from '../command-helpers.js'
@@ -33,8 +32,8 @@ export const getTemplateName = async ({
   repository: string
 }) => {
   if (repository) {
-    const { repo } = parseGitHubUrl(repository)
-    return repo || `netlify-templates/${repository}`
+    const parsedUrl = parseGitHubUrl(repository)
+    return parsedUrl?.repo || `netlify-templates/${repository}`
   }
 
   if (options.url) {
diff --git a/src/utils/state-config.ts b/src/utils/state-config.ts
@@ -4,7 +4,6 @@ import process from 'process'
 
 import { deleteProperty, getProperty, hasProperty, setProperty } from 'dot-prop'
 import { findUpSync } from 'find-up'
-// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'writ... Remove this comment to see the full error message
 import writeFileAtomic from 'write-file-atomic'
 
 import { getPathInProject } from '../lib/settings.js'
