netlify-cli 17.3.1 → 17.4.0

package/src/commands/recipes/recipes-list.mjs

@@ -1,32 +1,25 @@
-// @ts-check
-import AsciiTable from 'ascii-table'
-
-import { listRecipes } from './common.mjs'
-
+import AsciiTable from 'ascii-table';
+import { listRecipes } from './common.mjs';
 /**
  * The recipes:list command
  */
 const recipesListCommand = async () => {
-  const recipes = await listRecipes()
-  const table = new AsciiTable(`Usage: netlify recipes <name>`)
-
-  table.setHeading('Name', 'Description')
-
-  recipes.forEach(({ description, name }) => {
-    table.addRow(name, description)
-  })
-
-  console.log(table.toString())
-}
-
+    const recipes = await listRecipes();
+    const table = new AsciiTable(`Usage: netlify recipes <name>`);
+    table.setHeading('Name', 'Description');
+    recipes.forEach(({ description, name }) => {
+        table.addRow(name, description);
+    });
+    console.log(table.toString());
+};
 /**
  * Creates the `netlify recipes:list` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createRecipesListCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createRecipesListCommand = (program) => program
     .command('recipes:list')
     .description(`List the recipes available to create and modify files in a project`)
     .addExamples(['netlify recipes:list'])
-    .action(recipesListCommand)
+    .action(recipesListCommand);

package/src/commands/recipes/recipes.mjs

@@ -1,88 +1,75 @@
-// @ts-check
-import { basename } from 'path'
-
-import { closest } from 'fastest-levenshtein'
-import inquirer from 'inquirer'
-
-import { NETLIFYDEVERR, chalk, log } from '../../utils/command-helpers.mjs'
-
-import { getRecipe, listRecipes } from './common.mjs'
-import { createRecipesListCommand } from './recipes-list.mjs'
-
-const SUGGESTION_TIMEOUT = 1e4
-
+import { basename } from 'path';
+import { closest } from 'fastest-levenshtein';
+import inquirer from 'inquirer';
+import { NETLIFYDEVERR, chalk, log } from '../../utils/command-helpers.mjs';
+import { getRecipe, listRecipes } from './common.mjs';
+import { createRecipesListCommand } from './recipes-list.mjs';
+const SUGGESTION_TIMEOUT = 1e4;
 /**
  * The recipes command
  * @param {string} recipeName
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  */
+// @ts-expect-error TS(7023) FIXME: 'recipesCommand' implicitly has return type 'any' ... Remove this comment to see the full error message
 const recipesCommand = async (recipeName, options, command) => {
-  const { config, repositoryRoot } = command.netlify
-  const sanitizedRecipeName = basename(recipeName || '').toLowerCase()
-
-  if (sanitizedRecipeName.length === 0) {
-    return command.help()
-  }
-
-  try {
-    return await runRecipe({ config, recipeName: sanitizedRecipeName, repositoryRoot })
-  } catch (error) {
-    if (
-      // The ESM loader throws this instead of MODULE_NOT_FOUND
-      error.code !== 'ERR_MODULE_NOT_FOUND'
-    ) {
-      throw error
+    const { config, repositoryRoot } = command.netlify;
+    const sanitizedRecipeName = basename(recipeName || '').toLowerCase();
+    if (sanitizedRecipeName.length === 0) {
+        return command.help();
     }
-
-    log(`${NETLIFYDEVERR} ${chalk.yellow(recipeName)} is not a valid recipe name.`)
-
-    const recipes = await listRecipes()
-    const recipeNames = recipes.map(({ name }) => name)
-    const suggestion = closest(recipeName, recipeNames)
-    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))
-    })
-
-    if (applySuggestion) {
-      return recipesCommand(suggestion, options, command)
+    try {
+        return await runRecipe({ config, recipeName: sanitizedRecipeName, repositoryRoot });
     }
-  }
-}
-
+    catch (error) {
+        if (
+        // The ESM loader throws this instead of MODULE_NOT_FOUND
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        error.code !== 'ERR_MODULE_NOT_FOUND') {
+            throw error;
+        }
+        log(`${NETLIFYDEVERR} ${chalk.yellow(recipeName)} is not a valid recipe name.`);
+        const recipes = await listRecipes();
+        const recipeNames = recipes.map(({ name }) => name);
+        const suggestion = closest(recipeName, recipeNames);
+        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));
+        });
+        if (applySuggestion) {
+            return recipesCommand(suggestion, options, command);
+        }
+    }
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'config' implicitly has an 'any' t... Remove this comment to see the full error message
 export const runRecipe = async ({ config, recipeName, repositoryRoot }) => {
-  const recipe = await getRecipe(recipeName)
-
-  return recipe.run({ config, repositoryRoot })
-}
-
+    const recipe = await getRecipe(recipeName);
+    return recipe.run({ config, repositoryRoot });
+};
 /**
  * Creates the `netlify recipes` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
 export const createRecipesCommand = (program) => {
-  createRecipesListCommand(program)
-
-  program
-    .command('recipes')
-    .argument('[name]', 'name of the recipe')
-    .description(`Create and modify files in a project using pre-defined recipes`)
-    .option('-n, --name <name>', 'recipe name to use')
-    .addExamples(['netlify recipes my-recipe', 'netlify recipes --name my-recipe'])
-    .action(recipesCommand)
-}
+    createRecipesListCommand(program);
+    program
+        .command('recipes')
+        .argument('[name]', 'name of the recipe')
+        .description(`Create and modify files in a project using pre-defined recipes`)
+        .option('-n, --name <name>', 'recipe name to use')
+        .addExamples(['netlify recipes my-recipe', 'netlify recipes --name my-recipe'])
+        .action(recipesCommand);
+};

package/src/commands/serve/index.mjs

@@ -1 +1 @@
-export { createServeCommand } from './serve.mjs'
+export { createServeCommand } from './serve.mjs';

package/src/commands/serve/serve.mjs

@@ -1,207 +1,160 @@
-// @ts-check
-import process from 'process'
-
-import { Option } from 'commander'
-
-import { promptEditorHelper } from '../../lib/edge-functions/editor-helper.mjs'
-import { startFunctionsServer } from '../../lib/functions/server.mjs'
-import { printBanner } from '../../utils/banner.mjs'
-import {
-  chalk,
-  exit,
-  log,
-  NETLIFYDEVERR,
-  NETLIFYDEVLOG,
-  NETLIFYDEVWARN,
-  normalizeConfig,
-} from '../../utils/command-helpers.mjs'
-import detectServerSettings, { getConfigWithPlugins } from '../../utils/detect-server-settings.mjs'
-import { getDotEnvVariables, getSiteInformation, injectEnvVariables } from '../../utils/dev.mjs'
-import { getEnvelopeEnv, normalizeContext } from '../../utils/env/index.mjs'
-import { getInternalFunctionsDir } from '../../utils/functions/functions.mjs'
-import { ensureNetlifyIgnore } from '../../utils/gitignore.mjs'
-import openBrowser from '../../utils/open-browser.mjs'
-import { generateInspectSettings, startProxyServer } from '../../utils/proxy-server.mjs'
-import { runBuildTimeline } from '../../utils/run-build.mjs'
-import { getGeoCountryArgParser } from '../../utils/validation.mjs'
-
+import process from 'process';
+import { Option } from 'commander';
+import { promptEditorHelper } from '../../lib/edge-functions/editor-helper.mjs';
+import { startFunctionsServer } from '../../lib/functions/server.mjs';
+import { printBanner } from '../../utils/banner.mjs';
+import { chalk, exit, log, NETLIFYDEVERR, NETLIFYDEVLOG, NETLIFYDEVWARN, normalizeConfig, } from '../../utils/command-helpers.mjs';
+import detectServerSettings, { getConfigWithPlugins } from '../../utils/detect-server-settings.mjs';
+import { getDotEnvVariables, getSiteInformation, injectEnvVariables } from '../../utils/dev.mjs';
+import { getEnvelopeEnv, normalizeContext } from '../../utils/env/index.mjs';
+import { getInternalFunctionsDir } from '../../utils/functions/functions.mjs';
+import { ensureNetlifyIgnore } from '../../utils/gitignore.mjs';
+import openBrowser from '../../utils/open-browser.mjs';
+import { generateInspectSettings, startProxyServer } from '../../utils/proxy-server.mjs';
+import { runBuildTimeline } from '../../utils/run-build.mjs';
+import { getGeoCountryArgParser } from '../../utils/validation.mjs';
 /**
  * The serve 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 serve = async (options, command) => {
-  const { api, cachedConfig, config, repositoryRoot, site, siteInfo, state } = command.netlify
-  config.dev = { ...config.dev }
-  config.build = { ...config.build }
-  /** @type {import('../dev/types').DevConfig} */
-  const devConfig = {
-    ...(config.functionsDirectory && { functions: config.functionsDirectory }),
-    ...(config.build.publish && { publish: config.build.publish }),
-
-    ...config.dev,
-    ...options,
-    // Override the `framework` value so that we start a static server and not
-    // the framework's development server.
-    framework: '#static',
-  }
-
-  let { env } = cachedConfig
-
-  if (!options.offline && siteInfo.use_envelope) {
-    env = await getEnvelopeEnv({ api, context: options.context, env, siteInfo })
-    log(`${NETLIFYDEVLOG} Injecting environment variable values for ${chalk.yellow('all scopes')}`)
-  }
-
-  env = await getDotEnvVariables({ devConfig, env, site })
-  injectEnvVariables(env)
-  await promptEditorHelper({ chalk, config, log, NETLIFYDEVLOG, repositoryRoot, state })
-
-  const { accountId, addonsUrls, capabilities, siteUrl, timeouts } = await getSiteInformation({
-    // inherited from base command --offline
-    offline: options.offline,
-    api,
-    site,
-    siteInfo,
-  })
-
-  // Ensure the internal functions directory exists so that the functions
-  // server and registry are initialized, and any functions created by
-  // Netlify Build are loaded.
-  await getInternalFunctionsDir({ base: site.root, ensureExists: true })
-
-  let settings = /** @type {import('../../utils/types.js').ServerSettings} */ ({})
-  try {
-    settings = await detectServerSettings(devConfig, options, command)
-
-    cachedConfig.config = getConfigWithPlugins(cachedConfig.config, settings)
-  } catch (error_) {
-    log(NETLIFYDEVERR, error_.message)
-    exit(1)
-  }
-
-  command.setAnalyticsPayload({ live: options.live })
-
-  log(`${NETLIFYDEVLOG} Building site for production`)
-  log(
-    `${NETLIFYDEVWARN} Changes will not be hot-reloaded, so if you need to rebuild your site you must exit and run 'netlify serve' again`,
-  )
-
-  const { configPath: configPathOverride } = await runBuildTimeline({
-    command,
-    settings,
-    options,
-  })
-
-  const functionsRegistry = await startFunctionsServer({
-    api,
-    command,
-    config,
-    debug: options.debug,
-    loadDistFunctions: true,
-    settings,
-    site,
-    siteInfo,
-    siteUrl,
-    capabilities,
-    timeouts,
-    geolocationMode: options.geo,
-    geoCountry: options.country,
-    offline: options.offline,
-    state,
-    accountId,
-  })
-
-  // Try to add `.netlify` to `.gitignore`.
-  try {
-    await ensureNetlifyIgnore(repositoryRoot)
-  } catch {
-    // no-op
-  }
-
-  // TODO: We should consolidate this with the existing config watcher.
-  const getUpdatedConfig = async () => {
-    const { config: newConfig } = await command.getConfig({ cwd: command.workingDir, offline: true, state })
-    const normalizedNewConfig = normalizeConfig(newConfig)
-
-    return normalizedNewConfig
-  }
-
-  const inspectSettings = generateInspectSettings(options.edgeInspect, options.edgeInspectBrk)
-  const url = await startProxyServer({
-    addonsUrls,
-    config,
-    configPath: configPathOverride,
-    debug: options.debug,
-    env,
-    functionsRegistry,
-    geolocationMode: options.geo,
-    geoCountry: options.country,
-    getUpdatedConfig,
-    inspectSettings,
-    offline: options.offline,
-    projectDir: command.workingDir,
-    settings,
-    site,
-    siteInfo,
-    state,
-    accountId,
-  })
-
-  if (devConfig.autoLaunch !== false) {
-    await openBrowser({ url, silentBrowserNoneError: true })
-  }
-
-  process.env.URL = url
-  process.env.DEPLOY_URL = url
-
-  printBanner({ url })
-}
-
+    const { api, cachedConfig, config, repositoryRoot, site, siteInfo, state } = command.netlify;
+    config.dev = { ...config.dev };
+    config.build = { ...config.build };
+    /** @type {import('../dev/types').DevConfig} */
+    const devConfig = {
+        ...(config.functionsDirectory && { functions: config.functionsDirectory }),
+        ...(config.build.publish && { publish: config.build.publish }),
+        ...config.dev,
+        ...options,
+        // Override the `framework` value so that we start a static server and not
+        // the framework's development server.
+        framework: '#static',
+    };
+    let { env } = cachedConfig;
+    if (!options.offline && siteInfo.use_envelope) {
+        env = await getEnvelopeEnv({ api, context: options.context, env, siteInfo });
+        log(`${NETLIFYDEVLOG} Injecting environment variable values for ${chalk.yellow('all scopes')}`);
+    }
+    env = await getDotEnvVariables({ devConfig, env, site });
+    injectEnvVariables(env);
+    await promptEditorHelper({ chalk, config, log, NETLIFYDEVLOG, repositoryRoot, state });
+    const { accountId, addonsUrls, capabilities, siteUrl, timeouts } = await getSiteInformation({
+        // inherited from base command --offline
+        offline: options.offline,
+        api,
+        site,
+        siteInfo,
+    });
+    // Ensure the internal functions directory exists so that the functions
+    // server and registry are initialized, and any functions created by
+    // Netlify Build are loaded.
+    await getInternalFunctionsDir({ base: site.root, ensureExists: true });
+    let settings = /** @type {import('../../utils/types.js').ServerSettings} */ ({});
+    try {
+        settings = await detectServerSettings(devConfig, options, command);
+        cachedConfig.config = getConfigWithPlugins(cachedConfig.config, settings);
+    }
+    catch (error_) {
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        log(NETLIFYDEVERR, error_.message);
+        exit(1);
+    }
+    command.setAnalyticsPayload({ live: options.live });
+    log(`${NETLIFYDEVLOG} Building site for production`);
+    log(`${NETLIFYDEVWARN} Changes will not be hot-reloaded, so if you need to rebuild your site you must exit and run 'netlify serve' again`);
+    const { configPath: configPathOverride } = await runBuildTimeline({
+        command,
+        settings,
+        options,
+    });
+    const functionsRegistry = await startFunctionsServer({
+        api,
+        command,
+        config,
+        debug: options.debug,
+        loadDistFunctions: true,
+        settings,
+        site,
+        siteInfo,
+        siteUrl,
+        capabilities,
+        timeouts,
+        geolocationMode: options.geo,
+        geoCountry: options.country,
+        offline: options.offline,
+        state,
+        accountId,
+    });
+    // Try to add `.netlify` to `.gitignore`.
+    try {
+        await ensureNetlifyIgnore(repositoryRoot);
+    }
+    catch {
+        // no-op
+    }
+    // TODO: We should consolidate this with the existing config watcher.
+    const getUpdatedConfig = async () => {
+        const { config: newConfig } = await command.getConfig({ cwd: command.workingDir, offline: true, state });
+        const normalizedNewConfig = normalizeConfig(newConfig);
+        return normalizedNewConfig;
+    };
+    const inspectSettings = generateInspectSettings(options.edgeInspect, options.edgeInspectBrk);
+    // @ts-expect-error TS(2345) FIXME: Argument of type '{ addonsUrls: { [k: string]: any... Remove this comment to see the full error message
+    const url = await startProxyServer({
+        addonsUrls,
+        config,
+        configPath: configPathOverride,
+        debug: options.debug,
+        env,
+        functionsRegistry,
+        geolocationMode: options.geo,
+        geoCountry: options.country,
+        getUpdatedConfig,
+        inspectSettings,
+        offline: options.offline,
+        projectDir: command.workingDir,
+        settings,
+        site,
+        siteInfo,
+        state,
+        accountId,
+    });
+    if (devConfig.autoLaunch !== false) {
+        await openBrowser({ url, silentBrowserNoneError: true });
+    }
+    process.env.URL = url;
+    process.env.DEPLOY_URL = url;
+    printBanner({ url });
+};
 /**
  * Creates the `netlify serve` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createServeCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createServeCommand = (program) => program
     .command('serve')
-    .description(
-      'Build the site for production and serve locally. This does not watch the code for changes, so if you need to rebuild your site then you must exit and run `serve` again.',
-    )
-    .option(
-      '--context <context>',
-      'Specify a deploy context or branch for environment variables (contexts: "production", "deploy-preview", "branch-deploy", "dev")',
-      normalizeContext,
-    )
+    .description('Build the site for production and serve locally. This does not watch the code for changes, so if you need to rebuild your site then you must exit and run `serve` again.')
+    .option('--context <context>', 'Specify a deploy context or branch for environment variables (contexts: "production", "deploy-preview", "branch-deploy", "dev")', normalizeContext)
+    // @ts-expect-error TS(7006) FIXME: Parameter 'value' implicitly has an 'any' type.
     .option('-p ,--port <port>', 'port of netlify dev', (value) => Number.parseInt(value))
     .option('-d ,--dir <path>', 'dir with static files')
     .option('-f ,--functions <folder>', 'specify a functions folder to serve')
     .option('-o ,--offline', 'disables any features that require network access')
-    .addOption(
-      new Option('--functionsPort <port>', 'Old, prefer --functions-port. Port of functions server')
-        .argParser((value) => Number.parseInt(value))
-        .hideHelp(true),
-    )
+    .addOption(new Option('--functionsPort <port>', 'Old, prefer --functions-port. Port of functions server')
+    .argParser((value) => Number.parseInt(value))
+    .hideHelp(true))
+    // @ts-expect-error TS(7006) FIXME: Parameter 'value' implicitly has an 'any' type.
     .option('--functions-port <port>', 'port of functions server', (value) => Number.parseInt(value))
-    .addOption(
-      new Option(
-        '--geo <mode>',
-        'force geolocation data to be updated, use cached data from the last 24h if found, or use a mock location',
-      )
-        .choices(['cache', 'mock', 'update'])
-        .default('cache'),
-    )
-    .addOption(
-      new Option(
-        '--country <geoCountry>',
-        'Two-letter country code (https://ntl.fyi/country-codes) to use as mock geolocation (enables --geo=mock automatically)',
-      ).argParser(getGeoCountryArgParser('netlify dev --geo=mock --country=FR')),
-    )
-    .addOption(
-      new Option('--staticServerPort <port>', 'port of the static app server used when no framework is detected')
-        .argParser((value) => Number.parseInt(value))
-        .hideHelp(),
-    )
+    .addOption(new Option('--geo <mode>', 'force geolocation data to be updated, use cached data from the last 24h if found, or use a mock location')
+    .choices(['cache', 'mock', 'update'])
+    .default('cache'))
+    .addOption(new Option('--country <geoCountry>', 'Two-letter country code (https://ntl.fyi/country-codes) to use as mock geolocation (enables --geo=mock automatically)').argParser(getGeoCountryArgParser('netlify dev --geo=mock --country=FR')))
+    .addOption(new Option('--staticServerPort <port>', 'port of the static app server used when no framework is detected')
+    .argParser((value) => Number.parseInt(value))
+    .hideHelp())
     .addExamples(['netlify serve', 'BROWSER=none netlify serve # disable browser auto opening'])
-    .action(serve)
+    .action(serve);

package/src/commands/sites/index.mjs

@@ -1,2 +1,2 @@
-export { sitesCreate } from './sites-create.mjs'
-export { createSitesCommand } from './sites.mjs'
+export { sitesCreate } from './sites-create.mjs';
+export { createSitesCommand } from './sites.mjs';