netlify-cli 8.0.13 → 8.1.0-rc.2

package/src/lib/functions/runtimes/rust/index.js

@@ -1,3 +1,5 @@
+// @ts-check
+const { readFile } = require('fs').promises
 const { dirname, extname, join, resolve } = require('path')
 const { platform } = require('process')
 
@@ -6,8 +8,7 @@ const toml = require('toml')
 
 const isWindows = platform === 'win32'
 
-const execa = require('../../../../utils/execa')
-const { readFileAsync } = require('../../../fs')
+const { execa } = require('../../../../utils')
 const { getPathInProject } = require('../../../settings')
 const { runFunctionsProxy } = require('../../local-proxy')
 
@@ -36,7 +37,7 @@ const getBuildFunction =
 
 const getCrateName = async (cwd) => {
   const manifestPath = await findUp('Cargo.toml', { cwd, type: 'file' })
-  const manifest = await readFileAsync(manifestPath)
+  const manifest = await readFile(manifestPath, 'utf-8')
   const { package } = toml.parse(manifest)
 
   return package.name

package/src/lib/functions/server.js

@@ -1,8 +1,7 @@
+// @ts-check
 const jwtDecode = require('jwt-decode')
 
-const { error: errorExit, log } = require('../../utils/command-helpers')
-const { getInternalFunctionsDir } = require('../../utils/functions')
-const { NETLIFYDEVERR, NETLIFYDEVLOG } = require('../../utils/logo')
+const { NETLIFYDEVERR, NETLIFYDEVLOG, error: errorExit, getInternalFunctionsDir, log } = require('../../utils')
 
 const { handleBackgroundFunction, handleBackgroundFunctionResult } = require('./background')
 const { createFormSubmissionHandler } = require('./form-submissions-handler')

package/src/lib/functions/synchronous.js

@@ -1,6 +1,7 @@
+// @ts-check
 const { Buffer } = require('buffer')
 
-const { NETLIFYDEVERR } = require('../../utils/logo')
+const { NETLIFYDEVERR } = require('../../utils')
 
 const { detectAwsSdkError } = require('./utils')
 

package/src/lib/functions/utils.js

@@ -1,6 +1,5 @@
-const chalk = require('chalk')
-
-const { warn } = require('../../utils/command-helpers')
+// @ts-check
+const { chalk, warn } = require('../../utils')
 const { getLogMessage } = require('../log')
 
 const DEFAULT_LAMBDA_OPTIONS = {

package/src/lib/functions/watcher.js

@@ -1,3 +1,4 @@
+// @ts-check
 const chokidar = require('chokidar')
 const decache = require('decache')
 const debounce = require('lodash/debounce')

package/src/lib/http-agent.js

@@ -1,10 +1,10 @@
+// @ts-check
+const { readFile } = require('fs').promises
+
 const { HttpsProxyAgent } = require('https-proxy-agent')
 const waitPort = require('wait-port')
 
-const { exit, log } = require('../utils/command-helpers')
-const { NETLIFYDEVERR, NETLIFYDEVWARN } = require('../utils/logo')
-
-const fs = require('./fs')
+const { NETLIFYDEVERR, NETLIFYDEVWARN, exit, log } = require('../utils')
 
 // https://github.com/TooTallNate/node-https-proxy-agent/issues/89
 class HttpsProxyAgentWithCA extends HttpsProxyAgent {
@@ -66,7 +66,7 @@ const tryGetAgent = async ({ certificateFile, httpProxy }) => {
   let certificate
   if (certificateFile) {
     try {
-      certificate = await fs.readFileAsync(certificateFile)
+      certificate = await readFile(certificateFile)
     } catch (error) {
       response = { warning: `Could not read certificate file '${certificateFile}'.`, message: error.message }
     }

package/src/lib/log.js

@@ -1,6 +1,7 @@
-const chalk = require('chalk')
 const dotProp = require('dot-prop')
 
+const { chalk } = require('../utils')
+
 const RED_BACKGROUND = chalk.red('-background')
 const [PRO, BUSINESS, ENTERPRISE] = ['Pro', 'Business', 'Enterprise'].map((plan) => chalk.magenta(plan))
 const BACKGROUND_FUNCTIONS_WARNING = `A serverless function ending in \`${RED_BACKGROUND}\` was detected.

package/src/lib/spinner.js

@@ -1,15 +1,31 @@
+// @ts-check
 const logSymbols = require('log-symbols')
 const ora = require('ora')
 
+/**
+ * Creates a spinner with the following text
+ * @param {object} config
+ * @param {string} config.text
+ * @returns {ora.Ora}
+ */
 const startSpinner = ({ text }) =>
   ora({
     text,
   }).start()
 
+/**
+ * Stops the spinner with the following text
+ * @param {object} config
+ * @param {object} [config.error]
+ * @param {ora.Ora} config.spinner
+ * @param {string} config.text
+ * @returns {void}
+ */
 const stopSpinner = ({ error, spinner, text }) => {
   if (!spinner) {
     return
   }
+  // TODO: refactor no package needed `log-symbols` for that
   const symbol = error ? logSymbols.error : logSymbols.success
   spinner.stopAndPersist({
     text,
@@ -17,6 +33,12 @@ const stopSpinner = ({ error, spinner, text }) => {
   })
 }
 
+/**
+ * Clears the spinner
+ * @param {object} config
+ * @param {ora.Ora} config.spinner
+ * @returns {void}
+ */
 const clearSpinner = ({ spinner }) => {
   if (spinner) {
     spinner.stop()

package/src/utils/addons/diffs/index.js

@@ -1,3 +1,4 @@
+// @ts-check
 const concordance = require('concordance')
 
 const { concordanceDiffOptions, concordanceOptions } = require('./options')

package/src/utils/addons/diffs/options.js

@@ -1,5 +1,7 @@
+// @ts-check
 const ansiStyles = require('ansi-styles')
-const chalk = require('chalk')
+
+const { chalk } = require('../../command-helpers')
 
 const forceColor = new chalk.Instance({ level: 1 })
 

package/src/utils/addons/prepare.js

@@ -1,6 +1,5 @@
-const chalk = require('chalk')
-
-const { error, exit, log, warn } = require('../command-helpers')
+// @ts-check
+const { chalk, error, exit, log, warn } = require('../command-helpers')
 
 const ADDON_VALIDATION = {
   EXISTS: 'EXISTS',
@@ -81,17 +80,25 @@ const getAddons = async ({ api, siteId }) => {
   return addons
 }
 
-const prepareAddonCommand = async ({ addonName, context, validation }) => {
-  const { netlify } = context
+/**
+ *
+ * @param {object} config
+ * @param {import('../../commands/base-command').BaseCommand} config.command
+ * @param {string} [config.addonName]
+ * @param {keyof ADDON_VALIDATION} [config.validation]
+ */
+const prepareAddonCommand = async ({ addonName, command, validation }) => {
+  const { netlify } = command
   const { api, site } = netlify
   const siteId = site.id
   if (!siteId) {
     error('No site id found, please run inside a site folder or `netlify link`')
   }
 
-  await context.authenticate()
+  await command.authenticate()
 
   const [manifest, siteData, addons] = await Promise.all([
+    // TODO: check as `getAddonManifest` did not accept a parameter error
     addonName ? getAddonManifest({ api, addonName, error }) : Promise.resolve(),
     getSiteData({ api, siteId }),
     getAddons({ api, siteId }),

package/src/utils/addons/prompts.js

@@ -1,4 +1,5 @@
-const chalk = require('chalk')
+// @ts-check
+const { chalk } = require('../command-helpers')
 
 /* programmatically generate CLI prompts */
 module.exports = function generatePrompts(settings) {

package/src/utils/addons/render.js

@@ -1,5 +1,7 @@
+// @ts-check
 const AsciiTable = require('ascii-table')
-const chalk = require('chalk')
+
+const { chalk } = require('../command-helpers')
 
 const missingValues = function (values, manifest) {
   const display = values

package/src/utils/command-helpers.js

@@ -1,33 +1,83 @@
+// @ts-check
+const os = require('os')
 const process = require('process')
 const { format, inspect } = require('util')
 
-const Errors = require('@oclif/errors')
-const argv = require('minimist')(process.argv.slice(2))
-const omit = require('omit.js').default
+// eslint-disable-next-line local-rules/no-direct-chalk-import
+const { Instance: ChalkInstance } = require('chalk')
+const WSL = require('is-wsl')
+const { default: omit } = require('omit.js')
 
+const { name, version } = require('../../package.json')
 const { clearSpinner, startSpinner } = require('../lib/spinner')
 
-const chalkInstance = require('./chalk')
 const getGlobalConfig = require('./get-global-config')
 
+/** The parsed process argv without the binary only arguments and flags */
+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
+ */
+const safeChalk = function (noColors) {
+  if (noColors) {
+    const colorlessChalk = new ChalkInstance({ level: 0 })
+    return colorlessChalk
+  }
+  return new ChalkInstance()
+}
+
+const chalk = safeChalk(argv.includes('--json'))
+
+/**
+ * Adds the filler to the start of the string
+ * @param {string} str
+ * @param {number} count
+ * @param {string} [filler]
+ * @returns {string}
+ */
+const padLeft = (str, count, filler = ' ') => str.padStart(str.length + count, filler)
+
+const platform = WSL ? 'wsl' : os.platform()
+const arch = os.arch() === 'ia32' ? 'x86' : os.arch()
+
+const USER_AGENT = `${name}/${version} ${platform}-${arch} node-${process.version}`
+
 const { NETLIFY_AUTH_TOKEN } = process.env
 
-// 5 Minutes
-const TOKEN_TIMEOUT = 3e5
+// eslint-disable-next-line no-magic-numbers
+const NETLIFY_CYAN = chalk.rgb(40, 180, 170)
 
-const chalk = chalkInstance(argv.json)
+const NETLIFYDEV = `${chalk.greenBright('◈')} ${NETLIFY_CYAN('Netlify Dev')} ${chalk.greenBright('◈')}`
+const NETLIFYDEVLOG = `${chalk.greenBright('◈')}`
+const NETLIFYDEVWARN = `${chalk.yellowBright('◈')}`
+const NETLIFYDEVERR = `${chalk.redBright('◈')}`
 
-const pollForToken = async ({ api, exitWithError, ticket }) => {
+const BANG = process.platform === 'win32' ? '»' : '›'
+
+// Poll Token timeout 5 Minutes
+const TOKEN_TIMEOUT = 3e5
+
+/**
+ *
+ * @param {object} config
+ * @param {import('netlify').NetlifyAPI} config.api
+ * @param {object} config.ticket
+ * @returns
+ */
+const pollForToken = async ({ api, ticket }) => {
   const spinner = startSpinner({ text: 'Waiting for authorization...' })
   try {
     const accessToken = await api.getAccessToken(ticket, { timeout: TOKEN_TIMEOUT })
     if (!accessToken) {
-      exitWithError('Could not retrieve access token')
+      error('Could not retrieve access token')
     }
     return accessToken
-  } catch (error) {
-    if (error.name === 'TimeoutError') {
-      exitWithError(
+  } catch (error_) {
+    if (error_.name === 'TimeoutError') {
+      error(
         `Timed out waiting for authorization. If you do not have a ${chalk.bold.greenBright(
           'Netlify',
         )} account, please create one at ${chalk.magenta(
@@ -35,29 +85,22 @@ const pollForToken = async ({ api, exitWithError, ticket }) => {
         )}, then run ${chalk.cyanBright('netlify login')} again.`,
       )
     } else {
-      exitWithError(error)
+      error(error_)
     }
   } finally {
     clearSpinner({ spinner })
   }
 }
 
-const getCwd = () => argv.cwd || process.cwd()
-
-const getAuthArg = () => {
-  // If deploy command. Support shorthand 'a' flag
-  if (argv && argv._ && argv._[0] === 'deploy') {
-    return argv.auth || argv.a
-  }
-  return argv.auth
-}
-
-const getToken = async (authFromFlag) => {
-  const tokenFromFlag = authFromFlag || getAuthArg(argv)
-
+/**
+ * Get a netlify token
+ * @param {string} [tokenFromOptions] optional token from the provided --auth options
+ * @returns {Promise<[null|string, 'flag' | 'env' |'config' |'not found']>}
+ */
+const getToken = async (tokenFromOptions) => {
   // 1. First honor command flag --auth
-  if (tokenFromFlag) {
-    return [tokenFromFlag, 'flag']
+  if (tokenFromOptions) {
+    return [tokenFromOptions, 'flag']
   }
   // 2. then Check ENV var
   if (NETLIFY_AUTH_TOKEN && NETLIFY_AUTH_TOKEN !== 'null') {
@@ -75,33 +118,58 @@ const getToken = async (authFromFlag) => {
 
 // 'api' command uses JSON output by default
 // 'functions:invoke' need to return the data from the function as is
-const isDefaultJson = () => argv._[0] === 'functions:invoke' || (argv._[0] === 'api' && argv.list !== true)
+const isDefaultJson = () => argv[0] === 'functions:invoke' || (argv[0] === 'api' && !argv.includes('--list'))
 
+/**
+ * logs a json message
+ * @param {string|object} message
+ */
 const logJson = (message = '') => {
-  if (argv.json || isDefaultJson()) {
+  if (argv.includes('--json') || isDefaultJson()) {
     process.stdout.write(JSON.stringify(message, null, 2))
   }
 }
 
 const log = (message = '', ...args) => {
-  /* If  --silent or --json flag passed disable logger */
-  if (argv.silent || argv.json || isDefaultJson()) {
+  // If  --silent or --json flag passed disable logger
+  if (argv.includes('--json') || argv.includes('--silent') || isDefaultJson()) {
     return
   }
   message = typeof message === 'string' ? message : inspect(message)
   process.stdout.write(`${format(message, ...args)}\n`)
 }
 
+/**
+ * logs a warning message
+ * @param {string} message
+ */
 const warn = (message = '') => {
-  Errors.warn(message)
+  const bang = chalk.yellow(BANG)
+  log(` ${bang}   Warning: ${message}`)
 }
 
+/**
+ * throws an error or log it
+ * @param {string|Error} message
+ * @param {object} [options]
+ * @param {boolean} [options.exit]
+ */
 const error = (message = '', options = {}) => {
-  Errors.error(message, options)
+  const err = message instanceof Error ? message : new Error(message)
+  if (options.exit === false) {
+    const bang = chalk.red(BANG)
+    if (process.env.DEBUG) {
+      process.stderr.write(` ${bang}   Warning: ${err.stack.split('\n').join(`\n ${bang}   `)}`)
+    } else {
+      process.stderr.write(` ${bang}   ${err.name}: ${err.message}\n`)
+    }
+  } else {
+    throw err
+  }
 }
 
 const exit = (code = 0) => {
-  Errors.exit(code)
+  process.exit(code)
 }
 
 // When `build.publish` is not set by the user, the CLI behavior differs in
@@ -114,15 +182,20 @@ const normalizeConfig = (config) =>
     : config
 
 module.exports = {
-  argv,
-  getCwd,
-  pollForToken,
-  log,
-  logJson,
   getToken,
-  normalizeConfig,
-  chalk,
+  exit,
+  padLeft,
+  logJson,
+  log,
   warn,
   error,
-  exit,
+  chalk,
+  pollForToken,
+  normalizeConfig,
+  USER_AGENT,
+  NETLIFY_CYAN,
+  NETLIFYDEV,
+  NETLIFYDEVLOG,
+  NETLIFYDEVWARN,
+  NETLIFYDEVERR,
 }

package/src/utils/create-stream-promise.js

@@ -1,5 +1,10 @@
 const { Buffer } = require('buffer')
 
+const SEC_TO_MILLISEC = 1e3
+
+// 6 MiB
+const DEFAULT_BYTES_LIMIT = 6e6
+
 const createStreamPromise = function (stream, timeoutSeconds, bytesLimit = DEFAULT_BYTES_LIMIT) {
   return new Promise(function streamPromiseFunc(resolve, reject) {
     let data = []
@@ -41,9 +46,4 @@ const createStreamPromise = function (stream, timeoutSeconds, bytesLimit = DEFAU
   })
 }
 
-const SEC_TO_MILLISEC = 1e3
-
-// 6 MiB
-const DEFAULT_BYTES_LIMIT = 6e6
-
 module.exports = { createStreamPromise }

package/src/utils/deferred.js

@@ -1,3 +1,4 @@
+// @ts-check
 const createDeferred = () => {
   let resolveDeferred
   let rejectDeferred

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

@@ -83,7 +83,7 @@ const deploySite = async (
 
   if (functionsWithNativeModules.length !== 0) {
     warn(`Modules with native dependencies\n
-${functionsWithNativeModules.map(({ name }) => `- ${name}`).join('\n')}    
+${functionsWithNativeModules.map(({ name }) => `- ${name}`).join('\n')}
 
 The serverless functions above use Node.js modules with native dependencies, which
 must be installed on a system with the same architecture as the function runtime. A

package/src/utils/deploy/index.js

@@ -0,0 +1,4 @@
+// @ts-check
+const { deploySite } = require('./deploy-site')
+
+module.exports = { deploySite }

package/src/utils/detect-server-settings.js

@@ -4,17 +4,15 @@ const path = require('path')
 const process = require('process')
 
 const { getFramework, listFrameworks } = require('@netlify/framework-info')
-const chalk = require('chalk')
 const fuzzy = require('fuzzy')
 const getPort = require('get-port')
 const isPlainObject = require('is-plain-obj')
 
 const { readFileAsyncCatchError } = require('../lib/fs')
 
-const { log } = require('./command-helpers')
+const { NETLIFYDEVWARN, chalk, log } = require('./command-helpers')
 const { acquirePort } = require('./dev')
 const { getInternalFunctionsDir } = require('./functions')
-const { NETLIFYDEVWARN } = require('./logo')
 
 const formatProperty = (str) => chalk.magenta(`'${str}'`)
 const formatValue = (str) => chalk.green(`'${str}'`)
@@ -106,14 +104,14 @@ const getDefaultDist = () => {
  *
  * @param {object} param0
  * @param {import('../commands/dev/types').DevConfig} param0.devConfig
- * @param {Record<string, string>} param0.flags
+ * @param {import('commander').OptionValues} param0.options
  * @param {string} param0.projectDir
  * @returns {Promise<import('./types').BaseServerSettings>}
  */
-const handleStaticServer = async ({ devConfig, flags, projectDir }) => {
+const handleStaticServer = async ({ devConfig, options, projectDir }) => {
   validateNumberProperty({ devConfig, property: 'staticServerPort' })
 
-  if (flags.dir) {
+  if (options.dir) {
     log(`${NETLIFYDEVWARN} Using simple static server because ${formatProperty('--dir')} flag was specified`)
   } else if (devConfig.framework === '#static') {
     log(
@@ -131,7 +129,7 @@ const handleStaticServer = async ({ devConfig, flags, projectDir }) => {
     )
   }
 
-  const dist = flags.dir || devConfig.publish || getDefaultDist()
+  const dist = options.dir || devConfig.publish || getDefaultDist()
   log(`${NETLIFYDEVWARN} Running static server from "${path.relative(path.dirname(projectDir), dist)}"`)
 
   const frameworkPort = await acquirePort({
@@ -263,19 +261,19 @@ const handleForcedFramework = async ({ devConfig, projectDir }) => {
 /**
  * Get the server settings based on the flags and the devConfig
  * @param {import('../commands/dev/types').DevConfig} devConfig
- * @param {Record<string, string>} flags
+ * @param {import('commander').OptionValues} options
  * @param {string} projectDir
  * @returns {Promise<import('./types').ServerSettings>}
  */
-const detectServerSettings = async (devConfig, flags, projectDir) => {
+const detectServerSettings = async (devConfig, options, projectDir) => {
   validateStringProperty({ devConfig, property: 'framework' })
 
   /** @type {Partial<import('./types').BaseServerSettings>} */
   let settings = {}
 
-  if (flags.dir || devConfig.framework === '#static') {
+  if (options.dir || devConfig.framework === '#static') {
     // serving files statically without a framework server
-    settings = await handleStaticServer({ flags, devConfig, projectDir })
+    settings = await handleStaticServer({ options, devConfig, projectDir })
   } else if (devConfig.framework === '#auto') {
     // this is the default CLI behavior
 
@@ -284,7 +282,7 @@ const detectServerSettings = async (devConfig, flags, projectDir) => {
 
     if (frameworkSettings === undefined && runDetection) {
       log(`${NETLIFYDEVWARN} No app server detected. Using simple static server`)
-      settings = await handleStaticServer({ flags, devConfig, projectDir })
+      settings = await handleStaticServer({ options, devConfig, projectDir })
     } else {
       validateFrameworkConfig({ devConfig })
       const { command, frameworkPort, dist, framework, env, pollingStrategies = [] } = frameworkSettings || {}

package/src/utils/dev.js

@@ -1,15 +1,14 @@
+// @ts-check
 const process = require('process')
 
-const chalk = require('chalk')
 const { get } = require('dot-prop')
 const getPort = require('get-port')
 const isEmpty = require('lodash/isEmpty')
 
 const { supportsBackgroundFunctions } = require('../lib/account')
 
-const { error: failAndExit, log, warn } = require('./command-helpers')
+const { NETLIFYDEVLOG, chalk, error, log, warn } = require('./command-helpers')
 const { loadDotEnvFiles } = require('./dot-env')
-const { NETLIFYDEVLOG } = require('./logo')
 
 // Possible sources of environment variables. For the purpose of printing log messages only. Order does not matter.
 const ENV_VAR_SOURCES = {
@@ -44,7 +43,7 @@ const ERROR_CALL_TO_ACTION =
 
 const validateSiteInfo = ({ site, siteInfo }) => {
   if (isEmpty(siteInfo)) {
-    failAndExit(`Failed retrieving site information for site ${chalk.yellow(site.id)}. ${ERROR_CALL_TO_ACTION}`)
+    error(`Failed retrieving site information for site ${chalk.yellow(site.id)}. ${ERROR_CALL_TO_ACTION}`)
   }
 }
 
@@ -52,8 +51,8 @@ const getAccounts = async ({ api }) => {
   try {
     const accounts = await api.listAccountsForUser()
     return accounts
-  } catch (error) {
-    failAndExit(`Failed retrieving user account: ${error.message}. ${ERROR_CALL_TO_ACTION}`)
+  } catch (error_) {
+    error(`Failed retrieving user account: ${error_.message}. ${ERROR_CALL_TO_ACTION}`)
   }
 }
 
@@ -61,8 +60,8 @@ const getAddons = async ({ api, site }) => {
   try {
     const addons = await api.listServiceInstancesForSite({ siteId: site.id })
     return addons
-  } catch (error) {
-    failAndExit(`Failed retrieving addons for site ${chalk.yellow(site.id)}: ${error.message}. ${ERROR_CALL_TO_ACTION}`)
+  } catch (error_) {
+    error(`Failed retrieving addons for site ${chalk.yellow(site.id)}: ${error_.message}. ${ERROR_CALL_TO_ACTION}`)
   }
 }
 
@@ -89,8 +88,17 @@ const SYNCHRONOUS_FUNCTION_TIMEOUT = 10
 // default 15 minutes for background functions
 const BACKGROUND_FUNCTION_TIMEOUT = 900
 
-const getSiteInformation = async ({ flags = {}, api, site, siteInfo }) => {
-  if (site.id && !flags.offline) {
+/**
+ *
+ * @param {object} config
+ * @param {boolean} config.offline
+ * @param {*} config.api
+ * @param {*} config.site
+ * @param {*} config.siteInfo
+ * @returns
+ */
+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 })])
 

package/src/utils/dot-env.js

@@ -1,8 +1,10 @@
+// @ts-check
+const { readFile } = require('fs').promises
 const path = require('path')
 
 const dotenv = require('dotenv')
 
-const { isFileAsync, readFileAsync } = require('../lib/fs')
+const { isFileAsync } = require('../lib/fs')
 
 const { warn } = require('./command-helpers')
 
@@ -32,7 +34,7 @@ const tryLoadDotEnvFiles = async ({ projectDir }) => {
           warning: `Failed reading env variables from file: ${filepath}: ${error.message}`,
         }
       }
-      const content = await readFileAsync(filepath)
+      const content = await readFile(filepath, 'utf-8')
       const env = dotenv.parse(content)
       return { file, env }
     }),