feat: add unattended mode flag to sanity undeploy

sanity-io · Dec 21, 2024 · d5c39c8 · d5c39c8
1 parent ddb65fa
commit d5c39c8
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 9 deletions.
diff --git a/packages/sanity/src/_internal/cli/actions/deploy/undeployAction.ts b/packages/sanity/src/_internal/cli/actions/deploy/undeployAction.ts
@@ -5,11 +5,17 @@ import {deleteUserApplication, getUserApplication} from './helpers'
 
 const debug = debugIt.extend('undeploy')
 
+export interface UndeployStudioActionFlags {
+  yes?: boolean
+  y?: boolean
+}
+
 export default async function undeployStudioAction(
-  _: CliCommandArguments<Record<string, unknown>>,
+  args: CliCommandArguments<UndeployStudioActionFlags>,
   context: CliCommandContext,
 ): Promise<void> {
   const {apiClient, chalk, output, prompt, cliConfig} = context
+  const flags = args.extOptions
 
   const client = apiClient({
     requireUser: true,
@@ -37,16 +43,25 @@ export default async function undeployStudioAction(
   output.print('')
 
   const url = `https://${chalk.yellow(userApplication.appHost)}.sanity.studio`
-  const shouldUndeploy = await prompt.single({
-    type: 'confirm',
-    default: false,
-    message: `This will undeploy ${url} and make it unavailable for your users.
+
+  /**
+   * Unattended mode means that if there are any prompts it will use `YES` for them but will no change anything that doesn't have a prompt
+   */
+  const unattendedMode = Boolean(flags.yes || flags.y)
+
+  // If it is in unattended mode, we don't want to prompt
+  if (!unattendedMode) {
+    const shouldUndeploy = await prompt.single({
+      type: 'confirm',
+      default: false,
+      message: `This will undeploy ${url} and make it unavailable for your users.
   The hostname will be available for anyone to claim.
   Are you ${chalk.red('sure')} you want to undeploy?`.trim(),
-  })
+    })
 
-  if (!shouldUndeploy) {
-    return
+    if (!shouldUndeploy) {
+      return
+    }
   }
 
   spinner = output.spinner('Undeploying studio').start()

diff --git a/packages/sanity/src/_internal/cli/commands/deploy/undeployCommand.ts b/packages/sanity/src/_internal/cli/commands/deploy/undeployCommand.ts
@@ -4,17 +4,23 @@ import {
   type CliCommandDefinition,
 } from '@sanity/cli'
 
+import {type UndeployStudioActionFlags} from '../../actions/deploy/undeployAction'
+
 const helpText = `
+Options
+  -y, --yes Unattended mode, answers "yes" to any "yes/no" prompt and otherwise uses defaults
+
 Examples
   sanity undeploy
+  sanity undeploy --yes
 `
 
 const undeployCommand: CliCommandDefinition = {
   name: 'undeploy',
   signature: '',
   description: 'Removes the deployed Sanity Studio from Sanity hosting',
   action: async (
-    args: CliCommandArguments<Record<string, unknown>>,
+    args: CliCommandArguments<UndeployStudioActionFlags>,
     context: CliCommandContext,
   ) => {
     const mod = await import('../../actions/deploy/undeployAction')