netlify-cli 17.3.2 → 17.4.0

package/src/utils/dev.mjs

@@ -1,92 +1,88 @@
-// @ts-check
-import process from 'process'
-
-import getPort from 'get-port'
-import isEmpty from 'lodash/isEmpty.js'
-
-import { supportsBackgroundFunctions } from '../lib/account.mjs'
-
-import { NETLIFYDEVLOG, chalk, error, log, warn } from './command-helpers.mjs'
-import { loadDotEnvFiles } from './dot-env.mjs'
-
+import process from 'process';
+import getPort from 'get-port';
+import isEmpty from 'lodash/isEmpty.js';
+import { supportsBackgroundFunctions } from '../lib/account.mjs';
+import { NETLIFYDEVLOG, chalk, error, log, warn } from './command-helpers.mjs';
+import { loadDotEnvFiles } from './dot-env.mjs';
 // Possible sources of environment variables. For the purpose of printing log messages only. Order does not matter.
 const ENV_VAR_SOURCES = {
-  account: {
-    name: 'shared',
-    printFn: chalk.magenta,
-  },
-  addons: {
-    name: 'addon',
-    printFn: chalk.yellow,
-  },
-  configFile: {
-    name: 'netlify.toml file',
-    printFn: chalk.green,
-  },
-  general: {
-    name: 'general context',
-    printFn: chalk.italic,
-  },
-  process: {
-    name: 'process',
-    printFn: chalk.red,
-  },
-  ui: {
-    name: 'site settings',
-    printFn: chalk.blue,
-  },
-}
-
-const ERROR_CALL_TO_ACTION =
-  "Double-check your login status with 'netlify status' or contact support with details of your error."
-
+    account: {
+        name: 'shared',
+        printFn: chalk.magenta,
+    },
+    addons: {
+        name: 'addon',
+        printFn: chalk.yellow,
+    },
+    configFile: {
+        name: 'netlify.toml file',
+        printFn: chalk.green,
+    },
+    general: {
+        name: 'general context',
+        printFn: chalk.italic,
+    },
+    process: {
+        name: 'process',
+        printFn: chalk.red,
+    },
+    ui: {
+        name: 'site settings',
+        printFn: chalk.blue,
+    },
+};
+const ERROR_CALL_TO_ACTION = "Double-check your login status with 'netlify status' or contact support with details of your error.";
+// @ts-expect-error TS(7031) FIXME: Binding element 'site' implicitly has an 'any' typ... Remove this comment to see the full error message
 const validateSiteInfo = ({ site, siteInfo }) => {
-  if (isEmpty(siteInfo)) {
-    error(`Failed retrieving site information for site ${chalk.yellow(site.id)}. ${ERROR_CALL_TO_ACTION}`)
-  }
-}
-
+    if (isEmpty(siteInfo)) {
+        error(`Failed retrieving site information for site ${chalk.yellow(site.id)}. ${ERROR_CALL_TO_ACTION}`);
+    }
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
 const getAccounts = async ({ api }) => {
-  try {
-    const accounts = await api.listAccountsForUser()
-    return accounts
-  } catch (error_) {
-    error(`Failed retrieving user account: ${error_.message}. ${ERROR_CALL_TO_ACTION}`)
-  }
-}
-
+    try {
+        const accounts = await api.listAccountsForUser();
+        return accounts;
+    }
+    catch (error_) {
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        error(`Failed retrieving user account: ${error_.message}. ${ERROR_CALL_TO_ACTION}`);
+    }
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
 const getAddons = async ({ api, site }) => {
-  try {
-    const addons = await api.listServiceInstancesForSite({ siteId: site.id })
-    return addons
-  } catch (error_) {
-    error(`Failed retrieving addons for site ${chalk.yellow(site.id)}: ${error_.message}. ${ERROR_CALL_TO_ACTION}`)
-  }
-}
-
+    try {
+        const addons = await api.listServiceInstancesForSite({ siteId: site.id });
+        return addons;
+    }
+    catch (error_) {
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        error(`Failed retrieving addons for site ${chalk.yellow(site.id)}: ${error_.message}. ${ERROR_CALL_TO_ACTION}`);
+    }
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'addons' implicitly has an 'any' t... Remove this comment to see the full error message
 const getAddonsInformation = ({ addons, siteInfo }) => {
-  const urls = Object.fromEntries(
-    addons.map((addon) => [addon.service_slug, `${siteInfo.ssl_url}${addon.service_path}`]),
-  )
-  const env = Object.assign({}, ...addons.map((addon) => addon.env))
-  return { urls, env }
-}
-
+    const urls = Object.fromEntries(
+    // @ts-expect-error TS(7006) FIXME: Parameter 'addon' implicitly has an 'any' type.
+    addons.map((addon) => [addon.service_slug, `${siteInfo.ssl_url}${addon.service_path}`]));
+    // @ts-expect-error TS(7006) FIXME: Parameter 'addon' implicitly has an 'any' type.
+    const env = Object.assign({}, ...addons.map((addon) => addon.env));
+    return { urls, env };
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'accounts' implicitly has an 'any'... Remove this comment to see the full error message
 const getSiteAccount = ({ accounts, siteInfo }) => {
-  const siteAccount = accounts.find((account) => account.slug === siteInfo.account_slug)
-  if (!siteAccount) {
-    warn(`Could not find account for site '${siteInfo.name}' with account slug '${siteInfo.account_slug}'`)
-    return {}
-  }
-  return siteAccount
-}
-
+    // @ts-expect-error TS(7006) FIXME: Parameter 'account' implicitly has an 'any' type.
+    const siteAccount = accounts.find((account) => account.slug === siteInfo.account_slug);
+    if (!siteAccount) {
+        warn(`Could not find account for site '${siteInfo.name}' with account slug '${siteInfo.account_slug}'`);
+        return {};
+    }
+    return siteAccount;
+};
 // default 10 seconds for synchronous functions
-const SYNCHRONOUS_FUNCTION_TIMEOUT = 10
-
+const SYNCHRONOUS_FUNCTION_TIMEOUT = 10;
 // default 15 minutes for background functions
-const BACKGROUND_FUNCTION_TIMEOUT = 900
-
+const BACKGROUND_FUNCTION_TIMEOUT = 900;
 /**
  *
  * @param {object} config
@@ -96,118 +92,107 @@ const BACKGROUND_FUNCTION_TIMEOUT = 900
  * @param {*} config.siteInfo
  * @returns
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
 export const getSiteInformation = async ({ api, offline, site, siteInfo }) => {
-  if (site.id && !offline) {
-    validateSiteInfo({ site, siteInfo })
-    const [accounts, addons] = await Promise.all([getAccounts({ api }), getAddons({ api, site })])
-
-    const { urls: addonsUrls } = getAddonsInformation({ siteInfo, addons })
-    const account = getSiteAccount({ siteInfo, accounts })
-
-    return {
-      addonsUrls,
-      siteUrl: siteInfo.ssl_url,
-      accountId: account.id,
-      capabilities: {
-        backgroundFunctions: supportsBackgroundFunctions(account),
-      },
-      timeouts: {
-        syncFunctions: siteInfo.functions_config?.timeout ?? SYNCHRONOUS_FUNCTION_TIMEOUT,
-        backgroundFunctions: BACKGROUND_FUNCTION_TIMEOUT,
-      },
+    if (site.id && !offline) {
+        validateSiteInfo({ site, siteInfo });
+        const [accounts, addons] = await Promise.all([getAccounts({ api }), getAddons({ api, site })]);
+        const { urls: addonsUrls } = getAddonsInformation({ siteInfo, addons });
+        const account = getSiteAccount({ siteInfo, accounts });
+        return {
+            addonsUrls,
+            siteUrl: siteInfo.ssl_url,
+            accountId: account.id,
+            capabilities: {
+                backgroundFunctions: supportsBackgroundFunctions(account),
+            },
+            timeouts: {
+                syncFunctions: siteInfo.functions_config?.timeout ?? SYNCHRONOUS_FUNCTION_TIMEOUT,
+                backgroundFunctions: BACKGROUND_FUNCTION_TIMEOUT,
+            },
+        };
     }
-  }
-
-  // best defaults we can have without retrieving site information
-  return {
-    addonsUrls: {},
-    siteUrl: '',
-    capabilities: {},
-    timeouts: {
-      syncFunctions: SYNCHRONOUS_FUNCTION_TIMEOUT,
-      backgroundFunctions: BACKGROUND_FUNCTION_TIMEOUT,
-    },
-  }
-}
-
+    // best defaults we can have without retrieving site information
+    return {
+        addonsUrls: {},
+        siteUrl: '',
+        capabilities: {},
+        timeouts: {
+            syncFunctions: SYNCHRONOUS_FUNCTION_TIMEOUT,
+            backgroundFunctions: BACKGROUND_FUNCTION_TIMEOUT,
+        },
+    };
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'source' implicitly has an 'any' type.
 const getEnvSourceName = (source) => {
-  const { name = source, printFn = chalk.green } = ENV_VAR_SOURCES[source] || {}
-
-  return printFn(name)
-}
-
+    // @ts-expect-error TS(7053) FIXME: Element implicitly has an 'any' type because expre... Remove this comment to see the full error message
+    const { name = source, printFn = chalk.green } = ENV_VAR_SOURCES[source] || {};
+    return printFn(name);
+};
 /**
  * @param {{devConfig: any, env: Record<string, { sources: string[], value: string}>, site: any}} param0
  * @returns {Promise<Record<string, { sources: string[], value: string}>>}
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'devConfig' implicitly has an 'any... Remove this comment to see the full error message
 export const getDotEnvVariables = async ({ devConfig, env, site }) => {
-  const dotEnvFiles = await loadDotEnvFiles({ envFiles: devConfig.envFiles, projectDir: site.root })
-  dotEnvFiles.forEach(({ env: fileEnv, file }) => {
-    const newSourceName = `${file} file`
-
-    Object.keys(fileEnv).forEach((key) => {
-      const sources = key in env ? [newSourceName, ...env[key].sources] : [newSourceName]
-
-      if (sources.includes('internal')) {
-        return
-      }
-
-      env[key] = {
-        sources,
-        value: fileEnv[key],
-      }
-    })
-  })
-
-  return env
-}
-
+    const dotEnvFiles = await loadDotEnvFiles({ envFiles: devConfig.envFiles, projectDir: site.root });
+    // @ts-expect-error TS(2339) FIXME: Property 'env' does not exist on type '{ warning: ... Remove this comment to see the full error message
+    dotEnvFiles.forEach(({ env: fileEnv, file }) => {
+        const newSourceName = `${file} file`;
+        Object.keys(fileEnv).forEach((key) => {
+            const sources = key in env ? [newSourceName, ...env[key].sources] : [newSourceName];
+            if (sources.includes('internal')) {
+                return;
+            }
+            env[key] = {
+                sources,
+                value: fileEnv[key],
+            };
+        });
+    });
+    return env;
+};
 /**
  * Takes a set of environment variables in the format provided by @netlify/config and injects them into `process.env`
  * @param {Record<string, { sources: string[], value: string}>} env
  * @return {void}
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'env' implicitly has an 'any' type.
 export const injectEnvVariables = (env) => {
-  for (const [key, variable] of Object.entries(env)) {
-    const existsInProcess = process.env[key] !== undefined
-    const [usedSource, ...overriddenSources] = existsInProcess ? ['process', ...variable.sources] : variable.sources
-    const usedSourceName = getEnvSourceName(usedSource)
-    const isInternal = variable.sources.includes('internal')
-
-    overriddenSources.forEach((source) => {
-      const sourceName = getEnvSourceName(source)
-
-      log(
-        chalk.dim(
-          `${NETLIFYDEVLOG} Ignored ${chalk.bold(sourceName)} env var: ${chalk.yellow(
-            key,
-          )} (defined in ${usedSourceName})`,
-        ),
-      )
-    })
-
-    if (!existsInProcess || isInternal) {
-      // Omitting `general` and `internal` env vars to reduce noise in the logs.
-      if (usedSource !== 'general' && !isInternal) {
-        log(`${NETLIFYDEVLOG} Injected ${usedSourceName} env var: ${chalk.yellow(key)}`)
-      }
-
-      process.env[key] = variable.value
+    for (const [key, variable] of Object.entries(env)) {
+        const existsInProcess = process.env[key] !== undefined;
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        const [usedSource, ...overriddenSources] = existsInProcess ? ['process', ...variable.sources] : variable.sources;
+        const usedSourceName = getEnvSourceName(usedSource);
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        const isInternal = variable.sources.includes('internal');
+        // @ts-expect-error TS(7006) FIXME: Parameter 'source' implicitly has an 'any' type.
+        overriddenSources.forEach((source) => {
+            const sourceName = getEnvSourceName(source);
+            log(chalk.dim(`${NETLIFYDEVLOG} Ignored ${chalk.bold(sourceName)} env var: ${chalk.yellow(key)} (defined in ${usedSourceName})`));
+        });
+        if (!existsInProcess || isInternal) {
+            // Omitting `general` and `internal` env vars to reduce noise in the logs.
+            if (usedSource !== 'general' && !isInternal) {
+                log(`${NETLIFYDEVLOG} Injected ${usedSourceName} env var: ${chalk.yellow(key)}`);
+            }
+            // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+            process.env[key] = variable.value;
+        }
     }
-  }
-}
-
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'configuredPort' implicitly has an... Remove this comment to see the full error message
 export const acquirePort = async ({ configuredPort, defaultPort, errorMessage }) => {
-  const acquiredPort = await getPort({ port: configuredPort || defaultPort })
-  if (configuredPort && acquiredPort !== configuredPort) {
-    throw new Error(`${errorMessage}: '${configuredPort}'`)
-  }
-  return acquiredPort
-}
-
+    const acquiredPort = await getPort({ port: configuredPort || defaultPort });
+    if (configuredPort && acquiredPort !== configuredPort) {
+        throw new Error(`${errorMessage}: '${configuredPort}'`);
+    }
+    return acquiredPort;
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'fn' implicitly has an 'any' type.
 export const processOnExit = (fn) => {
-  const signals = ['SIGINT', 'SIGTERM', 'SIGQUIT', 'SIGHUP', 'exit']
-  signals.forEach((signal) => {
-    process.on(signal, fn)
-  })
-}
+    const signals = ['SIGINT', 'SIGTERM', 'SIGQUIT', 'SIGHUP', 'exit'];
+    signals.forEach((signal) => {
+        process.on(signal, fn);
+    });
+};

package/src/utils/dot-env.mjs

@@ -1,47 +1,42 @@
-// @ts-check
-import { readFile } from 'fs/promises'
-import path from 'path'
-
-import dotenv from 'dotenv'
-
-import { isFileAsync } from '../lib/fs.mjs'
-
-import { warn } from './command-helpers.mjs'
-
+import { readFile } from 'fs/promises';
+import path from 'path';
+import dotenv from 'dotenv';
+import { isFileAsync } from '../lib/fs.mjs';
+import { warn } from './command-helpers.mjs';
+// @ts-expect-error TS(7031) FIXME: Binding element 'envFiles' implicitly has an 'any'... Remove this comment to see the full error message
 export const loadDotEnvFiles = async function ({ envFiles, projectDir }) {
-  const response = await tryLoadDotEnvFiles({ projectDir, dotenvFiles: envFiles })
-
-  const filesWithWarning = response.filter((el) => el.warning)
-  filesWithWarning.forEach((el) => {
-    warn(el.warning)
-  })
-
-  return response.filter((el) => el.file && el.env)
-}
-
+    const response = await tryLoadDotEnvFiles({ projectDir, dotenvFiles: envFiles });
+    // @ts-expect-error TS(2532) FIXME: Object is possibly 'undefined'.
+    const filesWithWarning = response.filter((el) => el.warning);
+    filesWithWarning.forEach((el) => {
+        // @ts-expect-error TS(2532) FIXME: Object is possibly 'undefined'.
+        warn(el.warning);
+    });
+    // @ts-expect-error TS(2532) FIXME: Object is possibly 'undefined'.
+    return response.filter((el) => el.file && el.env);
+};
 // in the user configuration, the order is highest to lowest
-const defaultEnvFiles = ['.env.development.local', '.env.local', '.env.development', '.env']
-
+const defaultEnvFiles = ['.env.development.local', '.env.local', '.env.development', '.env'];
+// @ts-expect-error TS(7031) FIXME: Binding element 'projectDir' implicitly has an 'an... Remove this comment to see the full error message
 export const tryLoadDotEnvFiles = async ({ dotenvFiles = defaultEnvFiles, projectDir }) => {
-  const results = await Promise.all(
-    dotenvFiles.map(async (file) => {
-      const filepath = path.resolve(projectDir, file)
-      try {
-        const isFile = await isFileAsync(filepath)
-        if (!isFile) {
-          return
+    const results = await Promise.all(dotenvFiles.map(async (file) => {
+        const filepath = path.resolve(projectDir, file);
+        try {
+            const isFile = await isFileAsync(filepath);
+            if (!isFile) {
+                return;
+            }
         }
-      } catch (error) {
-        return {
-          warning: `Failed reading env variables from file: ${filepath}: ${error.message}`,
+        catch (error) {
+            return {
+                // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+                warning: `Failed reading env variables from file: ${filepath}: ${error.message}`,
+            };
         }
-      }
-      const content = await readFile(filepath, 'utf-8')
-      const env = dotenv.parse(content)
-      return { file, env }
-    }),
-  )
-
-  // we return in order of lowest to highest priority
-  return results.filter(Boolean).reverse()
-}
+        const content = await readFile(filepath, 'utf-8');
+        const env = dotenv.parse(content);
+        return { file, env };
+    }));
+    // we return in order of lowest to highest priority
+    return results.filter(Boolean).reverse();
+};