feat: add confirmation prompts to unsafe cli commands

docs/commands/blobs.md

@@ -57,6 +57,7 @@ netlify blobs:delete
 **Flags**
 
 - `filter` (*string*) - For monorepos, specify the name of the application to run the command in
+- `force` (*boolean*) - Force the operation to proceed without confirmation or warnings
 - `debug` (*boolean*) - Print debugging information
 
 ---
@@ -124,6 +125,7 @@ netlify blobs:set
 **Flags**
 
 - `filter` (*string*) - For monorepos, specify the name of the application to run the command in
+- `force` (*boolean*) - Force the operation to proceed without confirmation or warnings
 - `input` (*string*) - Defines the filesystem path where the blob data should be read from
 - `debug` (*boolean*) - Print debugging information
 

docs/commands/env.md

@@ -54,6 +54,7 @@ netlify env:clone
 **Flags**
 
 - `filter` (*string*) - For monorepos, specify the name of the application to run the command in
+- `force` (*boolean*) - Force the operation to proceed without confirmation or warnings
 - `from` (*string*) - Site ID (From)
 - `to` (*string*) - Site ID (To)
 - `debug` (*boolean*) - Print debugging information
@@ -167,6 +168,7 @@ netlify env:set
 
 - `context` (*string*) - Specify a deploy context or branch (contexts: "production", "deploy-preview", "branch-deploy", "dev") (default: all contexts)
 - `filter` (*string*) - For monorepos, specify the name of the application to run the command in
+- `force` (*boolean*) - Force the operation to proceed without confirmation or warnings
 - `scope` (*builds | functions | post-processing | runtime*) - Specify a scope (default: all scopes)
 - `secret` (*boolean*) - Indicate whether the environment variable value can be read again.
 - `debug` (*boolean*) - Print debugging information
@@ -202,6 +204,7 @@ netlify env:unset
 
 - `context` (*string*) - Specify a deploy context or branch (contexts: "production", "deploy-preview", "branch-deploy", "dev") (default: all contexts)
 - `filter` (*string*) - For monorepos, specify the name of the application to run the command in
+- `force` (*boolean*) - Force the operation to proceed without confirmation or warnings
 - `debug` (*boolean*) - Print debugging information
 
 **Examples**

package.json

@@ -191,7 +191,7 @@
     "@netlify/functions": "2.8.2",
     "@sindresorhus/slugify": "2.2.1",
     "@types/fs-extra": "11.0.4",
-    "@types/inquirer": "9.0.7",
+    "@types/inquirer": "^9.0.7",
     "@types/jsonwebtoken": "9.0.7",
     "@types/lodash": "4.17.10",
     "@types/node": "20.14.8",

src/commands/base-command.ts

@@ -1,5 +1,3 @@
-import { isCI } from 'ci-info'
-
 import { existsSync } from 'fs'
 import { join, relative, resolve } from 'path'
 import process from 'process'
@@ -8,6 +6,7 @@ import { format } from 'util'
 import { DefaultLogger, Project } from '@netlify/build-info'
 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'

src/commands/blobs/blobs-delete.ts

@@ -1,21 +1,30 @@
 import { getStore } from '@netlify/blobs'
 
-import { chalk, error as printError } from '../../utils/command-helpers.js'
+import { chalk, error as printError, log } from '../../utils/command-helpers.js'
+import { blobDeletePrompts } from '../../utils/prompts/blob-delete-prompts.js'
 
 /**
  * The blobs:delete command
  */
 export const blobsDelete = async (storeName: string, key: string, _options: Record<string, unknown>, command: any) => {
   const { api, siteInfo } = command.netlify
+  const { force } = _options
+
   const store = getStore({
     apiURL: `${api.scheme}://${api.host}`,
     name: storeName,
     siteID: siteInfo.id ?? '',
     token: api.accessToken ?? '',
   })
 
+  if (force === undefined) {
+    await blobDeletePrompts(key, storeName)
+  }
+
   try {
     await store.delete(key)
+
+    log(`${chalk.greenBright('Success')}: Blob ${chalk.yellow(key)} deleted from store ${chalk.yellow(storeName)}`)
   } catch {
     return printError(`Could not delete blob ${chalk.yellow(key)} from store ${chalk.yellow(storeName)}`)
   }

src/commands/blobs/blobs-set.ts

@@ -4,11 +4,13 @@ import { resolve } from 'path'
 import { getStore } from '@netlify/blobs'
 import { OptionValues } from 'commander'
 
-import { chalk, error as printError, isNodeError } from '../../utils/command-helpers.js'
+import { chalk, error as printError, isNodeError, log } from '../../utils/command-helpers.js'
+import { blobSetPrompts } from '../../utils/prompts/blob-set-prompt.js'
 import BaseCommand from '../base-command.js'
 
 interface Options extends OptionValues {
   input?: string
+  force?: string
 }
 
 export const blobsSet = async (
@@ -19,19 +21,17 @@ export const blobsSet = async (
   command: BaseCommand,
 ) => {
   const { api, siteInfo } = command.netlify
-  const { input } = options
+  const { force, input } = options
   const store = getStore({
     apiURL: `${api.scheme}://${api.host}`,
     name: storeName,
     siteID: siteInfo.id ?? '',
     token: api.accessToken ?? '',
   })
-
   let value = valueParts.join(' ')
 
   if (input) {
     const inputPath = resolve(input)
-
     try {
       value = await fs.readFile(inputPath, 'utf8')
     } catch (error) {
@@ -57,8 +57,17 @@ export const blobsSet = async (
     )
   }
 
+  if (force === undefined) {
+    const existingValue = await store.get(key)
+
+    if (existingValue) {
+      await blobSetPrompts(key, storeName)
+    }
+  }
+
   try {
     await store.set(key, value)
+    log(`${chalk.greenBright('Success')}: Blob ${chalk.yellow(key)} set in store ${chalk.yellow(storeName)}`)
   } catch {
     return printError(`Could not set blob ${chalk.yellow(key)} in store ${chalk.yellow(storeName)}`)
   }

src/commands/blobs/blobs.ts

@@ -19,6 +19,7 @@ export const createBlobsCommand = (program: BaseCommand) => {
     .description(`Deletes an object with a given key, if it exists, from a Netlify Blobs store`)
     .argument('<store>', 'Name of the store')
     .argument('<key>', 'Object key')
+    .option('-f, --force', 'Force the operation to proceed without confirmation or warnings')
     .alias('blob:delete')
     .hook('preAction', requiresSiteInfo)
     .action(async (storeName: string, key: string, _options: OptionValues, command: BaseCommand) => {
@@ -70,6 +71,7 @@ export const createBlobsCommand = (program: BaseCommand) => {
     .argument('<key>', 'Object key')
     .argument('[value...]', 'Object value')
     .option('-i, --input <path>', 'Defines the filesystem path where the blob data should be read from')
+    .option('-f, --force', 'Force the operation to proceed without confirmation or warnings')
     .alias('blob:set')
     .hook('preAction', requiresSiteInfo)
 

src/commands/env/env-clone.ts

@@ -1,6 +1,7 @@
 import { OptionValues } from 'commander'
 
 import { chalk, log, error as logError } from '../../utils/command-helpers.js'
+import { envClonePrompts } from '../../utils/prompts/env-clone-prompt.js'
 import BaseCommand from '../base-command.js'
 
 // @ts-expect-error TS(7006) FIXME: Parameter 'api' implicitly has an 'any' type.
@@ -18,7 +19,7 @@ const safeGetSite = async (api, siteId) => {
  * @returns {Promise<boolean>}
  */
 // @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
-const cloneEnvVars = async ({ api, siteFrom, siteTo }): Promise<boolean> => {
+const cloneEnvVars = async ({ api, force, siteFrom, siteTo }): Promise<boolean> => {
   const [envelopeFrom, envelopeTo] = await Promise.all([
     api.getEnvVars({ accountId: siteFrom.account_slug, siteId: siteFrom.id }),
     api.getEnvVars({ accountId: siteTo.account_slug, siteId: siteTo.id }),
@@ -36,6 +37,10 @@ const cloneEnvVars = async ({ api, siteFrom, siteTo }): Promise<boolean> => {
   const siteId = siteTo.id
   // @ts-expect-error TS(7031) FIXME: Binding element 'key' implicitly has an 'any' type... Remove this comment to see the full error message
   const envVarsToDelete = envelopeTo.filter(({ key }) => keysFrom.includes(key))
+
+  if (envVarsToDelete.length !== 0 && Boolean(force) === false) {
+    await envClonePrompts(siteTo.id, envVarsToDelete)
+  }
   // delete marked env vars in parallel
   // @ts-expect-error TS(7031) FIXME: Binding element 'key' implicitly has an 'any' type... Remove this comment to see the full error message
   await Promise.all(envVarsToDelete.map(({ key }) => api.deleteEnvVar({ accountId, siteId, key })))
@@ -47,12 +52,12 @@ const cloneEnvVars = async ({ api, siteFrom, siteTo }): Promise<boolean> => {
     // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
     throw error.json ? error.json.msg : error
   }
-
   return true
 }
 
 export const envClone = async (options: OptionValues, command: BaseCommand) => {
   const { api, site } = command.netlify
+  const { force } = options
 
   if (!site.id && !options.from) {
     log(
@@ -81,7 +86,7 @@ export const envClone = async (options: OptionValues, command: BaseCommand) => {
     return false
   }
 
-  const success = await cloneEnvVars({ api, siteFrom, siteTo })
+  const success = await cloneEnvVars({ api, siteFrom, siteTo, force })
 
   if (!success) {
     return false

src/commands/env/env-set.ts

@@ -2,14 +2,15 @@ import { OptionValues } from 'commander'
 
 import { chalk, error, log, logJson } from '../../utils/command-helpers.js'
 import { AVAILABLE_CONTEXTS, AVAILABLE_SCOPES, translateFromEnvelopeToMongo } from '../../utils/env/index.js'
+import { envSetPrompts } from '../../utils/prompts/env-set-prompts.js'
 import BaseCommand from '../base-command.js'
 
 /**
  * Updates the env for a site configured with Envelope with a new key/value pair
  * @returns {Promise<object | boolean>}
  */
 // @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
-const setInEnvelope = async ({ api, context, key, scope, secret, siteInfo, value }) => {
+const setInEnvelope = async ({ api, context, force, key, scope, secret, siteInfo, value }) => {
   const accountId = siteInfo.account_slug
   const siteId = siteInfo.id
 
@@ -29,6 +30,8 @@ const setInEnvelope = async ({ api, context, key, scope, secret, siteInfo, value
   }
 
   // fetch envelope env vars
+  // const userData = await api.getAccount({accountId})
+  // log(userData)
   const envelopeVariables = await api.getEnvVars({ accountId, siteId })
   const contexts = context || ['all']
   let scopes = scope || AVAILABLE_SCOPES
@@ -48,6 +51,11 @@ const setInEnvelope = async ({ api, context, key, scope, secret, siteInfo, value
   // @ts-expect-error TS(7006) FIXME: Parameter 'envVar' implicitly has an 'any' type.
   const existing = envelopeVariables.find((envVar) => envVar.key === key)
 
+  // Checks if --force is passed and if it is an existing variaible, then we need to prompt the user
+  if (Boolean(force) === false && existing) {
+    await envSetPrompts(key)
+  }
+
   const params = { accountId, siteId, key }
   try {
     if (existing) {
@@ -108,11 +116,9 @@ const setInEnvelope = async ({ api, context, key, scope, secret, siteInfo, value
 }
 
 export const envSet = async (key: string, value: string, options: OptionValues, command: BaseCommand) => {
-  const { context, scope, secret } = options
-
+  const { context, force, scope, secret } = options
   const { api, cachedConfig, site } = command.netlify
   const siteId = site.id
-
   if (!siteId) {
     log('No site id found, please run inside a site folder or `netlify link`')
     return false
@@ -121,7 +127,7 @@ export const envSet = async (key: string, value: string, options: OptionValues,
   const { siteInfo } = cachedConfig
 
   // Get current environment variables set in the UI
-  const finalEnv = await setInEnvelope({ api, siteInfo, key, value, context, scope, secret })
+  const finalEnv = await setInEnvelope({ api, siteInfo, force, key, value, context, scope, secret })
 
   if (!finalEnv) {
     return false