refactor: enable typechecking on tests

Author: ndhoule

Diff for: eslint.config.js

@@ -152,7 +152,7 @@ export default tseslint.config(
       'n/no-unsupported-features/node-builtins': [
         'error',
         {
-          ignores: ['FormData', 'ReadableStream', 'Response', 'fetch', 'fs/promises.cp'],
+          ignores: ['FormData', 'ReadableStream', 'Response', 'Request', 'fetch', 'fs/promises.cp'],
         },
       ],
     },

Diff for: package.json

@@ -59,7 +59,8 @@
     "postinstall": "npm run build && node ./scripts/postinstall.js",
     "prepublishOnly": "node ./scripts/prepare-for-publish.js",
     "certs": "openssl req -x509 -out localhost.crt -keyout localhost.key -newkey rsa:2048 -nodes -sha256 -subj \"/CN=localhost\" -extensions EXT -config certconf",
-    "typecheck": "tsc"
+    "typecheck": "tsc",
+    "typecheck:watch": "tsc --watch"
   },
   "dependencies": {
     "@fastify/static": "7.0.4",

Diff for: tests/integration/commands/blobs/blobs-delete.test.ts

@@ -125,7 +125,8 @@ describe('blobs:delete command', () => {
             await runMockProgram(['', '', 'blobs:delete', storeName, key])
           } catch (error) {
             // We expect the process to exit, so this is fine
-            expect(error.message).toContain('process.exit unexpectedly called')
+            expect(error).toBeInstanceOf(Error)
+            expect((error as Error).message).toContain('process.exit unexpectedly called')
           }
 
           expect(promptSpy).toHaveBeenCalledWith({
@@ -181,7 +182,8 @@ describe('blobs:delete command', () => {
             try {
               await runMockProgram(['', '', 'blobs:delete', storeName, key, '--force'])
             } catch (error) {
-              expect(error.message).toContain(
+              expect(error).toBeInstanceOf(Error)
+              expect((error as Error).message).toContain(
                 `Could not delete blob ${chalk.yellow(key)} from store ${chalk.yellow(storeName)}`,
               )
             }
@@ -223,7 +225,7 @@ describe('blobs:delete command', () => {
       })
 
       test('should not show prompt for CI/CD', async () => {
-        setCI(true)
+        setCI('true')
         await withMockApi(routes, async ({ apiUrl }) => {
           Object.assign(process.env, getEnvironmentVariables({ apiUrl }))
 

Diff for: tests/integration/commands/blobs/blobs-set.test.ts

@@ -157,7 +157,8 @@ describe('blobs:set command', () => {
             await runMockProgram(['', '', 'blobs:set', storeName, key, newValue])
           } catch (error) {
             // We expect the process to exit, so this is fine
-            expect(error.message).toContain('process.exit unexpectedly called with "0"')
+            expect(error).toBeInstanceOf(Error)
+            expect((error as Error).message).toContain('process.exit unexpectedly called with "0"')
           }
 
           expect(promptSpy).toHaveBeenCalledWith({
@@ -213,7 +214,8 @@ describe('blobs:set command', () => {
           try {
             await runMockProgram(['', '', 'blobs:set', storeName, key, newValue, '--force'])
           } catch (error) {
-            expect(error.message).toContain(
+            expect(error).toBeInstanceOf(Error)
+            expect((error as Error).message).toContain(
               `Could not set blob ${chalk.yellow(key)} in store ${chalk.yellow(storeName)}`,
             )
           }
@@ -256,7 +258,7 @@ describe('blobs:set command', () => {
       })
 
       test('should not show prompt in a ci/cd environment', async () => {
-        setCI(true)
+        setCI('true')
         await withMockApi(routes, async ({ apiUrl }) => {
           Object.assign(process.env, getEnvironmentVariables({ apiUrl }))
 

Diff for: tests/integration/commands/build/build-program.test.js renamed to tests/integration/commands/build/build-program.test.ts

@@ -2,18 +2,18 @@ import process from 'process'
 
 import { expect, beforeEach, afterAll, describe, test, vi } from 'vitest'
 
-import BaseCommand from '../../../../src/commands/base-command.ts'
-import { createBuildCommand } from '../../../../src/commands/build/index.ts'
+import BaseCommand from '../../../../src/commands/base-command.js'
+import { createBuildCommand } from '../../../../src/commands/build/index.js'
 import { getEnvironmentVariables, withMockApi } from '../../utils/mock-api.js'
-import { withSiteBuilder } from '../../utils/site-builder.ts'
+import { withSiteBuilder } from '../../utils/site-builder.js'
 
 let configOptions = {}
 
 vi.mock('@netlify/config', async (importOriginal) => {
-  const original = await importOriginal()
+  const original = (await importOriginal()) as typeof import('@netlify/config')
   return {
     ...original,
-    resolveConfig: (options) => {
+    resolveConfig: (options: object) => {
       configOptions = options
       return original.resolveConfig(options)
     },
@@ -60,6 +60,7 @@ describe('command/build', () => {
 
   test('should pass feature flags to @netlify/config', async (t) => {
     // this ensures that the process.exit does not exit the test process
+    // @ts-expect-error(ndhoule): Cannot mark the return value on this as as `never`
     vi.spyOn(process, 'exit').mockImplementation((code) => {
       expect(code).toBe(0)
     })
@@ -72,11 +73,11 @@ describe('command/build', () => {
         await builder.withNetlifyToml({ config: {} }).withStateFile({ siteId: siteInfo.id }).build()
 
         await createBuildCommand(new BaseCommand('netlify')).parseAsync(['', '', 'build'])
-        expect(configOptions.featureFlags).toEqual(siteInfo.feature_flags)
-        expect(configOptions.accountId).toEqual(siteInfo.account_id)
+        expect(configOptions).toHaveProperty('featureFlags', siteInfo.feature_flags)
+        expect(configOptions).toHaveProperty('accountId', siteInfo.account_id)
 
         await createBuildCommand(new BaseCommand('netlify')).parseAsync(['', '', 'build', '--offline'])
-        expect(configOptions.featureFlags, 'should not call API in offline mode').toEqual({})
+        expect(configOptions).toHaveProperty('featureFlags', {})
       })
     })
   })

Diff for: tests/integration/commands/build/build.test.ts

@@ -2,14 +2,14 @@ import path, { join } from 'path'
 import process from 'process'
 
 import execa from 'execa'
-import { describe, expect, test } from 'vitest'
+import { describe, expect, test, type TaskContext, type TestContext } from 'vitest'
 
 import { callCli } from '../../utils/call-cli.js'
 import { cliPath } from '../../utils/cli-path.js'
-import { FixtureTestContext, setupFixtureTests } from '../../utils/fixture.ts'
+import { FixtureTestContext, setupFixtureTests } from '../../utils/fixture.js'
 import { CONFIRM, handleQuestions } from '../../utils/handle-questions.js'
 import { withMockApi } from '../../utils/mock-api.js'
-import { withSiteBuilder } from '../../utils/site-builder.ts'
+import { withSiteBuilder } from '../../utils/site-builder.js'
 
 const defaultEnvs = {
   NETLIFY_AUTH_TOKEN: 'fake-token',
@@ -22,17 +22,18 @@ const defaultEnvs = {
  *  - that its output contains `output`
  */
 const runBuildCommand = async function (
-  t,
-  cwd,
+  t: TaskContext & TestContext,
+  cwd: string,
   options: Partial<{
     exitCode: number
     flags: string[]
-    output: any
+    expectedExitCode?: number | undefined
+    output: string | RegExp | (string | RegExp)[]
     env: Record<string, string>
     apiUrl: string
   }> = {},
 ) {
-  let { apiUrl, env = defaultEnvs, exitCode: expectedExitCode = 0, flags = [], output: outputs } = options
+  let { apiUrl, env = defaultEnvs, exitCode: expectedExitCode = 0, flags = [], output: outputs = [] } = options
   const { all, exitCode } = await execa(cliPath, ['build', ...flags], {
     reject: false,
     cwd,

Diff for: tests/integration/commands/completion/completion-install.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, test, beforeAll, afterAll } from 'vitest'
+import { describe, test, beforeAll, afterAll } from 'vitest'
 import fs from 'fs'
 import { rm } from 'fs/promises'
 import { temporaryDirectory } from 'tempy'
@@ -9,9 +9,9 @@ import { join } from 'path'
 import { TABTAB_CONFIG_LINE, AUTOLOAD_COMPINIT } from '../../../../src/utils/command-helpers.js'
 
 describe('completion:install command', () => {
-  let tempDir
-  let zshConfigPath
-  let options
+  let tempDir: string
+  let zshConfigPath: string
+  let options: execa.Options
 
   beforeAll(() => {
     tempDir = temporaryDirectory()
@@ -25,7 +25,7 @@ describe('completion:install command', () => {
 
   test.skipIf(process.env.SHELL !== '/bin/zsh')(
     'should add compinit to .zshrc when user confirms prompt',
-    async (t) => {
+    async ({ expect }) => {
       fs.writeFileSync(zshConfigPath, TABTAB_CONFIG_LINE)
       const childProcess = execa(cliPath, ['completion:install'], options)
 
@@ -52,7 +52,7 @@ describe('completion:install command', () => {
 
   test.skipIf(process.env.SHELL !== '/bin/zsh')(
     'should not add compinit to .zshrc when user does not confirm prompt',
-    async (t) => {
+    async ({ expect }) => {
       fs.writeFileSync(zshConfigPath, TABTAB_CONFIG_LINE)
       const childProcess = execa(cliPath, ['completion:install'], options)