netlify-cli 17.3.2 → 17.4.0

package/src/commands/env/env-import.mjs

@@ -1,13 +1,9 @@
-// @ts-check
-import { readFile } from 'fs/promises'
-
-import AsciiTable from 'ascii-table'
-import { Option } from 'commander'
-import dotenv from 'dotenv'
-
-import { exit, log, logJson } from '../../utils/command-helpers.mjs'
-import { translateFromEnvelopeToMongo, translateFromMongoToEnvelope } from '../../utils/env/index.mjs'
-
+import { readFile } from 'fs/promises';
+import AsciiTable from 'ascii-table';
+import { Option } from 'commander';
+import dotenv from 'dotenv';
+import { exit, log, logJson } from '../../utils/command-helpers.mjs';
+import { translateFromEnvelopeToMongo, translateFromMongoToEnvelope } from '../../utils/env/index.mjs';
 /**
  * The env:import command
  * @param {string} fileName .env file to import
@@ -15,132 +11,117 @@ import { translateFromEnvelopeToMongo, translateFromMongoToEnvelope } from '../.
  * @param {import('../base-command.mjs').default} command
  * @returns {Promise<boolean>}
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'fileName' implicitly has an 'any' type.
 const envImport = async (fileName, options, command) => {
-  const { api, cachedConfig, site } = command.netlify
-  const siteId = site.id
-
-  if (!siteId) {
-    log('No site id found, please run inside a site folder or `netlify link`')
-    return false
-  }
-
-  let importedEnv = {}
-  try {
-    const envFileContents = await readFile(fileName, 'utf-8')
-    importedEnv = dotenv.parse(envFileContents)
-  } catch (error) {
-    log(error.message)
-    exit(1)
-  }
-
-  if (Object.keys(importedEnv).length === 0) {
-    log(`No environment variables found in file ${fileName} to import`)
-    return false
-  }
-
-  const { siteInfo } = cachedConfig
-
-  const importIntoService = siteInfo.use_envelope ? importIntoEnvelope : importIntoMongo
-  const finalEnv = await importIntoService({ api, importedEnv, options, siteInfo })
-
-  // Return new environment variables of site if using json flag
-  if (options.json) {
-    logJson(finalEnv)
-    return false
-  }
-
-  // List newly imported environment variables in a table
-  log(`site: ${siteInfo.name}`)
-  const table = new AsciiTable(`Imported environment variables`)
-
-  table.setHeading('Key', 'Value')
-  table.addRowMatrix(Object.entries(importedEnv))
-  log(table.toString())
-}
-
+    const { api, cachedConfig, site } = command.netlify;
+    const siteId = site.id;
+    if (!siteId) {
+        log('No site id found, please run inside a site folder or `netlify link`');
+        return false;
+    }
+    let importedEnv = {};
+    try {
+        const envFileContents = await readFile(fileName, 'utf-8');
+        importedEnv = dotenv.parse(envFileContents);
+    }
+    catch (error) {
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        log(error.message);
+        exit(1);
+    }
+    if (Object.keys(importedEnv).length === 0) {
+        log(`No environment variables found in file ${fileName} to import`);
+        return false;
+    }
+    const { siteInfo } = cachedConfig;
+    const importIntoService = siteInfo.use_envelope ? importIntoEnvelope : importIntoMongo;
+    const finalEnv = await importIntoService({ api, importedEnv, options, siteInfo });
+    // Return new environment variables of site if using json flag
+    if (options.json) {
+        logJson(finalEnv);
+        return false;
+    }
+    // List newly imported environment variables in a table
+    log(`site: ${siteInfo.name}`);
+    const table = new AsciiTable(`Imported environment variables`);
+    table.setHeading('Key', 'Value');
+    table.addRowMatrix(Object.entries(importedEnv));
+    log(table.toString());
+};
 /**
  * Updates the imported env in the site record
  * @returns {Promise<object>}
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
 const importIntoMongo = async ({ api, importedEnv, options, siteInfo }) => {
-  const { env = {} } = siteInfo.build_settings
-  const siteId = siteInfo.id
-
-  const finalEnv = options.replaceExisting ? importedEnv : { ...env, ...importedEnv }
-
-  // Apply environment variable updates
-  await api.updateSite({
-    siteId,
-    body: {
-      build_settings: {
-        // Only set imported variables if --replaceExisting or otherwise merge
-        // imported ones with the current environment variables.
-        env: finalEnv,
-      },
-    },
-  })
-
-  return finalEnv
-}
-
+    const { env = {} } = siteInfo.build_settings;
+    const siteId = siteInfo.id;
+    const finalEnv = options.replaceExisting ? importedEnv : { ...env, ...importedEnv };
+    // Apply environment variable updates
+    await api.updateSite({
+        siteId,
+        body: {
+            build_settings: {
+                // Only set imported variables if --replaceExisting or otherwise merge
+                // imported ones with the current environment variables.
+                env: finalEnv,
+            },
+        },
+    });
+    return finalEnv;
+};
 /**
  * Saves the imported env in the Envelope service
  * @returns {Promise<object>}
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
 const importIntoEnvelope = async ({ api, importedEnv, options, siteInfo }) => {
-  // fetch env vars
-  const accountId = siteInfo.account_slug
-  const siteId = siteInfo.id
-  const dotEnvKeys = Object.keys(importedEnv)
-  const envelopeVariables = await api.getEnvVars({ accountId, siteId })
-  const envelopeKeys = envelopeVariables.map(({ key }) => key)
-
-  // if user intends to replace all existing env vars
-  // either replace; delete all existing env vars on the site
-  // or, merge; delete only the existing env vars that would collide with new .env entries
-  const keysToDelete = options.replaceExisting ? envelopeKeys : envelopeKeys.filter((key) => dotEnvKeys.includes(key))
-
-  // delete marked env vars in parallel
-  await Promise.all(keysToDelete.map((key) => api.deleteEnvVar({ accountId, siteId, key })))
-
-  // hit create endpoint
-  const body = translateFromMongoToEnvelope(importedEnv)
-  try {
-    await api.createEnvVars({ accountId, siteId, body })
-  } catch (error) {
-    throw error.json ? error.json.msg : error
-  }
-
-  // return final env to aid in --json output (for testing)
-  return {
-    ...translateFromEnvelopeToMongo(envelopeVariables.filter(({ key }) => !keysToDelete.includes(key))),
-    ...importedEnv,
-  }
-}
-
+    // fetch env vars
+    const accountId = siteInfo.account_slug;
+    const siteId = siteInfo.id;
+    const dotEnvKeys = Object.keys(importedEnv);
+    const envelopeVariables = await api.getEnvVars({ accountId, siteId });
+    // @ts-expect-error TS(7031) FIXME: Binding element 'key' implicitly has an 'any' type... Remove this comment to see the full error message
+    const envelopeKeys = envelopeVariables.map(({ key }) => key);
+    // if user intends to replace all existing env vars
+    // either replace; delete all existing env vars on the site
+    // or, merge; delete only the existing env vars that would collide with new .env entries
+    // @ts-expect-error TS(7006) FIXME: Parameter 'key' implicitly has an 'any' type.
+    const keysToDelete = options.replaceExisting ? envelopeKeys : envelopeKeys.filter((key) => dotEnvKeys.includes(key));
+    // delete marked env vars in parallel
+    // @ts-expect-error TS(7006) FIXME: Parameter 'key' implicitly has an 'any' type.
+    await Promise.all(keysToDelete.map((key) => api.deleteEnvVar({ accountId, siteId, key })));
+    // hit create endpoint
+    const body = translateFromMongoToEnvelope(importedEnv);
+    try {
+        await api.createEnvVars({ accountId, siteId, body });
+    }
+    catch (error) {
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        throw error.json ? error.json.msg : error;
+    }
+    // return final env to aid in --json output (for testing)
+    return {
+        // @ts-expect-error TS(7031) FIXME: Binding element 'key' implicitly has an 'any' type... Remove this comment to see the full error message
+        ...translateFromEnvelopeToMongo(envelopeVariables.filter(({ key }) => !keysToDelete.includes(key))),
+        ...importedEnv,
+    };
+};
 /**
  * Creates the `netlify env:import` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createEnvImportCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createEnvImportCommand = (program) => program
     .command('env:import')
     .argument('<fileName>', '.env file to import')
-    .addOption(
-      new Option(
-        '-r --replaceExisting',
-        'Old, prefer --replace-existing. Replace all existing variables instead of merging them with the current ones',
-      )
-        .default(false)
-        .hideHelp(true),
-    )
-    .option(
-      '-r, --replace-existing',
-      'Replace all existing variables instead of merging them with the current ones',
-      false,
-    )
+    .addOption(new Option('-r --replaceExisting', 'Old, prefer --replace-existing. Replace all existing variables instead of merging them with the current ones')
+    .default(false)
+    .hideHelp(true))
+    .option('-r, --replace-existing', 'Replace all existing variables instead of merging them with the current ones', false)
     .description('Import and set environment variables from .env file')
+    // @ts-expect-error TS(7006) FIXME: Parameter 'fileName' implicitly has an 'any' type.
     .action(async (fileName, options, command) => {
-      await envImport(fileName, options, command)
-    })
+    await envImport(fileName, options, command);
+});

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

@@ -1,154 +1,129 @@
-// @ts-check
-import ansiEscapes from 'ansi-escapes'
-import AsciiTable from 'ascii-table'
-import { isCI } from 'ci-info'
-import { Option } from 'commander'
-import inquirer from 'inquirer'
-import logUpdate from 'log-update'
-
-import { chalk, error, log, logJson } from '../../utils/command-helpers.mjs'
-import { AVAILABLE_CONTEXTS, getEnvelopeEnv, getHumanReadableScopes, normalizeContext } from '../../utils/env/index.mjs'
-
-const MASK_LENGTH = 50
-const MASK = '*'.repeat(MASK_LENGTH)
-
+import ansiEscapes from 'ansi-escapes';
+import AsciiTable from 'ascii-table';
+import { isCI } from 'ci-info';
+import { Option } from 'commander';
+import inquirer from 'inquirer';
+import logUpdate from 'log-update';
+import { chalk, error, log, logJson } from '../../utils/command-helpers.mjs';
+import { AVAILABLE_CONTEXTS, getEnvelopeEnv, getHumanReadableScopes, normalizeContext } from '../../utils/env/index.mjs';
+const MASK_LENGTH = 50;
+const MASK = '*'.repeat(MASK_LENGTH);
+// @ts-expect-error TS(7031) FIXME: Binding element 'environment' implicitly has an 'a... Remove this comment to see the full error message
 const getTable = ({ environment, hideValues, scopesColumn }) => {
-  const table = new AsciiTable(`Environment variables`)
-  const headings = ['Key', 'Value', scopesColumn && 'Scope'].filter(Boolean)
-  table.setHeading(...headings)
-  table.addRowMatrix(
-    Object.entries(environment).map(([key, variable]) =>
-      [
+    const table = new AsciiTable(`Environment variables`);
+    const headings = ['Key', 'Value', scopesColumn && 'Scope'].filter(Boolean);
+    table.setHeading(...headings);
+    table.addRowMatrix(Object.entries(environment).map(([key, variable]) => [
         // Key
         key,
         // Value
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
         hideValues ? MASK : variable.value || ' ',
         // Scope
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
         scopesColumn && getHumanReadableScopes(variable.scopes),
-      ].filter(Boolean),
-    ),
-  )
-  return table.toString()
-}
-
+    ].filter(Boolean)));
+    return table.toString();
+};
 /**
  * The env:list command
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  * @returns {Promise<boolean>}
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 const envList = async (options, command) => {
-  const { context, scope } = options
-  const { api, cachedConfig, site } = command.netlify
-  const siteId = site.id
-
-  if (!siteId) {
-    log('No site id found, please run inside a site folder or `netlify link`')
-    return false
-  }
-
-  const { env, siteInfo } = cachedConfig
-  const isUsingEnvelope = siteInfo.use_envelope
-  let environment = env
-
-  if (isUsingEnvelope) {
-    environment = await getEnvelopeEnv({ api, context, env, scope, siteInfo })
-  } else if (context !== 'dev' || scope !== 'any') {
-    error(
-      `To specify a context or scope, please run ${chalk.yellow(
-        'netlify open:admin',
-      )} to open the Netlify UI and opt in to the new environment variables experience from Site settings`,
-    )
-    return false
-  }
-
-  // filter out general sources
-  environment = Object.fromEntries(
-    Object.entries(environment).filter(([, variable]) => variable.sources[0] !== 'general'),
-  )
-
-  // Return json response for piping commands
-  if (options.json) {
-    const envDictionary = Object.fromEntries(
-      Object.entries(environment).map(([key, variable]) => [key, variable.value]),
-    )
-    logJson(envDictionary)
-    return false
-  }
-
-  if (options.plain) {
-    const plaintext = Object.entries(environment)
-      .map(([key, variable]) => `${key}=${variable.value}`)
-      .join('\n')
-    log(plaintext)
-    return false
-  }
-
-  const forSite = `for site ${chalk.green(siteInfo.name)}`
-  const contextType = AVAILABLE_CONTEXTS.includes(context) ? 'context' : 'branch'
-  const withContext = isUsingEnvelope ? `in the ${chalk.magenta(options.context)} ${contextType}` : ''
-  const withScope = isUsingEnvelope && scope !== 'any' ? `and ${chalk.yellow(options.scope)} scope` : ''
-  if (Object.keys(environment).length === 0) {
-    log(`No environment variables set ${forSite} ${withContext} ${withScope}`)
-    return false
-  }
-
-  // List environment in a table
-  const count = Object.keys(environment).length
-  log(`${count} environment variable${count === 1 ? '' : 's'} ${forSite} ${withContext} ${withScope}`)
-
-  if (isCI) {
-    log(getTable({ environment, hideValues: false, scopesColumn: isUsingEnvelope }))
-    return false
-  }
-
-  logUpdate(getTable({ environment, hideValues: true, scopesColumn: isUsingEnvelope }))
-  const { showValues } = await inquirer.prompt([
-    {
-      type: 'confirm',
-      name: 'showValues',
-      message: 'Show values?',
-      default: false,
-    },
-  ])
-
-  if (showValues) {
-    // since inquirer adds a prompt, we need to account for it when printing the table again
-    log(ansiEscapes.eraseLines(3))
-    logUpdate(getTable({ environment, hideValues: false, scopesColumn: isUsingEnvelope }))
-    log(`${chalk.cyan('?')} Show values? ${chalk.cyan('Yes')}`)
-  }
-}
-
+    const { context, scope } = options;
+    const { api, cachedConfig, site } = command.netlify;
+    const siteId = site.id;
+    if (!siteId) {
+        log('No site id found, please run inside a site folder or `netlify link`');
+        return false;
+    }
+    const { env, siteInfo } = cachedConfig;
+    const isUsingEnvelope = siteInfo.use_envelope;
+    let environment = env;
+    if (isUsingEnvelope) {
+        environment = await getEnvelopeEnv({ api, context, env, scope, siteInfo });
+    }
+    else if (context !== 'dev' || scope !== 'any') {
+        error(`To specify a context or scope, please run ${chalk.yellow('netlify open:admin')} to open the Netlify UI and opt in to the new environment variables experience from Site settings`);
+        return false;
+    }
+    // filter out general sources
+    environment = Object.fromEntries(
+    // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+    Object.entries(environment).filter(([, variable]) => variable.sources[0] !== 'general'));
+    // Return json response for piping commands
+    if (options.json) {
+        const envDictionary = Object.fromEntries(
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        Object.entries(environment).map(([key, variable]) => [key, variable.value]));
+        logJson(envDictionary);
+        return false;
+    }
+    if (options.plain) {
+        const plaintext = Object.entries(environment)
+            // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+            .map(([key, variable]) => `${key}=${variable.value}`)
+            .join('\n');
+        log(plaintext);
+        return false;
+    }
+    const forSite = `for site ${chalk.green(siteInfo.name)}`;
+    const contextType = AVAILABLE_CONTEXTS.includes(context) ? 'context' : 'branch';
+    const withContext = isUsingEnvelope ? `in the ${chalk.magenta(options.context)} ${contextType}` : '';
+    const withScope = isUsingEnvelope && scope !== 'any' ? `and ${chalk.yellow(options.scope)} scope` : '';
+    if (Object.keys(environment).length === 0) {
+        log(`No environment variables set ${forSite} ${withContext} ${withScope}`);
+        return false;
+    }
+    // List environment in a table
+    const count = Object.keys(environment).length;
+    log(`${count} environment variable${count === 1 ? '' : 's'} ${forSite} ${withContext} ${withScope}`);
+    if (isCI) {
+        log(getTable({ environment, hideValues: false, scopesColumn: isUsingEnvelope }));
+        return false;
+    }
+    logUpdate(getTable({ environment, hideValues: true, scopesColumn: isUsingEnvelope }));
+    const { showValues } = await inquirer.prompt([
+        {
+            type: 'confirm',
+            name: 'showValues',
+            message: 'Show values?',
+            default: false,
+        },
+    ]);
+    if (showValues) {
+        // since inquirer adds a prompt, we need to account for it when printing the table again
+        log(ansiEscapes.eraseLines(3));
+        logUpdate(getTable({ environment, hideValues: false, scopesColumn: isUsingEnvelope }));
+        log(`${chalk.cyan('?')} Show values? ${chalk.cyan('Yes')}`);
+    }
+};
 /**
  * Creates the `netlify env:list` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createEnvListCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createEnvListCommand = (program) => program
     .command('env:list')
-    .option(
-      '-c, --context <context>',
-      'Specify a deploy context or branch (contexts: "production", "deploy-preview", "branch-deploy", "dev")',
-      normalizeContext,
-      'dev',
-    )
+    .option('-c, --context <context>', 'Specify a deploy context or branch (contexts: "production", "deploy-preview", "branch-deploy", "dev")', normalizeContext, 'dev')
     .option('--json', 'Output environment variables as JSON')
     .addOption(new Option('--plain', 'Output environment variables as plaintext').conflicts('json'))
-    .addOption(
-      new Option('-s, --scope <scope>', 'Specify a scope')
-        .choices(['builds', 'functions', 'post-processing', 'runtime', 'any'])
-        .default('any'),
-    )
+    .addOption(new Option('-s, --scope <scope>', 'Specify a scope')
+    .choices(['builds', 'functions', 'post-processing', 'runtime', 'any'])
+    .default('any'))
     .addExamples([
-      'netlify env:list # list variables with values in the dev context and with any scope',
-      'netlify env:list --context production',
-      'netlify env:list --context branch:staging',
-      'netlify env:list --scope functions',
-      'netlify env:list --plain',
-    ])
+    'netlify env:list # list variables with values in the dev context and with any scope',
+    'netlify env:list --context production',
+    'netlify env:list --context branch:staging',
+    'netlify env:list --scope functions',
+    'netlify env:list --plain',
+])
     .description('Lists resolved environment variables for site (includes netlify.toml)')
+    // @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
     .action(async (options, command) => {
-      await envList(options, command)
-    })
+    await envList(options, command);
+});