netlify-cli 17.3.1 → 17.4.0

package/src/utils/run-build.mjs

@@ -1,48 +1,40 @@
-// @ts-check
-import { promises as fs } from 'fs'
-import path, { join } from 'path'
-
-import { getBootstrapURL } from '../lib/edge-functions/bootstrap.mjs'
-import { INTERNAL_EDGE_FUNCTIONS_FOLDER } from '../lib/edge-functions/consts.mjs'
-import { getPathInProject } from '../lib/settings.mjs'
-
-import { error } from './command-helpers.mjs'
-import { startFrameworkServer } from './framework-server.mjs'
-import { INTERNAL_FUNCTIONS_FOLDER } from './functions/index.mjs'
-
-const netlifyBuildPromise = import('@netlify/build')
-
+import { promises as fs } from 'fs';
+import path, { join } from 'path';
+import { getBootstrapURL } from '../lib/edge-functions/bootstrap.mjs';
+import { INTERNAL_EDGE_FUNCTIONS_FOLDER } from '../lib/edge-functions/consts.mjs';
+import { getPathInProject } from '../lib/settings.mjs';
+import { error } from './command-helpers.mjs';
+import { startFrameworkServer } from './framework-server.mjs';
+import { INTERNAL_FUNCTIONS_FOLDER } from './functions/index.mjs';
+const netlifyBuildPromise = import('@netlify/build');
 /**
  * Copies `netlify.toml`, if one is defined, into the `.netlify` internal
  * directory and returns the path to its new location.
  * @param {string} configPath
  * @param {string} destinationFolder The folder where it should be copied to. Either the root of the repo or a package inside a monorepo
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'configPath' implicitly has an 'any' typ... Remove this comment to see the full error message
 const copyConfig = async (configPath, destinationFolder) => {
-  const newConfigPath = path.resolve(destinationFolder, getPathInProject(['netlify.toml']))
-
-  try {
-    await fs.copyFile(configPath, newConfigPath)
-  } catch {
-    // no-op
-  }
-
-  return newConfigPath
-}
-
+    const newConfigPath = path.resolve(destinationFolder, getPathInProject(['netlify.toml']));
+    try {
+        await fs.copyFile(configPath, newConfigPath);
+    }
+    catch {
+        // no-op
+    }
+    return newConfigPath;
+};
 /**
  * @param {string} basePath
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'basePath' implicitly has an 'any' type.
 const cleanInternalDirectory = async (basePath) => {
-  const ops = [INTERNAL_FUNCTIONS_FOLDER, INTERNAL_EDGE_FUNCTIONS_FOLDER, 'netlify.toml'].map((name) => {
-    const fullPath = path.resolve(basePath, getPathInProject([name]))
-
-    return fs.rm(fullPath, { force: true, recursive: true })
-  })
-
-  await Promise.all(ops)
-}
-
+    const ops = [INTERNAL_FUNCTIONS_FOLDER, INTERNAL_EDGE_FUNCTIONS_FOLDER, 'netlify.toml'].map((name) => {
+        const fullPath = path.resolve(basePath, getPathInProject([name]));
+        return fs.rm(fullPath, { force: true, recursive: true });
+    });
+    await Promise.all(ops);
+};
 /**
  * @param {object} params
  * @param {import('../commands/base-command.mjs').default} params.command
@@ -53,110 +45,95 @@ const cleanInternalDirectory = async (basePath) => {
  * @param {'build' | 'dev'} [params.timeline]
  * @returns
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'command' implicitly has an 'any' ... Remove this comment to see the full error message
 export const runNetlifyBuild = async ({ command, env = {}, options, settings, timeline = 'build' }) => {
-  const { cachedConfig, site } = command.netlify
-
-  const { default: buildSite, startDev } = await netlifyBuildPromise
-
-  const sharedOptions = {
-    cachedConfig,
-    configPath: cachedConfig.configPath,
-    siteId: cachedConfig.siteInfo.id,
-    token: cachedConfig.token,
-    dry: options.dry,
-    debug: options.debug,
-    context: options.context,
-    mode: 'cli',
-    telemetry: false,
-    buffer: false,
-    offline: options.offline,
-    packagePath: command.workspacePackage,
-    cwd: cachedConfig.buildDir,
-    quiet: options.quiet,
-    saveConfig: options.saveConfig,
-    edgeFunctionsBootstrapURL: getBootstrapURL(),
-  }
-
-  const devCommand = async (settingsOverrides = {}) => {
-    let cwd = command.workingDir
-
-    if (!options.cwd && command.project.workspace?.packages.length) {
-      cwd = join(command.project.jsWorkspaceRoot, settings.baseDirectory || '')
-    }
-
-    const { ipVersion } = await startFrameworkServer({
-      settings: {
-        ...settings,
-        ...settingsOverrides,
-      },
-      cwd,
-    })
-
-    settings.frameworkHost = ipVersion === 6 ? '::1' : '127.0.0.1'
-  }
-
-  if (timeline === 'build') {
-    // Start by cleaning the internal directory, as it may have artifacts left
-    // by previous builds.
-    await cleanInternalDirectory(site.root)
-
-    // Copy `netlify.toml` into the internal directory. This will be the new
-    // location of the config file for the duration of the command.
-    const tempConfigPath = await copyConfig(cachedConfig.configPath, command.workingDir)
-    const buildSiteOptions = {
-      ...sharedOptions,
-      outputConfigPath: tempConfigPath,
-      saveConfig: true,
-    }
-
-    // Run Netlify Build using the main entry point.
-    const { netlifyConfig, success } = await buildSite(buildSiteOptions)
-
-    if (!success) {
-      error('Could not start local server due to a build error')
-
-      return {}
-    }
-
-    // Start the dev server, forcing the usage of a static server as opposed to
-    // the framework server.
-    const settingsOverrides = {
-      command: undefined,
-      useStaticServer: true,
+    const { cachedConfig, site } = command.netlify;
+    const { default: buildSite, startDev } = await netlifyBuildPromise;
+    const sharedOptions = {
+        cachedConfig,
+        configPath: cachedConfig.configPath,
+        siteId: cachedConfig.siteInfo.id,
+        token: cachedConfig.token,
+        dry: options.dry,
+        debug: options.debug,
+        context: options.context,
+        mode: 'cli',
+        telemetry: false,
+        buffer: false,
+        offline: options.offline,
+        packagePath: command.workspacePackage,
+        cwd: cachedConfig.buildDir,
+        quiet: options.quiet,
+        saveConfig: options.saveConfig,
+        edgeFunctionsBootstrapURL: getBootstrapURL(),
+    };
+    const devCommand = async (settingsOverrides = {}) => {
+        let cwd = command.workingDir;
+        if (!options.cwd && command.project.workspace?.packages.length) {
+            cwd = join(command.project.jsWorkspaceRoot, settings.baseDirectory || '');
+        }
+        const { ipVersion } = await startFrameworkServer({
+            settings: {
+                ...settings,
+                ...settingsOverrides,
+            },
+            cwd,
+        });
+        settings.frameworkHost = ipVersion === 6 ? '::1' : '127.0.0.1';
+    };
+    if (timeline === 'build') {
+        // Start by cleaning the internal directory, as it may have artifacts left
+        // by previous builds.
+        await cleanInternalDirectory(site.root);
+        // Copy `netlify.toml` into the internal directory. This will be the new
+        // location of the config file for the duration of the command.
+        const tempConfigPath = await copyConfig(cachedConfig.configPath, command.workingDir);
+        const buildSiteOptions = {
+            ...sharedOptions,
+            outputConfigPath: tempConfigPath,
+            saveConfig: true,
+        };
+        // Run Netlify Build using the main entry point.
+        // @ts-expect-error TS(2345) FIXME: Argument of type '{ outputConfigPath: string; save... Remove this comment to see the full error message
+        const { netlifyConfig, success } = await buildSite(buildSiteOptions);
+        if (!success) {
+            error('Could not start local server due to a build error');
+            return {};
+        }
+        // Start the dev server, forcing the usage of a static server as opposed to
+        // the framework server.
+        const settingsOverrides = {
+            command: undefined,
+            useStaticServer: true,
+            dist: undefined,
+        };
+        if (!options.dir && netlifyConfig?.build?.publish) {
+            settingsOverrides.dist = netlifyConfig.build.publish;
+        }
+        await devCommand(settingsOverrides);
+        return { configPath: tempConfigPath };
     }
-    if (!options.dir && netlifyConfig?.build?.publish) {
-      settingsOverrides.dist = netlifyConfig.build.publish
+    const startDevOptions = {
+        ...sharedOptions,
+        // Set `quiet` to suppress non-essential output from Netlify Build unless
+        // the `debug` flag is set.
+        quiet: !options.debug,
+        env,
+    };
+    // Run Netlify Build using the `startDev` entry point.
+    const { error: startDevError, success } = await startDev(devCommand, startDevOptions);
+    if (!success && startDevError) {
+        error(`Could not start local development server\n\n${startDevError.message}\n\n${startDevError.stack}`);
     }
-    await devCommand(settingsOverrides)
-
-    return { configPath: tempConfigPath }
-  }
-
-  const startDevOptions = {
-    ...sharedOptions,
-
-    // Set `quiet` to suppress non-essential output from Netlify Build unless
-    // the `debug` flag is set.
-    quiet: !options.debug,
-    env,
-  }
-
-  // Run Netlify Build using the `startDev` entry point.
-  const { error: startDevError, success } = await startDev(devCommand, startDevOptions)
-
-  if (!success && startDevError) {
-    error(`Could not start local development server\n\n${startDevError.message}\n\n${startDevError.stack}`)
-  }
-
-  return {}
-}
-
+    return {};
+};
 /**
  * @param {Omit<Parameters<typeof runNetlifyBuild>[0], 'timeline'>} options
  */
-export const runDevTimeline = (options) => runNetlifyBuild({ ...options, timeline: 'dev' })
-
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
+export const runDevTimeline = (options) => runNetlifyBuild({ ...options, timeline: 'dev' });
 /**
  * @param {Omit<Parameters<typeof runNetlifyBuild>[0], 'timeline'>} options
  */
-export const runBuildTimeline = (options) => runNetlifyBuild({ ...options, timeline: 'build' })
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
+export const runBuildTimeline = (options) => runNetlifyBuild({ ...options, timeline: 'build' });

package/src/utils/shell.mjs

@@ -1,42 +1,40 @@
-// @ts-check
-import process from 'process'
-
-import execa from 'execa'
-import stripAnsiCc from 'strip-ansi-control-characters'
-
-import { chalk, log, NETLIFYDEVERR, NETLIFYDEVWARN } from './command-helpers.mjs'
-import { processOnExit } from './dev.mjs'
-
+import process from 'process';
+import execa from 'execa';
+// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'stri... Remove this comment to see the full error message
+import stripAnsiCc from 'strip-ansi-control-characters';
+import { chalk, log, NETLIFYDEVERR, NETLIFYDEVWARN } from './command-helpers.mjs';
+import { processOnExit } from './dev.mjs';
 /**
  * @type {(() => Promise<void>)[]} - array of functions to run before the process exits
  */
-const cleanupWork = []
-
-let cleanupStarted = false
-
+// @ts-expect-error TS(7034) FIXME: Variable 'cleanupWork' implicitly has type 'any[]'... Remove this comment to see the full error message
+const cleanupWork = [];
+let cleanupStarted = false;
 /**
  * @param {() => Promise<void>} job
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'job' implicitly has an 'any' type.
 export const addCleanupJob = (job) => {
-  cleanupWork.push(job)
-}
-
+    cleanupWork.push(job);
+};
 /**
  * @param {object} input
  * @param {number=} input.exitCode The exit code to return when exiting the process after cleanup
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'exitCode' implicitly has an 'any'... Remove this comment to see the full error message
 const cleanupBeforeExit = async ({ exitCode }) => {
-  // If cleanup has started, then wherever started it will be responsible for exiting
-  if (!cleanupStarted) {
-    cleanupStarted = true
-    try {
-      await Promise.all(cleanupWork.map((cleanup) => cleanup()))
-    } finally {
-      process.exit(exitCode)
+    // If cleanup has started, then wherever started it will be responsible for exiting
+    if (!cleanupStarted) {
+        cleanupStarted = true;
+        try {
+            // @ts-expect-error TS(7005) FIXME: Variable 'cleanupWork' implicitly has an 'any[]' t... Remove this comment to see the full error message
+            await Promise.all(cleanupWork.map((cleanup) => cleanup()));
+        }
+        finally {
+            process.exit(exitCode);
+        }
     }
-  }
-}
-
+};
 /**
  * Run a command and pipe stdout, stderr and stdin
  * @param {string} command
@@ -46,70 +44,68 @@ const cleanupBeforeExit = async ({ exitCode }) => {
  * @param {string} [options.cwd]
  * @returns {execa.ExecaChildProcess<string>}
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'command' implicitly has an 'any' type.
 export const runCommand = (command, options = {}) => {
-  const { cwd, env = {}, spinner = null } = options
-  const commandProcess = execa.command(command, {
-    preferLocal: true,
-    // we use reject=false to avoid rejecting synchronously when the command doesn't exist
-    reject: false,
-    env: {
-      // we want always colorful terminal outputs
-      FORCE_COLOR: 'true',
-      ...env,
-    },
-    // windowsHide needs to be false for child process to terminate properly on Windows
-    windowsHide: false,
-    cwd,
-  })
-
-  // This ensures that an active spinner stays at the bottom of the commandline
-  // even though the actual framework command might be outputting stuff
-  const pipeDataWithSpinner = (writeStream, chunk) => {
-    if (spinner && spinner.isSpinning) {
-      spinner.clear()
-      spinner.isSilent = true
-    }
-    writeStream.write(chunk, () => {
-      if (spinner && spinner.isSpinning) {
-        spinner.isSilent = false
-        spinner.render()
-      }
-    })
-  }
-
-  commandProcess.stdout.pipe(stripAnsiCc.stream()).on('data', pipeDataWithSpinner.bind(null, process.stdout))
-  commandProcess.stderr.pipe(stripAnsiCc.stream()).on('data', pipeDataWithSpinner.bind(null, process.stderr))
-  process.stdin.pipe(commandProcess.stdin)
-
-  // we can't try->await->catch since we don't want to block on the framework server which
-  // is a long running process
-  // eslint-disable-next-line promise/catch-or-return
-  commandProcess
-    // eslint-disable-next-line promise/prefer-await-to-then
-    .then(async () => {
-      const result = await commandProcess
-      const [commandWithoutArgs] = command.split(' ')
-      if (result.failed && isNonExistingCommandError({ command: commandWithoutArgs, error: result })) {
-        log(
-          `${NETLIFYDEVERR} Failed running command: ${command}. Please verify ${chalk.magenta(
-            `'${commandWithoutArgs}'`,
-          )} exists`,
-        )
-      } else {
-        const errorMessage = result.failed
-          ? `${NETLIFYDEVERR} ${result.shortMessage}`
-          : `${NETLIFYDEVWARN} "${command}" exited with code ${result.exitCode}`
-
-        log(`${errorMessage}. Shutting down Netlify Dev server`)
-      }
-
-      return await cleanupBeforeExit({ exitCode: 1 })
-    })
-  processOnExit(async () => await cleanupBeforeExit({}))
-
-  return commandProcess
-}
-
+    // @ts-expect-error TS(2339) FIXME: Property 'cwd' does not exist on type '{}'.
+    const { cwd, env = {}, spinner = null } = options;
+    const commandProcess = execa.command(command, {
+        preferLocal: true,
+        // we use reject=false to avoid rejecting synchronously when the command doesn't exist
+        reject: false,
+        env: {
+            // we want always colorful terminal outputs
+            FORCE_COLOR: 'true',
+            ...env,
+        },
+        // windowsHide needs to be false for child process to terminate properly on Windows
+        windowsHide: false,
+        cwd,
+    });
+    // This ensures that an active spinner stays at the bottom of the commandline
+    // even though the actual framework command might be outputting stuff
+    // @ts-expect-error TS(7006) FIXME: Parameter 'writeStream' implicitly has an 'any' ty... Remove this comment to see the full error message
+    const pipeDataWithSpinner = (writeStream, chunk) => {
+        if (spinner && spinner.isSpinning) {
+            spinner.clear();
+            spinner.isSilent = true;
+        }
+        writeStream.write(chunk, () => {
+            if (spinner && spinner.isSpinning) {
+                spinner.isSilent = false;
+                spinner.render();
+            }
+        });
+    };
+    // @ts-expect-error TS(2531) FIXME: Object is possibly 'null'.
+    commandProcess.stdout.pipe(stripAnsiCc.stream()).on('data', pipeDataWithSpinner.bind(null, process.stdout));
+    // @ts-expect-error TS(2531) FIXME: Object is possibly 'null'.
+    commandProcess.stderr.pipe(stripAnsiCc.stream()).on('data', pipeDataWithSpinner.bind(null, process.stderr));
+    // @ts-expect-error TS(2345) FIXME: Argument of type 'Writable | null' is not assignab... Remove this comment to see the full error message
+    process.stdin.pipe(commandProcess.stdin);
+    // we can't try->await->catch since we don't want to block on the framework server which
+    // is a long running process
+    // eslint-disable-next-line promise/catch-or-return
+    commandProcess
+        // eslint-disable-next-line promise/prefer-await-to-then
+        .then(async () => {
+        const result = await commandProcess;
+        const [commandWithoutArgs] = command.split(' ');
+        if (result.failed && isNonExistingCommandError({ command: commandWithoutArgs, error: result })) {
+            log(`${NETLIFYDEVERR} Failed running command: ${command}. Please verify ${chalk.magenta(`'${commandWithoutArgs}'`)} exists`);
+        }
+        else {
+            const errorMessage = result.failed
+                // @ts-expect-error TS(2339) FIXME: Property 'shortMessage' does not exist on type 'Ex... Remove this comment to see the full error message
+                ? `${NETLIFYDEVERR} ${result.shortMessage}`
+                : `${NETLIFYDEVWARN} "${command}" exited with code ${result.exitCode}`;
+            log(`${errorMessage}. Shutting down Netlify Dev server`);
+        }
+        return await cleanupBeforeExit({ exitCode: 1 });
+    });
+    // @ts-expect-error TS(2345) FIXME: Argument of type '{}' is not assignable to paramet... Remove this comment to see the full error message
+    processOnExit(async () => await cleanupBeforeExit({}));
+    return commandProcess;
+};
 /**
  *
  * @param {object} config
@@ -117,21 +113,18 @@ export const runCommand = (command, options = {}) => {
  * @param {*} config.error
  * @returns
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'command' implicitly has an 'any' ... Remove this comment to see the full error message
 const isNonExistingCommandError = ({ command, error: commandError }) => {
-  // `ENOENT` is only returned for non Windows systems
-  // See https://github.com/sindresorhus/execa/pull/447
-  if (commandError.code === 'ENOENT') {
-    return true
-  }
-
-  // if the command is a package manager we let it report the error
-  if (['yarn', 'npm', 'pnpm'].includes(command)) {
-    return false
-  }
-
-  // this only works on English versions of Windows
-  return (
-    typeof commandError.message === 'string' &&
-    commandError.message.includes('is not recognized as an internal or external command')
-  )
-}
+    // `ENOENT` is only returned for non Windows systems
+    // See https://github.com/sindresorhus/execa/pull/447
+    if (commandError.code === 'ENOENT') {
+        return true;
+    }
+    // if the command is a package manager we let it report the error
+    if (['yarn', 'npm', 'pnpm'].includes(command)) {
+        return false;
+    }
+    // this only works on English versions of Windows
+    return (typeof commandError.message === 'string' &&
+        commandError.message.includes('is not recognized as an internal or external command'));
+};

package/src/utils/sign-redirect.mjs

@@ -1,16 +1,16 @@
-import jwt from 'jsonwebtoken'
-
+// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'json... Remove this comment to see the full error message
+import jwt from 'jsonwebtoken';
 // https://docs.netlify.com/routing/redirects/rewrites-proxies/#signed-proxy-redirects
+// @ts-expect-error TS(7031) FIXME: Binding element 'deployContext' implicitly has an ... Remove this comment to see the full error message
 export const signRedirect = ({ deployContext, secret, siteID, siteURL }) => {
-  const claims = {
-    deploy_context: deployContext,
-    netlify_id: siteID,
-    site_url: siteURL,
-  }
-  const options = {
-    expiresIn: '5 minutes',
-    issuer: 'netlify',
-  }
-
-  return jwt.sign(claims, secret, options)
-}
+    const claims = {
+        deploy_context: deployContext,
+        netlify_id: siteID,
+        site_url: siteURL,
+    };
+    const options = {
+        expiresIn: '5 minutes',
+        issuer: 'netlify',
+    };
+    return jwt.sign(claims, secret, options);
+};