netlify-cli 17.3.1 → 17.4.0

package/src/commands/functions/functions-serve.mjs

@@ -1,79 +1,69 @@
-// @ts-check
-import { join } from 'path'
-
-import { startFunctionsServer } from '../../lib/functions/server.mjs'
-import { printBanner } from '../../utils/banner.mjs'
-import { acquirePort, getDotEnvVariables, getSiteInformation, injectEnvVariables } from '../../utils/dev.mjs'
-import { getFunctionsDir } from '../../utils/functions/index.mjs'
-import { getProxyUrl } from '../../utils/proxy.mjs'
-
-const DEFAULT_PORT = 9999
-
+import { join } from 'path';
+import { startFunctionsServer } from '../../lib/functions/server.mjs';
+import { printBanner } from '../../utils/banner.mjs';
+import { acquirePort, getDotEnvVariables, getSiteInformation, injectEnvVariables } from '../../utils/dev.mjs';
+import { getFunctionsDir } from '../../utils/functions/index.mjs';
+import { getProxyUrl } from '../../utils/proxy.mjs';
+const DEFAULT_PORT = 9999;
 /**
  * The functions: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 functionsServe = async (options, command) => {
-  const { api, config, site, siteInfo, state } = command.netlify
-
-  const functionsDir = getFunctionsDir({ options, config }, join('netlify', 'functions'))
-  let { env } = command.netlify.cachedConfig
-
-  env.NETLIFY_DEV = { sources: ['internal'], value: 'true' }
-
-  env = await getDotEnvVariables({ devConfig: { ...config.dev }, env, site })
-  injectEnvVariables(env)
-
-  const { accountId, capabilities, siteUrl, timeouts } = await getSiteInformation({
-    offline: options.offline,
-    api,
-    site,
-    siteInfo,
-  })
-
-  const functionsPort = await acquirePort({
-    configuredPort: options.port || (config.dev && config.dev.functionsPort),
-    defaultPort: DEFAULT_PORT,
-    errorMessage: 'Could not acquire configured functions port',
-  })
-
-  await startFunctionsServer({
-    config,
-    debug: options.debug,
-    command,
-    api,
-    settings: { functions: functionsDir, functionsPort },
-    site,
-    siteInfo,
-    siteUrl,
-    capabilities,
-    timeouts,
-    functionsPrefix: '/.netlify/functions/',
-    buildersPrefix: '/.netlify/builders/',
-    geolocationMode: options.geo,
-    geoCountry: options.country,
-    offline: options.offline,
-    state,
-    accountId,
-  })
-
-  const url = getProxyUrl({ port: functionsPort })
-  printBanner({ url })
-}
-
+    const { api, config, site, siteInfo, state } = command.netlify;
+    const functionsDir = getFunctionsDir({ options, config }, join('netlify', 'functions'));
+    let { env } = command.netlify.cachedConfig;
+    env.NETLIFY_DEV = { sources: ['internal'], value: 'true' };
+    env = await getDotEnvVariables({ devConfig: { ...config.dev }, env, site });
+    injectEnvVariables(env);
+    const { accountId, capabilities, siteUrl, timeouts } = await getSiteInformation({
+        offline: options.offline,
+        api,
+        site,
+        siteInfo,
+    });
+    const functionsPort = await acquirePort({
+        configuredPort: options.port || (config.dev && config.dev.functionsPort),
+        defaultPort: DEFAULT_PORT,
+        errorMessage: 'Could not acquire configured functions port',
+    });
+    await startFunctionsServer({
+        config,
+        debug: options.debug,
+        command,
+        api,
+        settings: { functions: functionsDir, functionsPort },
+        site,
+        siteInfo,
+        siteUrl,
+        capabilities,
+        timeouts,
+        functionsPrefix: '/.netlify/functions/',
+        buildersPrefix: '/.netlify/builders/',
+        geolocationMode: options.geo,
+        geoCountry: options.country,
+        offline: options.offline,
+        state,
+        accountId,
+    });
+    const url = getProxyUrl({ port: functionsPort });
+    printBanner({ url });
+};
 /**
  * Creates the `netlify functions:serve` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createFunctionsServeCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createFunctionsServeCommand = (program) => program
     .command('functions:serve')
     .alias('function:serve')
     .description('Serve functions locally')
     .option('-f, --functions <dir>', 'Specify a functions directory to serve')
+    // @ts-expect-error TS(7006) FIXME: Parameter 'value' implicitly has an 'any' type.
     .option('-p, --port <port>', 'Specify a port for the functions server', (value) => Number.parseInt(value))
     .option('-o, --offline', 'disables any features that require network access')
     .addHelpText('after', 'Helpful for debugging functions.')
-    .action(functionsServe)
+    .action(functionsServe);

package/src/commands/functions/functions.mjs

@@ -1,45 +1,39 @@
-// @ts-check
-import { chalk } from '../../utils/command-helpers.mjs'
-
-import { createFunctionsBuildCommand } from './functions-build.mjs'
-import { createFunctionsCreateCommand } from './functions-create.mjs'
-import { createFunctionsInvokeCommand } from './functions-invoke.mjs'
-import { createFunctionsListCommand } from './functions-list.mjs'
-import { createFunctionsServeCommand } from './functions-serve.mjs'
-
+import { chalk } from '../../utils/command-helpers.mjs';
+import { createFunctionsBuildCommand } from './functions-build.mjs';
+import { createFunctionsCreateCommand } from './functions-create.mjs';
+import { createFunctionsInvokeCommand } from './functions-invoke.mjs';
+import { createFunctionsListCommand } from './functions-list.mjs';
+import { createFunctionsServeCommand } from './functions-serve.mjs';
 /**
  * The functions 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 functions = (options, command) => {
-  command.help()
-}
-
+    command.help();
+};
 /**
  * Creates the `netlify functions` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
 export const createFunctionsCommand = (program) => {
-  createFunctionsBuildCommand(program)
-  createFunctionsCreateCommand(program)
-  createFunctionsInvokeCommand(program)
-  createFunctionsListCommand(program)
-  createFunctionsServeCommand(program)
-
-  const name = chalk.greenBright('`functions`')
-
-  return program
-    .command('functions')
-    .alias('function')
-    .description(
-      `Manage netlify functions
-The ${name} command will help you manage the functions in this site`,
-    )
-    .addExamples([
-      'netlify functions:create --name function-xyz',
-      'netlify functions:build --functions build/to/directory --src source/directory',
+    createFunctionsBuildCommand(program);
+    createFunctionsCreateCommand(program);
+    createFunctionsInvokeCommand(program);
+    createFunctionsListCommand(program);
+    createFunctionsServeCommand(program);
+    const name = chalk.greenBright('`functions`');
+    return program
+        .command('functions')
+        .alias('function')
+        .description(`Manage netlify functions
+The ${name} command will help you manage the functions in this site`)
+        .addExamples([
+        'netlify functions:create --name function-xyz',
+        'netlify functions:build --functions build/to/directory --src source/directory',
     ])
-    .action(functions)
-}
+        .action(functions);
+};

package/src/commands/functions/index.mjs

@@ -1 +1 @@
-export { createFunctionsCommand } from './functions.mjs'
+export { createFunctionsCommand } from './functions.mjs';

package/src/commands/index.mjs

@@ -1,2 +1,2 @@
-export { default as BaseCommand } from './base-command.mjs'
-export { createMainCommand } from './main.mjs'
+export { default as BaseCommand } from './base-command.mjs';
+export { createMainCommand } from './main.mjs';

package/src/commands/init/index.mjs

@@ -1 +1 @@
-export { createInitCommand, init } from './init.mjs'
+export { createInitCommand, init } from './init.mjs';

package/src/commands/init/init.mjs

@@ -1,64 +1,59 @@
-// @ts-check
-import { Option } from 'commander'
-import inquirer from 'inquirer'
-import isEmpty from 'lodash/isEmpty.js'
-
-import { chalk, exit, log } from '../../utils/command-helpers.mjs'
-import getRepoData from '../../utils/get-repo-data.mjs'
-import { ensureNetlifyIgnore } from '../../utils/gitignore.mjs'
-import { configureRepo } from '../../utils/init/config.mjs'
-import { track } from '../../utils/telemetry/index.mjs'
-import { link } from '../link/index.mjs'
-import { sitesCreate } from '../sites/index.mjs'
-
+import { Option } from 'commander';
+import inquirer from 'inquirer';
+import isEmpty from 'lodash/isEmpty.js';
+import { chalk, exit, log } from '../../utils/command-helpers.mjs';
+import getRepoData from '../../utils/get-repo-data.mjs';
+import { ensureNetlifyIgnore } from '../../utils/gitignore.mjs';
+import { configureRepo } from '../../utils/init/config.mjs';
+import { track } from '../../utils/telemetry/index.mjs';
+import { link } from '../link/index.mjs';
+import { sitesCreate } from '../sites/index.mjs';
+// @ts-expect-error TS(7031) FIXME: Binding element 'siteInfo' implicitly has an 'any'... Remove this comment to see the full error message
 const persistState = ({ siteInfo, state }) => {
-  // Save to .netlify/state.json file
-  state.set('siteId', siteInfo.id)
-}
-
+    // Save to .netlify/state.json file
+    state.set('siteId', siteInfo.id);
+};
 /**
  * @param {{} | undefined} siteInfo
  * @returns {string | undefined}
  */
-const getRepoUrl = (siteInfo) => siteInfo?.build_settings?.repo_url
-
+// @ts-expect-error TS(7006) FIXME: Parameter 'siteInfo' implicitly has an 'any' type.
+const getRepoUrl = (siteInfo) => siteInfo?.build_settings?.repo_url;
+// @ts-expect-error TS(7031) FIXME: Binding element 'siteInfo' implicitly has an 'any'... Remove this comment to see the full error message
 const logExistingAndExit = ({ siteInfo }) => {
-  log()
-  log(`This site has been initialized`)
-  log()
-  log(`Site Name:  ${chalk.cyan(siteInfo.name)}`)
-  log(`Site Url:   ${chalk.cyan(siteInfo.ssl_url || siteInfo.url)}`)
-  log(`Site Repo:  ${chalk.cyan(getRepoUrl({ siteInfo }))}`)
-  log(`Site Id:    ${chalk.cyan(siteInfo.id)}`)
-  log(`Admin URL:  ${chalk.cyan(siteInfo.admin_url)}`)
-  log()
-  log(`To disconnect this directory and create a new site (or link to another siteId)`)
-  log(`1. Run ${chalk.cyanBright.bold('netlify unlink')}`)
-  log(`2. Then run ${chalk.cyanBright.bold('netlify init')} again`)
-  exit()
-}
-
+    log();
+    log(`This site has been initialized`);
+    log();
+    log(`Site Name:  ${chalk.cyan(siteInfo.name)}`);
+    log(`Site Url:   ${chalk.cyan(siteInfo.ssl_url || siteInfo.url)}`);
+    log(`Site Repo:  ${chalk.cyan(getRepoUrl({ siteInfo }))}`);
+    log(`Site Id:    ${chalk.cyan(siteInfo.id)}`);
+    log(`Admin URL:  ${chalk.cyan(siteInfo.admin_url)}`);
+    log();
+    log(`To disconnect this directory and create a new site (or link to another siteId)`);
+    log(`1. Run ${chalk.cyanBright.bold('netlify unlink')}`);
+    log(`2. Then run ${chalk.cyanBright.bold('netlify init')} again`);
+    exit();
+};
 /**
  * Creates and new site and exits the process
  * @param {object} config
  * @param {*} config.state
  * @param {import('../base-command.mjs').default} config.command
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'command' implicitly has an 'any' ... Remove this comment to see the full error message
 const createNewSiteAndExit = async ({ command, state }) => {
-  const siteInfo = await sitesCreate({}, command)
-
-  log(`"${siteInfo.name}" site was created`)
-  log()
-  log(`To deploy to this site. Run your site build and then ${chalk.cyanBright.bold('netlify deploy')}`)
-
-  persistState({ state, siteInfo })
-
-  exit()
-}
-
+    const siteInfo = await sitesCreate({}, command);
+    // @ts-expect-error TS(2532) FIXME: Object is possibly 'undefined'.
+    log(`"${siteInfo.name}" site was created`);
+    log();
+    log(`To deploy to this site. Run your site build and then ${chalk.cyanBright.bold('netlify deploy')}`);
+    persistState({ state, siteInfo });
+    exit();
+};
 const logGitSetupInstructionsAndExit = () => {
-  log()
-  log(`${chalk.bold('To initialize a new git repo follow the steps below.')}
+    log();
+    log(`${chalk.bold('To initialize a new git repo follow the steps below.')}
 
 1. Initialize a new repo:
 
@@ -85,10 +80,9 @@ const logGitSetupInstructionsAndExit = () => {
 7. Initialize your Netlify Site
 
    ${chalk.cyanBright.bold('netlify init')}
-`)
-  exit()
-}
-
+`);
+    exit();
+};
 /**
  * Handles the case where no git remote was found.
  * @param {object} config
@@ -96,148 +90,125 @@ const logGitSetupInstructionsAndExit = () => {
  * @param {object} config.error
  * @param {object} config.state
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'command' implicitly has an 'any' ... Remove this comment to see the full error message
 const handleNoGitRemoteAndExit = async ({ command, error, state }) => {
-  log()
-  log(`${chalk.yellow('No git remote was found, would you like to set one up?')}`)
-  log(`
+    log();
+    log(`${chalk.yellow('No git remote was found, would you like to set one up?')}`);
+    log(`
 It is recommended that you initialize a site that has a remote repository in GitHub.
 
 This will allow for Netlify Continuous deployment to build branch & PR previews.
 
 For more details on Netlify CI checkout the docs: http://bit.ly/2N0Jhy5
-`)
-  if (error === "Couldn't find origin url") {
-    log(`Unable to find a remote origin URL. Please add a git remote.
+`);
+    if (error === "Couldn't find origin url") {
+        log(`Unable to find a remote origin URL. Please add a git remote.
 
 git remote add origin https://github.com/YourUserName/RepoName.git
-`)
-  }
-
-  const NEW_SITE_NO_GIT = 'Yes, create and deploy site manually'
-  const NO_ABORT = 'No, I will connect this directory with GitHub first'
-
-  const { noGitRemoteChoice } = await inquirer.prompt([
-    {
-      type: 'list',
-      name: 'noGitRemoteChoice',
-      message: 'Do you want to create a Netlify site without a git repository?',
-      choices: [NEW_SITE_NO_GIT, NO_ABORT],
-    },
-  ])
-
-  if (noGitRemoteChoice === NEW_SITE_NO_GIT) {
-    await createNewSiteAndExit({ state, command })
-  } else if (noGitRemoteChoice === NO_ABORT) {
-    logGitSetupInstructionsAndExit()
-  }
-}
-
+`);
+    }
+    const NEW_SITE_NO_GIT = 'Yes, create and deploy site manually';
+    const NO_ABORT = 'No, I will connect this directory with GitHub first';
+    const { noGitRemoteChoice } = await inquirer.prompt([
+        {
+            type: 'list',
+            name: 'noGitRemoteChoice',
+            message: 'Do you want to create a Netlify site without a git repository?',
+            choices: [NEW_SITE_NO_GIT, NO_ABORT],
+        },
+    ]);
+    if (noGitRemoteChoice === NEW_SITE_NO_GIT) {
+        await createNewSiteAndExit({ state, command });
+    }
+    else if (noGitRemoteChoice === NO_ABORT) {
+        logGitSetupInstructionsAndExit();
+    }
+};
 /**
  * Creates a new site or links an existing one to the repository
  * @param {import('../base-command.mjs').default} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'command' implicitly has an 'any' type.
 const createOrLinkSiteToRepo = async (command) => {
-  const NEW_SITE = '+  Create & configure a new site'
-  const EXISTING_SITE = '⇄  Connect this directory to an existing Netlify site'
-
-  const initializeOpts = [EXISTING_SITE, NEW_SITE]
-
-  const { initChoice } = await inquirer.prompt([
-    {
-      type: 'list',
-      name: 'initChoice',
-      message: 'What would you like to do?',
-      choices: initializeOpts,
-    },
-  ])
-
-  // create site or search for one
-  if (initChoice === NEW_SITE) {
-    await track('sites_initStarted', {
-      type: 'new site',
-    })
-    // run site:create command
-    return await sitesCreate({}, command)
-  }
-  if (initChoice === EXISTING_SITE) {
-    // run link command
-    return await link({}, command)
-  }
-}
-
+    const NEW_SITE = '+  Create & configure a new site';
+    const EXISTING_SITE = '⇄  Connect this directory to an existing Netlify site';
+    const initializeOpts = [EXISTING_SITE, NEW_SITE];
+    const { initChoice } = await inquirer.prompt([
+        {
+            type: 'list',
+            name: 'initChoice',
+            message: 'What would you like to do?',
+            choices: initializeOpts,
+        },
+    ]);
+    // create site or search for one
+    if (initChoice === NEW_SITE) {
+        await track('sites_initStarted', {
+            type: 'new site',
+        });
+        // run site:create command
+        return await sitesCreate({}, command);
+    }
+    if (initChoice === EXISTING_SITE) {
+        // run link command
+        return await link({}, command);
+    }
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'repoUrl' implicitly has an 'any' ... Remove this comment to see the full error message
 const logExistingRepoSetupAndExit = ({ repoUrl, siteName }) => {
-  log()
-  log(chalk.underline.bold(`Success`))
-  log(`This site "${siteName}" is configured to automatically deploy via ${repoUrl}`)
-  // TODO add support for changing GitHub repo in site:config command
-  exit()
-}
-
+    log();
+    log(chalk.underline.bold(`Success`));
+    log(`This site "${siteName}" is configured to automatically deploy via ${repoUrl}`);
+    // TODO add support for changing GitHub repo in site:config command
+    exit();
+};
 /**
  * The init 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 init = async (options, command) => {
-  command.setAnalyticsPayload({ manual: options.manual, force: options.force })
-
-  const { repositoryRoot, state } = command.netlify
-  let { siteInfo } = command.netlify
-
-  // Check logged in status
-  await command.authenticate()
-
-  // Add .netlify to .gitignore file
-  await ensureNetlifyIgnore(repositoryRoot)
-
-  const repoUrl = getRepoUrl(siteInfo)
-  if (repoUrl && !options.force) {
-    logExistingAndExit({ siteInfo })
-  }
-
-  // Look for local repo
-  const repoData = await getRepoData({ workingDir: command.workingDir, remoteName: options.gitRemoteName })
-  if (repoData.error) {
-    await handleNoGitRemoteAndExit({ command, error: repoData.error, state })
-  }
-
-  if (isEmpty(siteInfo)) {
-    siteInfo = await createOrLinkSiteToRepo(command)
-  }
-
-  log()
-
-  // Check for existing CI setup
-  const remoteBuildRepo = getRepoUrl(siteInfo)
-  if (remoteBuildRepo && !options.force) {
-    logExistingRepoSetupAndExit({ siteName: siteInfo.name, repoUrl: remoteBuildRepo })
-  }
-
-  persistState({ state, siteInfo })
-
-  await configureRepo({ command, siteId: siteInfo.id, repoData, manual: options.manual })
-
-  return siteInfo
-}
-
+    command.setAnalyticsPayload({ manual: options.manual, force: options.force });
+    const { repositoryRoot, state } = command.netlify;
+    let { siteInfo } = command.netlify;
+    // Check logged in status
+    await command.authenticate();
+    // Add .netlify to .gitignore file
+    await ensureNetlifyIgnore(repositoryRoot);
+    const repoUrl = getRepoUrl(siteInfo);
+    if (repoUrl && !options.force) {
+        logExistingAndExit({ siteInfo });
+    }
+    // Look for local repo
+    const repoData = await getRepoData({ workingDir: command.workingDir, remoteName: options.gitRemoteName });
+    if (repoData.error) {
+        await handleNoGitRemoteAndExit({ command, error: repoData.error, state });
+    }
+    if (isEmpty(siteInfo)) {
+        siteInfo = await createOrLinkSiteToRepo(command);
+    }
+    log();
+    // Check for existing CI setup
+    const remoteBuildRepo = getRepoUrl(siteInfo);
+    if (remoteBuildRepo && !options.force) {
+        logExistingRepoSetupAndExit({ siteName: siteInfo.name, repoUrl: remoteBuildRepo });
+    }
+    persistState({ state, siteInfo });
+    await configureRepo({ command, siteId: siteInfo.id, repoData, manual: options.manual });
+    return siteInfo;
+};
 /**
  * Creates the `netlify init` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createInitCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createInitCommand = (program) => program
     .command('init')
-    .description(
-      'Configure continuous deployment for a new or existing site. To create a new site without continuous deployment, use `netlify sites:create`',
-    )
+    .description('Configure continuous deployment for a new or existing site. To create a new site without continuous deployment, use `netlify sites:create`')
     .option('-m, --manual', 'Manually configure a git remote for CI')
     .option('--force', 'Reinitialize CI hooks if the linked site is already configured to use CI')
-    .addOption(
-      new Option(
-        '--gitRemoteName <name>',
-        'Old, prefer --git-remote-name. Name of Git remote to use. e.g. "origin"',
-      ).hideHelp(true),
-    )
+    .addOption(new Option('--gitRemoteName <name>', 'Old, prefer --git-remote-name. Name of Git remote to use. e.g. "origin"').hideHelp(true))
     .option('--git-remote-name <name>', 'Name of Git remote to use. e.g. "origin"')
-    .action(init)
+    .action(init);