netlify-cli 17.3.1 → 17.4.0

package/src/commands/main.mjs

@@ -1,227 +1,192 @@
-// @ts-check
-import process from 'process'
-
-import { Option } from 'commander'
-import envinfo from 'envinfo'
-import { closest } from 'fastest-levenshtein'
-import inquirer from 'inquirer'
-
-import { BANG, chalk, error, exit, log, NETLIFY_CYAN, USER_AGENT, warn } from '../utils/command-helpers.mjs'
-import execa from '../utils/execa.mjs'
-import getGlobalConfig from '../utils/get-global-config.mjs'
-import getPackageJson from '../utils/get-package-json.mjs'
-import { track, reportError } from '../utils/telemetry/index.mjs'
-
-import { createAddonsCommand } from './addons/index.mjs'
-import { createApiCommand } from './api/index.mjs'
-import BaseCommand from './base-command.mjs'
-import { createBuildCommand } from './build/index.mjs'
-import { createCompletionCommand } from './completion/index.mjs'
-import { createDeployCommand } from './deploy/index.mjs'
-import { createDevCommand } from './dev/index.mjs'
-import { createEnvCommand } from './env/index.mjs'
-import { createFunctionsCommand } from './functions/index.mjs'
-import { createInitCommand } from './init/index.mjs'
-import { createIntegrationCommand } from './integration/index.mjs'
-import { createLinkCommand } from './link/index.mjs'
-import { createLmCommand } from './lm/index.mjs'
-import { createLoginCommand } from './login/index.mjs'
-import { createLogoutCommand } from './logout/index.mjs'
-import { createOpenCommand } from './open/index.mjs'
-import { createRecipesCommand } from './recipes/index.mjs'
-import { createServeCommand } from './serve/serve.mjs'
-import { createSitesCommand } from './sites/index.mjs'
-import { createStatusCommand } from './status/index.mjs'
-import { createSwitchCommand } from './switch/index.mjs'
-import { createUnlinkCommand } from './unlink/index.mjs'
-import { createWatchCommand } from './watch/index.mjs'
-
-const SUGGESTION_TIMEOUT = 1e4
-
+import process from 'process';
+import { Option } from 'commander';
+// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'envi... Remove this comment to see the full error message
+import envinfo from 'envinfo';
+import { closest } from 'fastest-levenshtein';
+import inquirer from 'inquirer';
+import { BANG, chalk, error, exit, log, NETLIFY_CYAN, USER_AGENT, warn } from '../utils/command-helpers.mjs';
+// @ts-expect-error TS(7034) FIXME: Variable 'execa' implicitly has type 'any' in some... Remove this comment to see the full error message
+import execa from '../utils/execa.mjs';
+import getGlobalConfig from '../utils/get-global-config.mjs';
+import getPackageJson from '../utils/get-package-json.mjs';
+import { track, reportError } from '../utils/telemetry/index.mjs';
+import { createAddonsCommand } from './addons/index.mjs';
+import { createApiCommand } from './api/index.mjs';
+import BaseCommand from './base-command.mjs';
+import { createBlobsCommand } from './blobs/blobs.mjs';
+import { createBuildCommand } from './build/index.mjs';
+import { createCompletionCommand } from './completion/index.mjs';
+import { createDeployCommand } from './deploy/index.mjs';
+import { createDevCommand } from './dev/index.mjs';
+import { createEnvCommand } from './env/index.mjs';
+import { createFunctionsCommand } from './functions/index.mjs';
+import { createInitCommand } from './init/index.mjs';
+import { createIntegrationCommand } from './integration/index.mjs';
+import { createLinkCommand } from './link/index.mjs';
+import { createLmCommand } from './lm/index.mjs';
+import { createLoginCommand } from './login/index.mjs';
+import { createLogoutCommand } from './logout/index.mjs';
+import { createOpenCommand } from './open/index.mjs';
+import { createRecipesCommand } from './recipes/index.mjs';
+import { createServeCommand } from './serve/serve.mjs';
+import { createSitesCommand } from './sites/index.mjs';
+import { createStatusCommand } from './status/index.mjs';
+import { createSwitchCommand } from './switch/index.mjs';
+import { createUnlinkCommand } from './unlink/index.mjs';
+import { createWatchCommand } from './watch/index.mjs';
+const SUGGESTION_TIMEOUT = 1e4;
 process.on('uncaughtException', async (err) => {
-  console.log('')
-  error(
-    `${chalk.red(
-      'Netlify CLI has terminated unexpectedly',
-    )}\nThis is a problem with the Netlify CLI, not with your application.\nIf you recently updated the CLI, consider reverting to an older version by running:\n\n${chalk.bold(
-      'npm install -g netlify-cli@VERSION',
-    )}\n\nYou can use any version from ${chalk.underline(
-      'https://ntl.fyi/cli-versions',
-    )}.\n\nPlease report this problem at ${chalk.underline(
-      'https://ntl.fyi/cli-error',
-    )} including the error details below.\n`,
-    { exit: false },
-  )
-
-  const systemInfo = await getSystemInfo()
-
-  console.log(chalk.dim(err.stack || err))
-  console.log(chalk.dim(systemInfo))
-
-  reportError(err, { severity: 'error' })
-
-  process.exit(1)
-})
-
-const getSystemInfo = () =>
-  envinfo.run({
+    console.log('');
+    error(`${chalk.red('Netlify CLI has terminated unexpectedly')}\nThis is a problem with the Netlify CLI, not with your application.\nIf you recently updated the CLI, consider reverting to an older version by running:\n\n${chalk.bold('npm install -g netlify-cli@VERSION')}\n\nYou can use any version from ${chalk.underline('https://ntl.fyi/cli-versions')}.\n\nPlease report this problem at ${chalk.underline('https://ntl.fyi/cli-error')} including the error details below.\n`, { exit: false });
+    const systemInfo = await getSystemInfo();
+    console.log(chalk.dim(err.stack || err));
+    console.log(chalk.dim(systemInfo));
+    reportError(err, { severity: 'error' });
+    process.exit(1);
+});
+const getSystemInfo = () => envinfo.run({
     System: ['OS', 'CPU'],
     Binaries: ['Node', 'Yarn', 'npm'],
     Browsers: ['Chrome', 'Edge', 'Firefox', 'Safari'],
     npmGlobalPackages: ['netlify-cli'],
-  })
-
+});
 const getVersionPage = async () => {
-  const data = await getSystemInfo()
-
-  return `
+    const data = await getSystemInfo();
+    return `
 ────────────────────┐
  Environment Info   │
 ────────────────────┘
 ${data}
 ${USER_AGENT}
-`
-}
-
+`;
+};
 /**
  * The main CLI command without any command (root action)
  * @param {import('commander').OptionValues} options
  * @param {import('./base-command.mjs').default} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 const mainCommand = async function (options, command) {
-  const globalConfig = await getGlobalConfig()
-
-  if (options.telemetryDisable) {
-    globalConfig.set('telemetryDisabled', true)
-    console.log('Netlify telemetry has been disabled')
-    console.log('You can renable it anytime with the --telemetry-enable flag')
-    exit()
-  }
-  if (options.telemetryEnable) {
-    globalConfig.set('telemetryDisabled', false)
-    console.log('Netlify telemetry has been enabled')
-    console.log('You can disable it anytime with the --telemetry-disable flag')
-    await track('user_telemetryEnabled')
-    exit()
-  }
-
-  if (command.args[0] === 'version' || options.version) {
-    if (options.verbose) {
-      const versionPage = await getVersionPage()
-      log(versionPage)
+    const globalConfig = await getGlobalConfig();
+    if (options.telemetryDisable) {
+        globalConfig.set('telemetryDisabled', true);
+        console.log('Netlify telemetry has been disabled');
+        console.log('You can renable it anytime with the --telemetry-enable flag');
+        exit();
     }
-    log(USER_AGENT)
-    exit()
-  }
-
-  // if no command show the header and the help
-  if (command.args.length === 0) {
-    const pkg = await getPackageJson()
-
-    const title = `${chalk.bgBlack.cyan('⬥ Netlify CLI')}`
-    const docsMsg = `${chalk.greenBright('Read the docs:')} https://docs.netlify.com/cli/get-started/`
-    const supportMsg = `${chalk.magentaBright('Support and bugs:')} ${pkg.bugs.url}`
-
-    console.log()
-    console.log(title)
-    console.log(docsMsg)
-    console.log(supportMsg)
-    console.log()
-
-    command.help()
-  }
-
-  if (command.args[0] === 'help') {
-    if (command.args[1]) {
-      const subCommand = command.commands.find((cmd) => cmd.name() === command.args[1])
-      if (!subCommand) {
-        error(`command ${command.args[1]} not found`)
-      }
-      subCommand.help()
+    if (options.telemetryEnable) {
+        globalConfig.set('telemetryDisabled', false);
+        console.log('Netlify telemetry has been enabled');
+        console.log('You can disable it anytime with the --telemetry-disable flag');
+        await track('user_telemetryEnabled');
+        exit();
     }
-    command.help()
-  }
-
-  warn(`${chalk.yellow(command.args[0])} is not a ${command.name()} command.`)
-
-  const allCommands = command.commands.map((cmd) => cmd.name())
-  const suggestion = closest(command.args[0], allCommands)
-
-  const applySuggestion = await new Promise((resolve) => {
-    const prompt = inquirer.prompt({
-      type: 'confirm',
-      name: 'suggestion',
-      message: `Did you mean ${chalk.blue(suggestion)}`,
-      default: false,
-    })
-
-    setTimeout(() => {
-      // @ts-ignore
-      prompt.ui.close()
-      resolve(false)
-    }, SUGGESTION_TIMEOUT)
-
-    // eslint-disable-next-line promise/catch-or-return
-    prompt.then((value) => resolve(value.suggestion))
-  })
-  // create new log line
-  log()
-
-  if (!applySuggestion) {
-    error(`Run ${NETLIFY_CYAN(`${command.name()} help`)} for a list of available commands.`)
-  }
-
-  await execa(process.argv[0], [process.argv[1], suggestion], { stdio: 'inherit' })
-}
-
+    if (command.args[0] === 'version' || options.version) {
+        if (options.verbose) {
+            const versionPage = await getVersionPage();
+            log(versionPage);
+        }
+        log(USER_AGENT);
+        exit();
+    }
+    // if no command show the header and the help
+    if (command.args.length === 0) {
+        const pkg = await getPackageJson();
+        const title = `${chalk.bgBlack.cyan('⬥ Netlify CLI')}`;
+        const docsMsg = `${chalk.greenBright('Read the docs:')} https://ntl.fyi/get-started-with-netlify-cli`;
+        const supportMsg = `${chalk.magentaBright('Support and bugs:')} ${pkg.bugs.url}`;
+        console.log();
+        console.log(title);
+        console.log(docsMsg);
+        console.log(supportMsg);
+        console.log();
+        command.help();
+    }
+    if (command.args[0] === 'help') {
+        if (command.args[1]) {
+            // @ts-expect-error TS(7006) FIXME: Parameter 'cmd' implicitly has an 'any' type.
+            const subCommand = command.commands.find((cmd) => cmd.name() === command.args[1]);
+            if (!subCommand) {
+                error(`command ${command.args[1]} not found`);
+            }
+            subCommand.help();
+        }
+        command.help();
+    }
+    warn(`${chalk.yellow(command.args[0])} is not a ${command.name()} command.`);
+    // @ts-expect-error TS(7006) FIXME: Parameter 'cmd' implicitly has an 'any' type.
+    const allCommands = command.commands.map((cmd) => cmd.name());
+    const suggestion = closest(command.args[0], allCommands);
+    const applySuggestion = await new Promise((resolve) => {
+        const prompt = inquirer.prompt({
+            type: 'confirm',
+            name: 'suggestion',
+            message: `Did you mean ${chalk.blue(suggestion)}`,
+            default: false,
+        });
+        setTimeout(() => {
+            // @ts-expect-error TS(2445) FIXME: Property 'close' is protected and only accessible ... Remove this comment to see the full error message
+            prompt.ui.close();
+            resolve(false);
+        }, SUGGESTION_TIMEOUT);
+        // eslint-disable-next-line promise/catch-or-return
+        prompt.then((value) => resolve(value.suggestion));
+    });
+    // create new log line
+    log();
+    if (!applySuggestion) {
+        error(`Run ${NETLIFY_CYAN(`${command.name()} help`)} for a list of available commands.`);
+    }
+    // @ts-expect-error TS(7005) FIXME: Variable 'execa' implicitly has an 'any' type.
+    await execa(process.argv[0], [process.argv[1], suggestion], { stdio: 'inherit' });
+};
 /**
  * Creates the `netlify-cli` command
  * Promise is needed as the envinfo is a promise
  * @returns {import('./base-command.mjs').default}
  */
 export const createMainCommand = () => {
-  const program = new BaseCommand('netlify')
-  // register all the commands
-  createAddonsCommand(program)
-  createApiCommand(program)
-  createBuildCommand(program)
-  createCompletionCommand(program)
-  createDeployCommand(program)
-  createDevCommand(program)
-  createEnvCommand(program)
-  createFunctionsCommand(program)
-  createRecipesCommand(program)
-  createInitCommand(program)
-  createIntegrationCommand(program)
-  createLinkCommand(program)
-  createLmCommand(program)
-  createLoginCommand(program)
-  createLogoutCommand(program)
-  createOpenCommand(program)
-  createServeCommand(program)
-  createSitesCommand(program)
-  createStatusCommand(program)
-  createSwitchCommand(program)
-  createUnlinkCommand(program)
-  createWatchCommand(program)
-
-  program
-    .version(USER_AGENT, '-V')
-    .showSuggestionAfterError(true)
-    .option('--telemetry-disable', 'Disable telemetry')
-    .option('--telemetry-enable', 'Enables telemetry')
-    // needed for custom version output as we display further environment information
-    // commanders version output is set to uppercase -V
-    .addOption(new Option('-v, --version').hideHelp())
-    .addOption(new Option('--verbose').hideHelp())
-    .noHelpOptions()
-    .configureOutput({
-      outputError: (message, write) => {
-        write(` ${chalk.red(BANG)}   Error: ${message.replace(/^error:\s/g, '')}`)
-        write(` ${chalk.red(BANG)}   See more help with --help\n`)
-      },
+    const program = new BaseCommand('netlify');
+    // register all the commands
+    createAddonsCommand(program);
+    createApiCommand(program);
+    createBlobsCommand(program);
+    createBuildCommand(program);
+    createCompletionCommand(program);
+    createDeployCommand(program);
+    createDevCommand(program);
+    createEnvCommand(program);
+    createFunctionsCommand(program);
+    createRecipesCommand(program);
+    createInitCommand(program);
+    createIntegrationCommand(program);
+    createLinkCommand(program);
+    createLmCommand(program);
+    createLoginCommand(program);
+    createLogoutCommand(program);
+    createOpenCommand(program);
+    createServeCommand(program);
+    createSitesCommand(program);
+    createStatusCommand(program);
+    createSwitchCommand(program);
+    createUnlinkCommand(program);
+    createWatchCommand(program);
+    program
+        .version(USER_AGENT, '-V')
+        .showSuggestionAfterError(true)
+        .option('--telemetry-disable', 'Disable telemetry')
+        .option('--telemetry-enable', 'Enables telemetry')
+        // needed for custom version output as we display further environment information
+        // commanders version output is set to uppercase -V
+        .addOption(new Option('-v, --version').hideHelp())
+        .addOption(new Option('--verbose').hideHelp())
+        .noHelpOptions()
+        .configureOutput({
+        outputError: (message, write) => {
+            write(` ${chalk.red(BANG)}   Error: ${message.replace(/^error:\s/g, '')}`);
+            write(` ${chalk.red(BANG)}   See more help with --help\n`);
+        },
     })
-    .action(mainCommand)
-
-  return program
-}
+        .action(mainCommand);
+    return program;
+};

package/src/commands/open/index.mjs

@@ -1 +1 @@
-export { createOpenCommand } from './open.mjs'
+export { createOpenCommand } from './open.mjs';

package/src/commands/open/open-admin.mjs

@@ -1,33 +1,30 @@
-import { exit, log } from '../../utils/command-helpers.mjs'
-import requiresSiteInfo from '../../utils/hooks/requires-site-info.mjs'
-import openBrowser from '../../utils/open-browser.mjs'
-
+import { exit, log } from '../../utils/command-helpers.mjs';
+import requiresSiteInfo from '../../utils/hooks/requires-site-info.mjs';
+import openBrowser from '../../utils/open-browser.mjs';
 /**
  * The open:admin command
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 export const openAdmin = async (options, command) => {
-  const { siteInfo } = command.netlify
-
-  await command.authenticate()
-
-  log(`Opening "${siteInfo.name}" site admin UI:`)
-  log(`> ${siteInfo.admin_url}`)
-
-  await openBrowser({ url: siteInfo.admin_url })
-  exit()
-}
-
+    const { siteInfo } = command.netlify;
+    await command.authenticate();
+    log(`Opening "${siteInfo.name}" site admin UI:`);
+    log(`> ${siteInfo.admin_url}`);
+    // @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: siteInfo.admin_url });
+    exit();
+};
 /**
  * Creates the `netlify open:admin` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createOpenAdminCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createOpenAdminCommand = (program) => program
     .command('open:admin')
     .description('Opens current site admin UI in Netlify')
     .addExamples(['netlify open:admin'])
     .hook('preAction', requiresSiteInfo)
-    .action(openAdmin)
+    .action(openAdmin);

package/src/commands/open/open-site.mjs

@@ -1,34 +1,31 @@
-import { exit, log } from '../../utils/command-helpers.mjs'
-import requiresSiteInfo from '../../utils/hooks/requires-site-info.mjs'
-import openBrowser from '../../utils/open-browser.mjs'
-
+import { exit, log } from '../../utils/command-helpers.mjs';
+import requiresSiteInfo from '../../utils/hooks/requires-site-info.mjs';
+import openBrowser from '../../utils/open-browser.mjs';
 /**
  * The open:site command
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 export const openSite = async (options, command) => {
-  const { siteInfo } = command.netlify
-
-  await command.authenticate()
-
-  const url = siteInfo.ssl_url || siteInfo.url
-  log(`Opening "${siteInfo.name}" site url:`)
-  log(`> ${url}`)
-
-  await openBrowser({ url })
-  exit()
-}
-
+    const { siteInfo } = command.netlify;
+    await command.authenticate();
+    const url = siteInfo.ssl_url || siteInfo.url;
+    log(`Opening "${siteInfo.name}" site url:`);
+    log(`> ${url}`);
+    // @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 });
+    exit();
+};
 /**
  * Creates the `netlify open:site` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createOpenSiteCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createOpenSiteCommand = (program) => program
     .command('open:site')
     .description('Opens current site url in browser')
     .addExamples(['netlify open:site'])
     .hook('preAction', requiresSiteInfo)
-    .action(openSite)
+    .action(openSite);

package/src/commands/open/open.mjs

@@ -1,39 +1,36 @@
-import { log } from '../../utils/command-helpers.mjs'
-
-import { createOpenAdminCommand, openAdmin } from './open-admin.mjs'
-import { createOpenSiteCommand, openSite } from './open-site.mjs'
-
+import { log } from '../../utils/command-helpers.mjs';
+import { createOpenAdminCommand, openAdmin } from './open-admin.mjs';
+import { createOpenSiteCommand, openSite } from './open-site.mjs';
 /**
  * The open command
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 const open = async (options, command) => {
-  if (!options.site || !options.admin) {
-    log(command.helpInformation())
-  }
-
-  if (options.site) {
-    await openSite(options, command)
-  }
-  // Default open netlify admin
-  await openAdmin(options, command)
-}
-
+    if (!options.site || !options.admin) {
+        log(command.helpInformation());
+    }
+    if (options.site) {
+        await openSite(options, command);
+    }
+    // Default open netlify admin
+    await openAdmin(options, command);
+};
 /**
  * Creates the `netlify open` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
 export const createOpenCommand = (program) => {
-  createOpenAdminCommand(program)
-  createOpenSiteCommand(program)
-
-  return program
-    .command('open')
-    .description(`Open settings for the site linked to the current folder`)
-    .option('--site', 'Open site')
-    .option('--admin', 'Open Netlify site')
-    .addExamples(['netlify open --site', 'netlify open --admin', 'netlify open:admin', 'netlify open:site'])
-    .action(open)
-}
+    createOpenAdminCommand(program);
+    createOpenSiteCommand(program);
+    return program
+        .command('open')
+        .description(`Open settings for the site linked to the current folder`)
+        .option('--site', 'Open site')
+        .option('--admin', 'Open Netlify site')
+        .addExamples(['netlify open --site', 'netlify open --admin', 'netlify open:admin', 'netlify open:site'])
+        .action(open);
+};

package/src/commands/recipes/common.mjs

@@ -1,36 +1,25 @@
-import fs from 'fs/promises'
-import { dirname, join, resolve } from 'path'
-import { fileURLToPath, pathToFileURL } from 'url'
-
-const directoryPath = dirname(fileURLToPath(import.meta.url))
-
+import fs from 'fs/promises';
+import { dirname, join, resolve } from 'path';
+import { fileURLToPath, pathToFileURL } from 'url';
+const directoryPath = dirname(fileURLToPath(import.meta.url));
+// @ts-expect-error TS(7006) FIXME: Parameter 'name' implicitly has an 'any' type.
 export const getRecipe = async (name) => {
-  const recipePath = resolve(directoryPath, '../../recipes', name, 'index.mjs')
-
-  // windows needs a URL for absolute paths
-
-  const recipe = await import(pathToFileURL(recipePath).href)
-
-  return recipe
-}
-
+    const recipePath = resolve(directoryPath, '../../recipes', name, 'index.mjs');
+    // windows needs a URL for absolute paths
+    const recipe = await import(pathToFileURL(recipePath).href);
+    return recipe;
+};
 export const listRecipes = async () => {
-  const recipesPath = resolve(directoryPath, '../../recipes')
-  const recipeNames = await fs.readdir(recipesPath)
-  const recipes = await Promise.all(
-    recipeNames.map(async (name) => {
-      const recipePath = join(recipesPath, name, 'index.mjs')
-
-      // windows needs a URL for absolute paths
-
-      const recipe = await import(pathToFileURL(recipePath).href)
-
-      return {
-        ...recipe,
-        name,
-      }
-    }),
-  )
-
-  return recipes
-}
+    const recipesPath = resolve(directoryPath, '../../recipes');
+    const recipeNames = await fs.readdir(recipesPath);
+    const recipes = await Promise.all(recipeNames.map(async (name) => {
+        const recipePath = join(recipesPath, name, 'index.mjs');
+        // windows needs a URL for absolute paths
+        const recipe = await import(pathToFileURL(recipePath).href);
+        return {
+            ...recipe,
+            name,
+        };
+    }));
+    return recipes;
+};

package/src/commands/recipes/index.mjs

@@ -1 +1 @@
-export { createRecipesCommand, runRecipe } from './recipes.mjs'
+export { createRecipesCommand, runRecipe } from './recipes.mjs';