netlify-cli 17.3.2 → 17.4.0

package/src/commands/addons/addons-auth.mjs

@@ -1,8 +1,6 @@
-// @ts-check
-import { ADDON_VALIDATION, prepareAddonCommand } from '../../utils/addons/prepare.mjs'
-import { exit, log } from '../../utils/command-helpers.mjs'
-import openBrowser from '../../utils/open-browser.mjs'
-
+import { ADDON_VALIDATION, prepareAddonCommand } from '../../utils/addons/prepare.mjs';
+import { exit, log } from '../../utils/command-helpers.mjs';
+import openBrowser from '../../utils/open-browser.mjs';
 /**
  * The addons:auth command
  * @param {string} addonName
@@ -10,39 +8,38 @@ import openBrowser from '../../utils/open-browser.mjs'
  * @param {import('../base-command.mjs').default} command
  * @returns {Promise<boolean>}
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'addonName' implicitly has an 'any' type... Remove this comment to see the full error message
 const addonsAuth = async (addonName, options, command) => {
-  const { addon } = await prepareAddonCommand({
-    command,
-    addonName,
-    // @ts-ignore when migrating to typescript this should be a const enum
-    validation: ADDON_VALIDATION.EXISTS,
-  })
-
-  if (!addon.auth_url) {
-    log(`No Admin URL found for the "${addonName} add-on"`)
-    return false
-  }
-
-  log()
-  log(`Opening ${addonName} add-on admin URL:`)
-  log()
-  log(addon.auth_url)
-  log()
-  await openBrowser({ url: addon.auth_url })
-  exit()
-}
-
+    const { addon } = await prepareAddonCommand({
+        command,
+        addonName,
+        validation: ADDON_VALIDATION.EXISTS,
+    });
+    if (!addon.auth_url) {
+        log(`No Admin URL found for the "${addonName} add-on"`);
+        return false;
+    }
+    log();
+    log(`Opening ${addonName} add-on admin URL:`);
+    log();
+    log(addon.auth_url);
+    log();
+    // @ts-expect-error TS(2345) FIXME: Argument of type '{ url: any; }' is not assignable... Remove this comment to see the full error message
+    await openBrowser({ url: addon.auth_url });
+    exit();
+};
 /**
  * Creates the `netlify addons:auth` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createAddonsAuthCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createAddonsAuthCommand = (program) => program
     .command('addons:auth', { hidden: true })
     .alias('addon:auth')
     .argument('<name>', 'Add-on slug')
     .description('Login to add-on provider')
+    // @ts-expect-error TS(7006) FIXME: Parameter 'addonName' implicitly has an 'any' type... Remove this comment to see the full error message
     .action(async (addonName, options, command) => {
-      await addonsAuth(addonName, options, command)
-    })
+    await addonsAuth(addonName, options, command);
+});

package/src/commands/addons/addons-config.mjs

@@ -1,42 +1,40 @@
-// @ts-check
-import inquirer from 'inquirer'
-import isEmpty from 'lodash/isEmpty.js'
-
-import compare from '../../utils/addons/compare.mjs'
-import diffValues from '../../utils/addons/diffs/index.mjs'
-import { ADDON_VALIDATION, prepareAddonCommand } from '../../utils/addons/prepare.mjs'
-import generatePrompts from '../../utils/addons/prompts.mjs'
-import { renderConfigValues } from '../../utils/addons/render.mjs'
-import { missingConfigValues, requiredConfigValues, updateConfigValues } from '../../utils/addons/validation.mjs'
-import { chalk, error, log } from '../../utils/command-helpers.mjs'
-import { parseRawFlags } from '../../utils/parse-raw-flags.mjs'
-
+import inquirer from 'inquirer';
+import isEmpty from 'lodash/isEmpty.js';
+import compare from '../../utils/addons/compare.mjs';
+import diffValues from '../../utils/addons/diffs/index.mjs';
+import { ADDON_VALIDATION, prepareAddonCommand } from '../../utils/addons/prepare.mjs';
+import generatePrompts from '../../utils/addons/prompts.mjs';
+import { renderConfigValues } from '../../utils/addons/render.mjs';
+import { missingConfigValues, requiredConfigValues, updateConfigValues } from '../../utils/addons/validation.mjs';
+import { chalk, error, log } from '../../utils/command-helpers.mjs';
+import { parseRawFlags } from '../../utils/parse-raw-flags.mjs';
+// @ts-expect-error TS(7031) FIXME: Binding element 'addonName' implicitly has an 'any... Remove this comment to see the full error message
 const update = async function ({ addonName, api, currentConfig, instanceId, newConfig, siteId }) {
-  const codeDiff = diffValues(currentConfig, newConfig)
-  if (!codeDiff) {
-    log('No changes, exiting early')
-    return false
-  }
-  log()
-  const msg = `Updating ${addonName} add-on config values...`
-  log(`${chalk.white.bold(msg)}`)
-  log()
-  log(`${codeDiff}\n`)
-  log()
-
-  try {
-    await api.updateServiceInstance({
-      siteId,
-      addon: addonName,
-      instanceId,
-      body: { config: newConfig },
-    })
-    log(`Add-on "${addonName}" successfully updated`)
-  } catch (error_) {
-    error(error_.message)
-  }
-}
-
+    const codeDiff = diffValues(currentConfig, newConfig);
+    if (!codeDiff) {
+        log('No changes, exiting early');
+        return false;
+    }
+    log();
+    const msg = `Updating ${addonName} add-on config values...`;
+    log(`${chalk.white.bold(msg)}`);
+    log();
+    log(`${codeDiff}\n`);
+    log();
+    try {
+        await api.updateServiceInstance({
+            siteId,
+            addon: addonName,
+            instanceId,
+            body: { config: newConfig },
+        });
+        log(`Add-on "${addonName}" successfully updated`);
+    }
+    catch (error_) {
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        error(error_.message);
+    }
+};
 /**
  * The addons:config command
  * @param {string} addonName
@@ -44,136 +42,129 @@ const update = async function ({ addonName, api, currentConfig, instanceId, newC
  * @param {import('../base-command.mjs').default} command
  * @returns {Promise<boolean>}
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'addonName' implicitly has an 'any' type... Remove this comment to see the full error message
 const addonsConfig = async (addonName, options, command) => {
-  const { addon, manifest, siteData } = await prepareAddonCommand({
-    command,
-    addonName,
-    // @ts-ignore
-    validation: ADDON_VALIDATION.EXISTS,
-  })
-
-  const { api, site } = command.netlify
-  const siteId = site.id
-
-  const hasConfig = !isEmpty(manifest.config)
-  // Parse flags
-  const rawFlags = parseRawFlags(command.args)
-  // Get Existing Config
-  const currentConfig = addon.config || {}
-
-  const words = `Current "${addonName} add-on" Settings:`
-  log(` ${chalk.yellowBright.bold(words)}`)
-  if (hasConfig) {
-    if (!rawFlags.silent) {
-      renderConfigValues(addonName, manifest.config, currentConfig)
-    }
-  } else {
-    // For addons without manifest. TODO remove once we enforce manifests
-    Object.keys(currentConfig).forEach((key) => {
-      log(`${key} - ${currentConfig[key]}`)
-    })
-  }
-
-  if (hasConfig) {
-    const required = requiredConfigValues(manifest.config)
-    const missingValues = missingConfigValues(required, rawFlags)
-
-    /* Config set by command line flags */
-    if (rawFlags && missingValues.length === 0) {
-      const newConfig = updateConfigValues(manifest.config, currentConfig, rawFlags)
-
-      await update({
+    const { addon, manifest, siteData } = await prepareAddonCommand({
+        command,
         addonName,
-        currentConfig,
-        newConfig,
-        siteId,
-        instanceId: addon.id,
-        api,
-      })
-      return false
-    }
-
-    const updatePrompt = await inquirer.prompt([
-      {
-        type: 'confirm',
-        name: 'updateNow',
-        message: `Do you want to update config values?`,
-        default: false,
-      },
-    ])
-    if (!updatePrompt.updateNow) {
-      log('Sounds good! Exiting configuration...')
-      return false
+        validation: ADDON_VALIDATION.EXISTS,
+    });
+    const { api, site } = command.netlify;
+    const siteId = site.id;
+    const hasConfig = !isEmpty(manifest.config);
+    // Parse flags
+    const rawFlags = parseRawFlags(command.args);
+    // Get Existing Config
+    const currentConfig = addon.config || {};
+    const words = `Current "${addonName} add-on" Settings:`;
+    log(` ${chalk.yellowBright.bold(words)}`);
+    if (hasConfig) {
+        if (!rawFlags.silent) {
+            renderConfigValues(addonName, manifest.config, currentConfig);
+        }
     }
-    log()
-    log(` - Hit ${chalk.white.bold('enter')} to keep the existing value in (parentheses)`)
-    log(` - Hit ${chalk.white.bold('down arrow')} to remove the value`)
-    log(` - Hit ${chalk.white.bold('ctrl + C')} to cancel & exit configuration`)
-    log()
-    log(` You will need to verify the changed before we push them to your live site!`)
-    log()
-    const prompts = generatePrompts({
-      config: manifest.config,
-      configValues: currentConfig,
-    })
-    const userInput = await inquirer.prompt(prompts)
-    // Merge user input with the flags specified
-    const newConfig = updateConfigValues(manifest.config, currentConfig, userInput)
-
-    const diffs = compare(currentConfig, newConfig)
-    // log('compare', diffs)
-    if (diffs.isEqual) {
-      log(`No changes. exiting early`)
-      return false
+    else {
+        // For addons without manifest. TODO remove once we enforce manifests
+        Object.keys(currentConfig).forEach((key) => {
+            log(`${key} - ${currentConfig[key]}`);
+        });
     }
-    log()
-    log(`${chalk.yellowBright.bold.underline('Confirm your updates:')}`)
-    log()
-    diffs.keys.forEach((key) => {
-      const { newValue, oldValue } = diffs.diffs[key]
-      const oldVal = oldValue || 'NO VALUE'
-      log(`${chalk.cyan(key)} changed from ${chalk.whiteBright(oldVal)} to ${chalk.green(newValue)}`)
-    })
-    log()
-
-    const confirmPrompt = await inquirer.prompt([
-      {
-        type: 'confirm',
-        name: 'confirmChange',
-        message: `Do you want to publish the updated "${addonName} add-on" settings for ${chalk.cyan(siteData.name)}?`,
-        default: false,
-      },
-    ])
-
-    if (!confirmPrompt.confirmChange) {
-      log('Canceling changes... You are good to go!')
-      return false
+    if (hasConfig) {
+        const required = requiredConfigValues(manifest.config);
+        const missingValues = missingConfigValues(required, rawFlags);
+        /* Config set by command line flags */
+        if (rawFlags && missingValues.length === 0) {
+            const newConfig = updateConfigValues(manifest.config, currentConfig, rawFlags);
+            await update({
+                addonName,
+                currentConfig,
+                newConfig,
+                siteId,
+                instanceId: addon.id,
+                api,
+            });
+            return false;
+        }
+        const updatePrompt = await inquirer.prompt([
+            {
+                type: 'confirm',
+                name: 'updateNow',
+                message: `Do you want to update config values?`,
+                default: false,
+            },
+        ]);
+        if (!updatePrompt.updateNow) {
+            log('Sounds good! Exiting configuration...');
+            return false;
+        }
+        log();
+        log(` - Hit ${chalk.white.bold('enter')} to keep the existing value in (parentheses)`);
+        log(` - Hit ${chalk.white.bold('down arrow')} to remove the value`);
+        log(` - Hit ${chalk.white.bold('ctrl + C')} to cancel & exit configuration`);
+        log();
+        log(` You will need to verify the changed before we push them to your live site!`);
+        log();
+        const prompts = generatePrompts({
+            config: manifest.config,
+            configValues: currentConfig,
+        });
+        const userInput = await inquirer.prompt(prompts);
+        // Merge user input with the flags specified
+        const newConfig = updateConfigValues(manifest.config, currentConfig, userInput);
+        const diffs = compare(currentConfig, newConfig);
+        // log('compare', diffs)
+        // @ts-expect-error TS(2339) FIXME: Property 'isEqual' does not exist on type 'string'... Remove this comment to see the full error message
+        if (diffs.isEqual) {
+            log(`No changes. exiting early`);
+            return false;
+        }
+        log();
+        log(`${chalk.yellowBright.bold.underline('Confirm your updates:')}`);
+        log();
+        // @ts-expect-error TS(2339) FIXME: Property 'keys' does not exist on type 'string'.
+        diffs.keys.forEach((key) => {
+            // @ts-expect-error TS(2339) FIXME: Property 'diffs' does not exist on type 'string'.
+            const { newValue, oldValue } = diffs.diffs[key];
+            const oldVal = oldValue || 'NO VALUE';
+            log(`${chalk.cyan(key)} changed from ${chalk.whiteBright(oldVal)} to ${chalk.green(newValue)}`);
+        });
+        log();
+        const confirmPrompt = await inquirer.prompt([
+            {
+                type: 'confirm',
+                name: 'confirmChange',
+                message: `Do you want to publish the updated "${addonName} add-on" settings for ${chalk.cyan(siteData.name)}?`,
+                default: false,
+            },
+        ]);
+        if (!confirmPrompt.confirmChange) {
+            log('Canceling changes... You are good to go!');
+            return false;
+        }
+        await update({
+            addonName,
+            currentConfig,
+            newConfig,
+            siteId,
+            instanceId: addon.id,
+            api,
+        });
     }
-
-    await update({
-      addonName,
-      currentConfig,
-      newConfig,
-      siteId,
-      instanceId: addon.id,
-      api,
-    })
-  }
-}
-
+};
 /**
  * Creates the `netlify addons:config` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createAddonsConfigCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createAddonsConfigCommand = (program) => program
     .command('addons:config', { hidden: true })
     .alias('addon:config')
     .argument('<name>', 'Add-on namespace')
     .description('Configure add-on settings')
     // allow for any flags. Handy for variadic configuration options
     .allowUnknownOption(true)
+    // @ts-expect-error TS(7006) FIXME: Parameter 'addonName' implicitly has an 'any' type... Remove this comment to see the full error message
     .action(async (addonName, options, command) => {
-      await addonsConfig(addonName, options, command)
-    })
+    await addonsConfig(addonName, options, command);
+});

package/src/commands/addons/addons-create.mjs

@@ -1,31 +1,30 @@
-// @ts-check
-import inquirer from 'inquirer'
-import isEmpty from 'lodash/isEmpty.js'
-
-import { ADDON_VALIDATION, prepareAddonCommand } from '../../utils/addons/prepare.mjs'
-import generatePrompts from '../../utils/addons/prompts.mjs'
-import { renderConfigValues, renderMissingValues } from '../../utils/addons/render.mjs'
-import { missingConfigValues, requiredConfigValues, updateConfigValues } from '../../utils/addons/validation.mjs'
-import { chalk, error, log } from '../../utils/command-helpers.mjs'
-import { parseRawFlags } from '../../utils/parse-raw-flags.mjs'
-
+import inquirer from 'inquirer';
+import isEmpty from 'lodash/isEmpty.js';
+import { ADDON_VALIDATION, prepareAddonCommand } from '../../utils/addons/prepare.mjs';
+import generatePrompts from '../../utils/addons/prompts.mjs';
+import { renderConfigValues, renderMissingValues } from '../../utils/addons/render.mjs';
+import { missingConfigValues, requiredConfigValues, updateConfigValues } from '../../utils/addons/validation.mjs';
+import { chalk, error, log } from '../../utils/command-helpers.mjs';
+import { parseRawFlags } from '../../utils/parse-raw-flags.mjs';
+// @ts-expect-error TS(7031) FIXME: Binding element 'addonName' implicitly has an 'any... Remove this comment to see the full error message
 const createAddon = async ({ addonName, api, config, siteData, siteId }) => {
-  try {
-    const response = await api.createServiceInstance({
-      siteId,
-      addon: addonName,
-      body: { config },
-    })
-    log(`Add-on "${addonName}" created for ${siteData.name}`)
-    if (response.config && response.config.message) {
-      log()
-      log(`${response.config.message}`)
+    try {
+        const response = await api.createServiceInstance({
+            siteId,
+            addon: addonName,
+            body: { config },
+        });
+        log(`Add-on "${addonName}" created for ${siteData.name}`);
+        if (response.config && response.config.message) {
+            log();
+            log(`${response.config.message}`);
+        }
     }
-  } catch (error_) {
-    error(error_.message)
-  }
-}
-
+    catch (error_) {
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        error(error_.message);
+    }
+};
 /**
  * The addons:create command
  * @param {string} addonName
@@ -33,98 +32,85 @@ const createAddon = async ({ addonName, api, config, siteData, siteId }) => {
  * @param {import('../base-command.mjs').default} command
  * @returns {Promise<boolean>}
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'addonName' implicitly has an 'any' type... Remove this comment to see the full error message
 const addonsCreate = async (addonName, options, command) => {
-  const { manifest, siteData } = await prepareAddonCommand({
-    command,
-    addonName,
-    // @ts-ignore
-    validation: ADDON_VALIDATION.NOT_EXISTS,
-  })
-
-  const { api, site } = command.netlify
-  const siteId = site.id
-
-  // GET flags from `raw` data
-  const rawFlags = parseRawFlags(command.args)
-  const hasConfig = !isEmpty(manifest.config)
-
-  let configValues = rawFlags
-
-  if (hasConfig) {
-    const required = requiredConfigValues(manifest.config)
-    const missingValues = missingConfigValues(required, rawFlags)
-    log(`Starting the setup for "${addonName} add-on"`)
-    log()
-
-    if (Object.keys(rawFlags).length !== 0) {
-      const newConfig = updateConfigValues(manifest.config, {}, rawFlags)
-
-      if (missingValues.length !== 0) {
-        /* Warn user of missing required values */
-        log(`${chalk.redBright.underline.bold(`Error: Missing required configuration for "${addonName} add-on"`)}`)
-        log()
-        renderMissingValues(missingValues, manifest)
-        log()
-        const msg = `netlify addons:create ${addonName}`
-        log(`Please supply the configuration values as CLI flags`)
-        log()
-        log(`Alternatively, you can run ${chalk.cyan(msg)} with no flags to walk through the setup steps`)
-        log()
-        return false
-      }
-
-      await createAddon({ api, siteId, addonName, config: newConfig, siteData })
-
-      return false
-    }
-
-    const words = `The ${addonName} add-on has the following configurable options:`
-    log(` ${chalk.yellowBright.bold(words)}`)
-    renderConfigValues(addonName, manifest.config)
-    log()
-    log(` ${chalk.greenBright.bold('Lets configure those!')}`)
-
-    log()
-    log(` - Hit ${chalk.white.bold('enter')} to confirm value or set empty value`)
-    log(` - Hit ${chalk.white.bold('ctrl + C')} to cancel & exit configuration`)
-    log()
-
-    const prompts = generatePrompts({
-      config: manifest.config,
-      configValues: rawFlags,
-    })
-
-    const userInput = await inquirer.prompt(prompts)
-    // Merge user input with the flags specified
-    configValues = updateConfigValues(manifest.config, rawFlags, userInput)
-    const missingRequiredValues = missingConfigValues(required, configValues)
-    if (missingRequiredValues && missingRequiredValues.length !== 0) {
-      missingRequiredValues.forEach((val) => {
-        log(`Missing required value "${val}". Please run the command again`)
-      })
-      return false
+    const { manifest, siteData } = await prepareAddonCommand({
+        command,
+        addonName,
+        validation: ADDON_VALIDATION.NOT_EXISTS,
+    });
+    const { api, site } = command.netlify;
+    const siteId = site.id;
+    // GET flags from `raw` data
+    const rawFlags = parseRawFlags(command.args);
+    const hasConfig = !isEmpty(manifest.config);
+    let configValues = rawFlags;
+    if (hasConfig) {
+        const required = requiredConfigValues(manifest.config);
+        const missingValues = missingConfigValues(required, rawFlags);
+        log(`Starting the setup for "${addonName} add-on"`);
+        log();
+        if (Object.keys(rawFlags).length !== 0) {
+            const newConfig = updateConfigValues(manifest.config, {}, rawFlags);
+            if (missingValues.length !== 0) {
+                /* Warn user of missing required values */
+                log(`${chalk.redBright.underline.bold(`Error: Missing required configuration for "${addonName} add-on"`)}`);
+                log();
+                renderMissingValues(missingValues, manifest);
+                log();
+                const msg = `netlify addons:create ${addonName}`;
+                log(`Please supply the configuration values as CLI flags`);
+                log();
+                log(`Alternatively, you can run ${chalk.cyan(msg)} with no flags to walk through the setup steps`);
+                log();
+                return false;
+            }
+            await createAddon({ api, siteId, addonName, config: newConfig, siteData });
+            return false;
+        }
+        const words = `The ${addonName} add-on has the following configurable options:`;
+        log(` ${chalk.yellowBright.bold(words)}`);
+        // @ts-expect-error TS(2554) FIXME: Expected 3 arguments, but got 2.
+        renderConfigValues(addonName, manifest.config);
+        log();
+        log(` ${chalk.greenBright.bold('Lets configure those!')}`);
+        log();
+        log(` - Hit ${chalk.white.bold('enter')} to confirm value or set empty value`);
+        log(` - Hit ${chalk.white.bold('ctrl + C')} to cancel & exit configuration`);
+        log();
+        const prompts = generatePrompts({
+            config: manifest.config,
+            configValues: rawFlags,
+        });
+        const userInput = await inquirer.prompt(prompts);
+        // Merge user input with the flags specified
+        configValues = updateConfigValues(manifest.config, rawFlags, userInput);
+        const missingRequiredValues = missingConfigValues(required, configValues);
+        if (missingRequiredValues && missingRequiredValues.length !== 0) {
+            // @ts-expect-error TS(7006) FIXME: Parameter 'val' implicitly has an 'any' type.
+            missingRequiredValues.forEach((val) => {
+                log(`Missing required value "${val}". Please run the command again`);
+            });
+            return false;
+        }
     }
-  }
-
-  await createAddon({ api, siteId, addonName, config: configValues, siteData })
-}
-
+    await createAddon({ api, siteId, addonName, config: configValues, siteData });
+};
 /**
  * Creates the `netlify addons:create` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createAddonsCreateCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createAddonsCreateCommand = (program) => program
     .command('addons:create', { hidden: true })
     .alias('addon:create')
     .argument('<name>', 'Add-on namespace')
-    .description(
-      `Add an add-on extension to your site
-Add-ons are a way to extend the functionality of your Netlify site`,
-    )
+    .description(`Add an add-on extension to your site
+Add-ons are a way to extend the functionality of your Netlify site`)
     // allow for any flags. Handy for variadic configuration options
     .allowUnknownOption(true)
+    // @ts-expect-error TS(7006) FIXME: Parameter 'addonName' implicitly has an 'any' type... Remove this comment to see the full error message
     .action(async (addonName, options, command) => {
-      await addonsCreate(addonName, options, command)
-    })
+    await addonsCreate(addonName, options, command);
+});