refactor: type commander options in deploy command

Author: ndhoule

src/commands/base-command.ts

@@ -148,6 +148,15 @@ async function getRepositoryRoot(cwd?: string): Promise<string | undefined> {
   }
 }
 
+export type BaseOptionValues = {
+  auth?: string
+  cwd?: string
+  debug?: boolean
+  filter?: string
+  httpProxy?: string
+  silent?: string
+}
+
 /** Base command class that provides tracking and config initialization */
 export default class BaseCommand extends Command {
   /** The netlify object inside each command with the state */

src/commands/deploy/deploy.ts

@@ -2,17 +2,23 @@ import { type Stats } from 'fs'
 import { stat } from 'fs/promises'
 import { basename, resolve } from 'path'
 
-import { type NetlifyConfig, runCoreSteps } from '@netlify/build'
-import { type OptionValues } from 'commander'
+import { type NetlifyConfig, type OnPostBuild, runCoreSteps } from '@netlify/build'
 import inquirer from 'inquirer'
 import isEmpty from 'lodash/isEmpty.js'
 import isObject from 'lodash/isObject.js'
 import { parseAllHeaders } from '@netlify/headers-parser'
 import { parseAllRedirects } from '@netlify/redirect-parser'
+import type { NetlifyAPI } from 'netlify'
 import prettyjson from 'prettyjson'
 
 import { cancelDeploy } from '../../lib/api.js'
-import { type CachedConfig, getRunBuildOptions, runBuild } from '../../lib/build.js'
+import {
+  type CachedConfig,
+  type DefaultConfig,
+  type PatchedHandlerType,
+  getRunBuildOptions,
+  runBuild,
+} from '../../lib/build.js'
 import { getBootstrapURL } from '../../lib/edge-functions/bootstrap.js'
 import { featureFlags as edgeFunctionsFeatureFlags } from '../../lib/edge-functions/consts.js'
 import { normalizeFunctionsConfig } from '../../lib/functions/config.js'
@@ -42,9 +48,19 @@ import { link } from '../link/link.js'
 import { sitesCreate } from '../sites/sites-create.js'
 import type { $TSFixMe } from '../types.js'
 import { SiteInfo } from '../../utils/types.js'
+import type { DeployOptionValues } from './option_values.js'
 
-// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
-const triggerDeploy = async ({ api, options, siteData, siteId }) => {
+const triggerDeploy = async ({
+  api,
+  options,
+  siteData,
+  siteId,
+}: {
+  api: NetlifyAPI
+  options: DeployOptionValues
+  siteData: { name: string }
+  siteId: string
+}) => {
   try {
     const siteBuild = await api.createSiteBuild({ siteId })
     if (options.json) {
@@ -80,7 +96,7 @@ const getDeployFolder = async ({
 }: {
   command: BaseCommand
   config: $TSFixMe
-  options: OptionValues
+  options: DeployOptionValues
   site: $TSFixMe
   siteData: $TSFixMe
 }): Promise<string> => {
@@ -150,7 +166,7 @@ const getFunctionsFolder = ({
   workingDir,
 }: {
   config: $TSFixMe
-  options: OptionValues
+  options: DeployOptionValues
   site: $TSFixMe
   siteData: $TSFixMe
   /** The process working directory where the build command is executed  */
@@ -347,7 +363,7 @@ const uploadDeployBlobs = async ({
 }: {
   cachedConfig: CachedConfig
   deployId: string
-  options: OptionValues
+  options: DeployOptionValues
   packagePath?: string
   silent: boolean
   siteId: string
@@ -540,18 +556,21 @@ const runDeploy = async ({
   }
 }
 
-/**
- *
- * @param {object} config
- * @param {*} config.cachedConfig
- * @param {string} [config.packagePath]
- * @param {*} config.deployHandler
- * @param {string} config.currentDir
- * @param {import('commander').OptionValues} config.options The options of the command
- * @returns
- */
-// @ts-expect-error TS(7031) FIXME: Binding element 'cachedConfig' implicitly has an '... Remove this comment to see the full error message
-const handleBuild = async ({ cachedConfig, currentDir, defaultConfig, deployHandler, options, packagePath }) => {
+const handleBuild = async ({
+  cachedConfig,
+  currentDir,
+  defaultConfig,
+  deployHandler,
+  options,
+  packagePath,
+}: {
+  cachedConfig: CachedConfig
+  currentDir: string
+  defaultConfig?: DefaultConfig | undefined
+  deployHandler?: PatchedHandlerType<OnPostBuild> | undefined
+  options: DeployOptionValues
+  packagePath: string | undefined
+}) => {
   if (!options.build) {
     return {}
   }
@@ -782,7 +801,7 @@ const prepAndRunDeploy = async ({
   return results
 }
 
-export const deploy = async (options: OptionValues, command: BaseCommand) => {
+export const deploy = async (options: DeployOptionValues, command: BaseCommand) => {
   const { workingDir } = command
   const { api, site, siteInfo } = command.netlify
   const alias = options.alias || options.branch
@@ -834,6 +853,12 @@ export const deploy = async (options: OptionValues, command: BaseCommand) => {
     }
   }
 
+  if (!siteId) {
+    return logAndThrowError(
+      "Unable to determine which site to deploy to. Make sure you've run 'netlify link' or that you're specifying your desired site using the '--site' option.",
+    )
+  }
+
   // This is the best I could come up with to make TS happy with the complexities above.
   const siteData = initialSiteData ?? newSiteData
 

src/commands/deploy/index.ts

@@ -1,8 +1,9 @@
 import { env } from 'process'
 
-import { Option, OptionValues } from 'commander'
+import { Option } from 'commander'
 
 import BaseCommand from '../base-command.js'
+import type { DeployOptionValues } from './option_values.js'
 
 export const createDeployCommand = (program: BaseCommand) =>
   program
@@ -107,7 +108,7 @@ Support for package.json's main field, and intrinsic index.js entrypoints are co
         'build',
       ),
     )
-    .option('--build', 'Run build command before deploying')
+    .option('--build', 'Run build command before deploying', false)
     .option('--context <context>', 'Context to use when resolving build configuration')
     .option(
       '--skip-functions-cache',
@@ -125,7 +126,7 @@ Support for package.json's main field, and intrinsic index.js entrypoints are co
       'netlify deploy --trigger',
       'netlify deploy --build --context deploy-preview',
     ])
-    .action(async (options: OptionValues, command: BaseCommand) => {
+    .action(async (options: DeployOptionValues, command: BaseCommand) => {
       const { deploy } = await import('./deploy.js')
       await deploy(options, command)
     })

src/commands/deploy/option_values.ts

@@ -0,0 +1,21 @@
+// This type lives in a separate file to prevent import cycles.
+
+import type { BaseOptionValues } from '../base-command.js'
+
+export type DeployOptionValues = BaseOptionValues & {
+  alias?: string
+  build: boolean
+  branch?: string
+  context?: string
+  dir?: string
+  functions?: string
+  json: boolean
+  message?: string
+  open: boolean
+  prod: boolean
+  prodIfUnlocked: boolean
+  site?: string
+  skipFunctionsCache: boolean
+  timeout?: number
+  trigger?: boolean
+}

src/lib/build.ts

@@ -115,7 +115,7 @@ interface HandlerResult {
   status?: string
 }
 // The @netlify/build type incorrectly states a `void | Promise<void>` return type.
-type PatchedHandlerType<T extends (opts: any) => void | Promise<void>> = (
+export type PatchedHandlerType<T extends (opts: any) => void | Promise<void>> = (
   opts: Parameters<T>[0],
 ) => HandlerResult | Promise<HandlerResult>