netlify-cli 15.10.0 → 16.0.0-alpha.0

package/src/utils/build-info.mjs

@@ -0,0 +1,100 @@
+// @ts-check
+
+import fuzzy from 'fuzzy'
+import inquirer from 'inquirer'
+
+import { chalk, log } from './command-helpers.mjs'
+
+/**
+ * Filters the inquirer settings based on the input
+ * @param {ReturnType<typeof formatSettingsArrForInquirer>} scriptInquirerOptions
+ * @param {string} input
+ */
+const filterSettings = function (scriptInquirerOptions, input) {
+  const filterOptions = scriptInquirerOptions.map((scriptInquirerOption) => scriptInquirerOption.name)
+  // TODO: remove once https://github.com/sindresorhus/eslint-plugin-unicorn/issues/1394 is fixed
+  // eslint-disable-next-line unicorn/no-array-method-this-argument
+  const filteredSettings = fuzzy.filter(input, filterOptions)
+  const filteredSettingNames = new Set(
+    filteredSettings.map((filteredSetting) => (input ? filteredSetting.string : filteredSetting)),
+  )
+  return scriptInquirerOptions.filter((t) => filteredSettingNames.has(t.name))
+}
+
+/** @typedef {import('@netlify/build-info').Settings} Settings */
+
+/**
+ * @param {Settings[]} settings
+ * @param {'dev' | 'build'} type The type of command (dev or build)
+ */
+const formatSettingsArrForInquirer = function (settings, type = 'dev') {
+  return settings.map((setting) => {
+    const cmd = type === 'dev' ? setting.devCommand : setting.buildCommand
+    return {
+      name: `[${chalk.yellow(setting.framework.name)}] '${cmd}'`,
+      value: { ...setting, commands: [cmd] },
+      short: `${setting.name}-${cmd}`,
+    }
+  })
+}
+
+/**
+ * Uses @netlify/build-info to detect the dev settings and port based on the framework
+ * and the build system that is used.
+ * @param {import('../commands/base-command.mjs').default} command
+ * @param {'dev' | 'build'} type The type of command (dev or build)
+ * @returns {Promise<Settings | undefined>}
+ */
+export const detectFrameworkSettings = async (command, type = 'dev') => {
+  const { relConfigFilePath } = command.netlify
+  const settings = await detectBuildSettings(command)
+  if (settings.length === 1) {
+    return settings[0]
+  }
+
+  if (settings.length > 1) {
+    /** multiple matching detectors, make the user choose */
+    const scriptInquirerOptions = formatSettingsArrForInquirer(settings, type)
+    /** @type {{chosenSettings: Settings}} */
+    const { chosenSettings } = await inquirer.prompt({
+      name: 'chosenSettings',
+      message: `Multiple possible ${type} commands found`,
+      type: 'autocomplete',
+      source(/** @type {string} */ _, input = '') {
+        if (!input) return scriptInquirerOptions
+        // only show filtered results
+        return filterSettings(scriptInquirerOptions, input)
+      },
+    })
+
+    log(`
+Update your ${relConfigFilePath} to avoid this selection prompt next time:
+
+[build]
+command = "${chosenSettings.buildCommand}"
+publish = "${chosenSettings.dist}"
+
+[dev]
+command = "${chosenSettings.devCommand}"
+`)
+    return chosenSettings
+  }
+}
+
+/**
+ * Detects and filters the build setting for a project and a command
+ * @param {import('../commands/base-command.mjs').default} command
+ */
+export const detectBuildSettings = async (command) => {
+  const { project, workspacePackage } = command
+  const buildSettings = await project.getBuildSettings(project.workspace ? workspacePackage : '')
+  return buildSettings
+    .filter((setting) => {
+      if (project.workspace && project.relativeBaseDirectory && setting.packagePath) {
+        return project.relativeBaseDirectory.startsWith(setting.packagePath)
+      }
+
+      return true
+    })
+    .filter((setting) => setting.devCommand)
+}

package/src/utils/command-helpers.mjs

@@ -24,7 +24,7 @@ const argv = process.argv.slice(2)
  * Chalk instance for CLI that can be initialized with no colors mode
  * needed for json outputs where we don't want to have colors
  * @param  {boolean} noColors - disable chalk colors
- * @return {object} - default or custom chalk instance
+ * @return {import('chalk').ChalkInstance} - default or custom chalk instance
  */
 const safeChalk = function (noColors) {
   if (noColors) {
@@ -174,12 +174,18 @@ export const warn = (message = '') => {
 
 /**
  * throws an error or log it
- * @param {string|Error} message
+ * @param {unknown} message
  * @param {object} [options]
  * @param {boolean} [options.exit]
  */
 export const error = (message = '', options = {}) => {
-  const err = message instanceof Error ? message : new Error(message)
+  const err =
+    message instanceof Error
+      ? message
+      : // eslint-disable-next-line unicorn/no-nested-ternary
+      typeof message === 'string'
+      ? new Error(message)
+      : /** @type {Error} */ ({ message, stack: undefined, name: 'Error' })
 
   if (options.exit === false) {
     const bang = chalk.red(BANG)
@@ -198,10 +204,13 @@ export const exit = (code = 0) => {
   process.exit(code)
 }
 
-// When `build.publish` is not set by the user, the CLI behavior differs in
-// several ways. It detects it by checking if `build.publish` is `undefined`.
-// However, `@netlify/config` adds a default value to `build.publish`.
-// This removes 'publish' and 'publishOrigin' in this case.
+/**
+ * When `build.publish` is not set by the user, the CLI behavior differs in
+ * several ways. It detects it by checking if `build.publish` is `undefined`.
+ * However, `@netlify/config` adds a default value to `build.publish`.
+ * This removes 'publish' and 'publishOrigin' in this case.
+ * @param {*} config
+ */
 export const normalizeConfig = (config) => {
   // Unused var here is in order to omit 'publish' from build config
   // eslint-disable-next-line no-unused-vars

package/src/utils/deploy/deploy-site.mjs

@@ -39,7 +39,6 @@ export const deploySite = async (
     maxRetry = DEFAULT_MAX_RETRY,
     // API calls this the 'title'
     message: title,
-    rootDir,
     siteEnv,
     skipFunctionsCache,
     statusCb = () => {
@@ -47,6 +46,7 @@ export const deploySite = async (
     },
     syncFileLimit = DEFAULT_SYNC_LIMIT,
     tmpDir = temporaryDirectory(),
+    workingDir,
   } = {},
 ) => {
   statusCb({
@@ -55,7 +55,7 @@ export const deploySite = async (
     phase: 'start',
   })
 
-  const edgeFunctionsDistPath = await getDistPathIfExists({ rootDir })
+  const edgeFunctionsDistPath = await getDistPathIfExists(workingDir)
   const [{ files, filesShaMap }, { fnConfig, fnShaMap, functionSchedules, functions, functionsWithNativeModules }] =
     await Promise.all([
       hashFiles({
@@ -64,7 +64,7 @@ export const deploySite = async (
         directories: [configPath, dir, edgeFunctionsDistPath].filter(Boolean),
         filter,
         hashAlgorithm,
-        normalizer: deployFileNormalizer.bind(null, rootDir),
+        normalizer: deployFileNormalizer.bind(null, workingDir),
         statusCb,
       }),
       hashFns(fnDir, {
@@ -74,7 +74,7 @@ export const deploySite = async (
         hashAlgorithm,
         statusCb,
         assetType,
-        rootDir,
+        workingDir,
         manifestPath,
         skipFunctionsCache,
         siteEnv,

package/src/utils/deploy/hash-fns.mjs

@@ -20,10 +20,10 @@ const getFunctionZips = async ({
   directories,
   functionsConfig,
   manifestPath,
-  rootDir,
   skipFunctionsCache,
   statusCb,
   tmpDir,
+  workingDir,
 }) => {
   statusCb({
     type: 'functions-manifest',
@@ -68,7 +68,7 @@ const getFunctionZips = async ({
   }
 
   return await zipFunctions(directories, tmpDir, {
-    basePath: rootDir,
+    basePath: workingDir,
     configFileDirectories: [getPathInProject([INTERNAL_FUNCTIONS_FOLDER])],
     config: functionsConfig,
   })