netlify-cli 8.0.7 → 8.1.0-rc

package/src/utils/header.js

@@ -1,7 +1,7 @@
-const chalk = require('chalk')
-
 const pkg = require('../../package.json')
 
+const { chalk } = require('./command-helpers')
+
 module.exports = function header(context) {
   const title = `${chalk.bgBlack.cyan('⬥ Netlify CLI')}`
   const docsMsg = `${chalk.greenBright('Read the docs:')} https://www.netlify.com/docs/cli`

package/src/utils/headers.js

@@ -1,7 +1,6 @@
 const { parseAllHeaders } = require('netlify-headers-parser')
 
-const { log } = require('./command-helpers')
-const { NETLIFYDEVERR } = require('./logo')
+const { NETLIFYDEVERR, log } = require('./command-helpers')
 
 /**
  * Get the matching headers for `path` given a set of `rules`.

package/src/utils/index.js

@@ -0,0 +1,42 @@
+// @ts-check
+const commandHelpers = require('./command-helpers')
+const createStreamPromise = require('./create-stream-promise')
+const deploy = require('./deploy')
+const detectServerSettings = require('./detect-server-settings')
+const dev = require('./dev')
+const execa = require('./execa')
+const functions = require('./functions')
+const getGlobalConfig = require('./get-global-config')
+const getRepoData = require('./get-repo-data')
+const ghAuth = require('./gh-auth')
+const gitignore = require('./gitignore')
+const liveTunnel = require('./live-tunnel')
+const openBrowser = require('./open-browser')
+const parseRawFlags = require('./parse-raw-flags')
+const proxy = require('./proxy')
+const readRepoURL = require('./read-repo-url')
+const StateConfig = require('./state-config')
+const telemetry = require('./telemetry')
+const trafficMesh = require('./traffic-mesh')
+
+module.exports = {
+  ...commandHelpers,
+  ...createStreamPromise,
+  ...deploy,
+  ...detectServerSettings,
+  ...dev,
+  ...functions,
+  ...getRepoData,
+  ...ghAuth,
+  ...gitignore,
+  ...liveTunnel,
+  ...openBrowser,
+  ...parseRawFlags,
+  ...proxy,
+  ...readRepoURL,
+  ...StateConfig,
+  ...telemetry,
+  ...trafficMesh,
+  execa,
+  getGlobalConfig,
+}

package/src/utils/init/config-github.js

@@ -1,7 +1,7 @@
+// @ts-check
 const { Octokit } = require('@octokit/rest')
-const chalk = require('chalk')
 
-const { error: failAndExit, log } = require('../command-helpers')
+const { chalk, error: failAndExit, log } = require('../command-helpers')
 const { getGitHubToken: ghauth } = require('../gh-auth')
 
 const { createDeployKey, formatErrorMessage, getBuildSettings, saveNetlifyToml, setupSite } = require('./utils')
@@ -23,7 +23,7 @@ const PAGE_SIZE = 100
 
 /**
  * Get a valid github token
- * @returns {string}
+ * @returns {Promise<string>}
  */
 const getGitHubToken = async ({ globalConfig }) => {
   const userId = globalConfig.get('userId')
@@ -196,8 +196,15 @@ const addNotificationHooks = async ({ api, siteId, token }) => {
   log(`Netlify Notification Hooks configured!`)
 }
 
-const configGithub = async ({ context, repoName, repoOwner, siteId }) => {
-  const { netlify } = context
+/**
+ * @param {object} config
+ * @param {import('../../commands/base-command').BaseCommand} config.command
+ * @param {string} config.repoName
+ * @param {string} config.repoOwner
+ * @param {string} config.siteId
+ */
+const configGithub = async ({ command, repoName, repoOwner, siteId }) => {
+  const { netlify } = command
   const {
     api,
     cachedConfig: { configPath, env },

package/src/utils/init/config-manual.js

@@ -1,3 +1,4 @@
+// @ts-check
 const inquirer = require('inquirer')
 
 const { exit, log } = require('../command-helpers')
@@ -51,8 +52,14 @@ const addDeployHook = async ({ deployHook }) => {
   return deployHookAdded
 }
 
-module.exports = async function configManual({ context, repoData, siteId }) {
-  const { netlify } = context
+/**
+ * @param {object} config
+ * @param {import('../../commands/base-command').BaseCommand} config.command
+ * @param {*} config.repoData
+ * @param {string} config.siteId
+ */
+module.exports = async function configManual({ command, repoData, siteId }) {
+  const { netlify } = command
   const {
     api,
     cachedConfig: { configPath, env },

package/src/utils/init/config.js

@@ -1,6 +1,5 @@
-const chalk = require('chalk')
-
-const { log } = require('../command-helpers')
+// @ts-check
+const { chalk, log } = require('../command-helpers')
 
 const { configGithub } = require('./config-github')
 const configManual = require('./config-manual')
@@ -18,14 +17,21 @@ const logSuccess = (repoData) => {
   `)
 }
 
-const configureRepo = async ({ context, manual, repoData, siteId }) => {
+/**
+ * @param {object} config
+ * @param {import('../../commands/base-command').BaseCommand} config.command
+ * @param {boolean} config.manual
+ * @param {*} config.repoData
+ * @param {string} config.siteId
+ */
+const configureRepo = async ({ command, manual, repoData, siteId }) => {
   if (manual) {
-    await configManual({ context, siteId, repoData })
+    await configManual({ command, siteId, repoData })
   } else if (repoData.provider === 'github') {
-    await configGithub({ context, siteId, repoName: repoData.name, repoOwner: repoData.owner })
+    await configGithub({ command, siteId, repoName: repoData.name, repoOwner: repoData.owner })
   } else {
     log(`No configurator found for the provided git remote. Configuring manually...`)
-    await configManual({ context, siteId, repoData })
+    await configManual({ command, siteId, repoData })
   }
 
   logSuccess(repoData)

package/src/utils/init/frameworks.js

@@ -1,3 +1,4 @@
+// @ts-check
 const { listFrameworks } = require('@netlify/framework-info')
 
 const getFrameworkInfo = async ({ baseDirectory, nodeVersion }) => {

package/src/utils/init/node-version.js

@@ -1,8 +1,10 @@
+// @ts-check
+const { readFile } = require('fs').promises
+
 const { get } = require('dot-prop')
 const locatePath = require('locate-path')
 const nodeVersionAlias = require('node-version-alias')
 
-const { readFileAsync } = require('../../lib/fs')
 const { warn } = require('../command-helpers')
 
 const DEFAULT_NODE_VERSION = '12.18.0'
@@ -16,7 +18,7 @@ const detectNodeVersion = async ({ baseDirectory, env }) => {
   try {
     const nodeVersionFile = await locatePath(['.nvmrc', '.node-version'], { cwd: baseDirectory })
     const configuredVersion =
-      nodeVersionFile === undefined ? get(env, 'NODE_VERSION.value') : await readFileAsync(nodeVersionFile, 'utf8')
+      nodeVersionFile === undefined ? get(env, 'NODE_VERSION.value') : await readFile(nodeVersionFile, 'utf8')
 
     const version =
       configuredVersion === undefined

package/src/utils/init/plugins.js

@@ -1,3 +1,4 @@
+// @ts-check
 const { pluginsList, pluginsUrl } = require('@netlify/plugins-list')
 const fetch = require('node-fetch')
 

package/src/utils/init/utils.js

@@ -1,15 +1,16 @@
+// @ts-check
+const { existsSync } = require('fs')
+const { writeFile } = require('fs').promises
 const { EOL } = require('os')
 const path = require('path')
 const process = require('process')
 
-const chalk = require('chalk')
 const cleanDeep = require('clean-deep')
 const inquirer = require('inquirer')
 const isEmpty = require('lodash/isEmpty')
 
-const { fileExistsAsync, writeFileAsync } = require('../../lib/fs')
 const { normalizeBackslash } = require('../../lib/path')
-const { error: failAndExit, warn } = require('../command-helpers')
+const { chalk, error: failAndExit, warn } = require('../command-helpers')
 
 const { getFrameworkInfo } = require('./frameworks')
 const { detectNodeVersion } = require('./node-version')
@@ -204,8 +205,7 @@ const getNetlifyToml = ({
 const saveNetlifyToml = async ({ baseDir, buildCmd, buildDir, config, configPath, functionsDir, repositoryRoot }) => {
   const tomlPathParts = [repositoryRoot, baseDir, 'netlify.toml'].filter(Boolean)
   const tomlPath = path.join(...tomlPathParts)
-  const exists = await fileExistsAsync(tomlPath)
-  if (exists) {
+  if (existsSync(tomlPath)) {
     return
   }
 
@@ -226,7 +226,11 @@ const saveNetlifyToml = async ({ baseDir, buildCmd, buildDir, config, configPath
   ])
   if (makeNetlifyTOML) {
     try {
-      await writeFileAsync(tomlPath, getNetlifyToml({ command: buildCmd, publish: buildDir, functions: functionsDir }))
+      await writeFile(
+        tomlPath,
+        getNetlifyToml({ command: buildCmd, publish: buildDir, functions: functionsDir }),
+        'utf-8',
+      )
     } catch (error) {
       warn(`Failed saving Netlify toml file: ${error.message}`)
     }

package/src/utils/live-tunnel.js

@@ -1,15 +1,14 @@
+// @ts-check
 const process = require('process')
 
-const chalk = require('chalk')
-const execa = require('execa')
 const fetch = require('node-fetch')
 const pWaitFor = require('p-wait-for')
 
 const { fetchLatestVersion, shouldFetchLatestVersion } = require('../lib/exec-fetcher')
 const { getPathInHome } = require('../lib/settings')
 
-const { log } = require('./command-helpers')
-const { NETLIFYDEVERR, NETLIFYDEVLOG } = require('./logo')
+const { NETLIFYDEVERR, NETLIFYDEVLOG, chalk, log } = require('./command-helpers')
+const execa = require('./execa')
 
 const PACKAGE_NAME = 'live-tunnel-client'
 const EXEC_NAME = PACKAGE_NAME

package/src/utils/lm/install.js

@@ -1,24 +1,19 @@
+// @ts-check
+const { appendFile, copyFile, readFile, writeFile } = require('fs').promises
 const os = require('os')
 const path = require('path')
 const process = require('process')
 
-const chalk = require('chalk')
 const execa = require('execa')
 const hasbin = require('hasbin')
 const Listr = require('listr')
 const pathKey = require('path-key')
 
 const { fetchLatestVersion, shouldFetchLatestVersion } = require('../../lib/exec-fetcher')
-const {
-  appendFileAsync,
-  copyFileAsync,
-  fileExistsAsync,
-  readFileAsync,
-  rmdirRecursiveAsync,
-  writeFileAsync,
-} = require('../../lib/fs')
+const { fileExistsAsync, rmdirRecursiveAsync } = require('../../lib/fs')
 const { normalizeBackslash } = require('../../lib/path')
 const { getLegacyPathInHome, getPathInHome } = require('../../lib/settings')
+const { chalk } = require('../command-helpers')
 
 const PACKAGE_NAME = 'netlify-credential-helper'
 const EXEC_NAME = 'git-credential-netlify'
@@ -154,7 +149,7 @@ Set the helper path in your environment PATH: ${getBinPath()}`
   }
 
   return await Promise.all([
-    await copyFileAsync(`${__dirname}/scripts/${shell}.sh`, incFilePath),
+    await copyFile(`${__dirname}/scripts/${shell}.sh`, incFilePath),
     await writeConfig(configFile, getInitContent(incFilePath)),
   ])
 }
@@ -165,12 +160,12 @@ const writeConfig = async function (name, initContent) {
     return
   }
 
-  const content = await readFileAsync(configPath, 'utf8')
+  const content = await readFile(configPath, 'utf8')
   if (content.includes(initContent)) {
     return
   }
 
-  return await appendFileAsync(configPath, initContent)
+  return await appendFile(configPath, initContent, 'utf-8')
 }
 
 const getCurrentCredentials = async () => {
@@ -225,7 +220,7 @@ const configureGitConfig = async function () {
   }
 
   const gitConfigPath = getGitConfigPath()
-  await writeFileAsync(gitConfigPath, helperConfig)
+  await writeFile(gitConfigPath, helperConfig, 'utf-8')
 
   return writeConfig(GIT_CONFIG, getGitConfigContent(gitConfigPath))
 }
@@ -292,8 +287,8 @@ const removeConfig = async function (name, toRemove) {
     return
   }
 
-  const content = await readFileAsync(configPath, 'utf8')
-  return await writeFileAsync(configPath, content.replace(toRemove, ''))
+  const content = await readFile(configPath, 'utf8')
+  return await writeFile(configPath, content.replace(toRemove, ''))
 }
 
 module.exports = { installPlatform, isBinInPath, getShellInfo, uninstall }

package/src/utils/lm/requirements.js

@@ -1,6 +1,8 @@
-const execa = require('execa')
+// @ts-check
 const semver = require('semver')
 
+const execa = require('../execa')
+
 const checkLFSFilters = async function () {
   try {
     const { stdout } = await execa('git', ['config', '--get-regexp', 'filter.lfs'])

package/src/utils/lm/steps.js

@@ -1,4 +1,4 @@
-const chalk = require('chalk')
+const { chalk } = require('../command-helpers')
 
 const { checkGitVersion, checkHelperVersion, checkLFSFilters, checkLFSVersion } = require('./requirements')
 

package/src/utils/lm/ui.js

@@ -1,11 +1,15 @@
 const os = require('os')
 
 const boxen = require('boxen')
-const chalk = require('chalk')
+
+const { chalk, log } = require('../command-helpers')
 
 const { getShellInfo, isBinInPath } = require('./install')
 
-const printBanner = function (command, force) {
+/**
+ * @param {boolean} force
+ */
+const printBanner = function (force) {
   const print = force || !isBinInPath()
   const platform = os.platform()
 
@@ -15,7 +19,7 @@ const printBanner = function (command, force) {
       `Run this command to use Netlify Large Media in your current shell\n\nsource ${incFilePath}`,
     )
 
-    command.log(boxen(banner, { padding: 1, margin: 1, align: 'center', borderColor: '#00c7b7' }))
+    log(boxen(banner, { padding: 1, margin: 1, align: 'center', borderColor: '#00c7b7' }))
   }
 }
 

package/src/utils/open-browser.js

@@ -1,10 +1,9 @@
 const process = require('process')
 
 const open = require('better-opn')
-const chalk = require('chalk')
 const isDockerContainer = require('is-docker')
 
-const { log } = require('./command-helpers')
+const { chalk, log } = require('./command-helpers')
 
 const unableToOpenBrowserMessage = function ({ message, url }) {
   log('---------------------------')
@@ -14,6 +13,13 @@ const unableToOpenBrowserMessage = function ({ message, url }) {
   log('---------------------------')
 }
 
+/**
+ * Opens a browser and logs a message if it is not possible
+ * @param {object} config
+ * @param {string} config.url The url to open
+ * @param {boolean} [config.silentBrowserNoneError]
+ * @returns {Promise<void>}
+ */
 const openBrowser = async function ({ silentBrowserNoneError, url }) {
   if (isDockerContainer()) {
     unableToOpenBrowserMessage({ url, message: 'Running inside a docker container' })

package/src/utils/parse-raw-flags.js

@@ -12,15 +12,15 @@
 
 const parseRawFlags = function (raw) {
   const rawFlags = raw.reduce((acc, curr, index, array) => {
-    if (/^-{1,2}/.test(curr.input)) {
-      const key = curr.input.replace(/^-{1,2}/, '')
+    if (/^-{1,2}/.test(curr)) {
+      const key = curr.replace(/^-{1,2}/, '')
       const next = array[index + 1]
       if (!next) {
         acc[key] = true
-      } else if (next && next.input && /^-{1,2}/.test(next.input)) {
+      } else if (next && next && /^-{1,2}/.test(next)) {
         acc[key] = true
       } else {
-        acc[key] = next ? aggressiveJSONParse(next.input) : true
+        acc[key] = next ? aggressiveJSONParse(next) : true
       }
     }
     return acc

package/src/utils/proxy.js

@@ -1,4 +1,6 @@
+// @ts-check
 const { Buffer } = require('buffer')
+const { readFile } = require('fs').promises
 const http = require('http')
 const https = require('https')
 const path = require('path')
@@ -16,13 +18,12 @@ const pEvent = require('p-event')
 const pFilter = require('p-filter')
 const toReadableStream = require('to-readable-stream')
 
-const { fileExistsAsync, isFileAsync, readFileAsync } = require('../lib/fs')
+const { fileExistsAsync, isFileAsync } = require('../lib/fs')
 
+const { NETLIFYDEVLOG, NETLIFYDEVWARN } = require('./command-helpers')
 const { createStreamPromise } = require('./create-stream-promise')
 const { headersForPath, parseHeaders } = require('./headers')
-const { NETLIFYDEVLOG, NETLIFYDEVWARN } = require('./logo')
-const { createRewriter } = require('./rules-proxy')
-const { onChanges } = require('./rules-proxy')
+const { createRewriter, onChanges } = require('./rules-proxy')
 
 const isInternal = function (url) {
   return url.startsWith('/.netlify/')
@@ -84,7 +85,7 @@ const render404 = async function (publicFolder) {
   const maybe404Page = path.resolve(publicFolder, '404.html')
   try {
     const isFile = await isFileAsync(maybe404Page)
-    if (isFile) return await readFileAsync(maybe404Page)
+    if (isFile) return await readFile(maybe404Page, 'utf-8')
   } catch (error) {
     console.warn(NETLIFYDEVWARN, 'Error while serving 404.html file', error.message)
   }

package/src/utils/read-repo-url.js

@@ -1,3 +1,4 @@
+// @ts-check
 const url = require('url')
 
 const fetch = require('node-fetch')

package/src/utils/redirects.js

@@ -1,7 +1,7 @@
+// @ts-check
 const { parseAllRedirects } = require('netlify-redirect-parser')
 
-const { log } = require('./command-helpers')
-const { NETLIFYDEVERR } = require('./logo')
+const { NETLIFYDEVERR, log } = require('./command-helpers')
 
 // Parse, normalize and validate all redirects from `_redirects` files
 // and `netlify.toml`

package/src/utils/rules-proxy.js

@@ -1,3 +1,4 @@
+// @ts-check
 const path = require('path')
 const url = require('url')
 
@@ -8,7 +9,7 @@ const pFilter = require('p-filter')
 
 const { fileExistsAsync } = require('../lib/fs')
 
-const { NETLIFYDEVLOG } = require('./logo')
+const { NETLIFYDEVLOG } = require('./command-helpers')
 const { parseRedirects } = require('./redirects')
 
 const onChanges = function (files, listener) {

package/src/utils/state-config.js

@@ -109,4 +109,4 @@ class StateConfig {
   }
 }
 
-module.exports = StateConfig
+module.exports = { StateConfig }

package/src/utils/telemetry/index.js

@@ -1,116 +1,5 @@
-const path = require('path')
-const process = require('process')
-
-const { isCI } = require('ci-info')
-const execa = require('execa')
-
-const getGlobalConfig = require('../get-global-config')
-
-const isValidEventName = require('./validation')
-
-const isTelemetryDisabled = function (config) {
-  return config.get('telemetryDisabled')
-}
-
-const send = function (type, payload) {
-  const requestFile = path.join(__dirname, 'request.js')
-  const options = JSON.stringify({
-    data: payload,
-    type,
-  })
-
-  const args = [process.execPath, [requestFile, options]]
-  if (process.env.NETLIFY_TEST_TELEMETRY_WAIT === 'true') {
-    return execa(...args, {
-      stdio: 'inherit',
-    })
-  }
-
-  // spawn detached child process to handle send
-  execa(...args, {
-    detached: true,
-    stdio: 'ignore',
-  }).unref()
-}
-
-const eventConfig = {
-  // Namespace of current application
-  projectName: 'cli',
-  // Allowed objects
-  objects: [
-    // example cli:sites_created
-    'sites',
-    // example cli:user_signup
-    'user',
-  ],
-}
-
-const track = async function (eventName, payload = {}) {
-  if (isCI) {
-    return
-  }
-
-  const globalConfig = await getGlobalConfig()
-  if (isTelemetryDisabled(globalConfig)) {
-    return
-  }
-
-  const [userId, cliId] = [globalConfig.get('userId'), globalConfig.get('cliId')]
-
-  // automatically add `cli:` prefix if missing
-  if (!eventName.includes('cli:')) {
-    eventName = `cli:${eventName}`
-  }
-
-  // event 'cli:command' bypasses validation
-  const isValid = eventName === 'cli:command' ? () => true : isValidEventName
-  // to ensure clean data, validate event name
-  if (!isValid(eventName, eventConfig)) {
-    return false
-  }
-
-  const { duration, status, ...properties } = payload
-  const defaultData = {
-    event: eventName,
-    userId,
-    anonymousId: cliId,
-    duration,
-    status,
-    properties,
-  }
-
-  return send('track', defaultData)
-}
-
-const identify = async function (payload) {
-  if (isCI) {
-    return
-  }
-
-  const globalConfig = await getGlobalConfig()
-  if (isTelemetryDisabled(globalConfig, payload)) {
-    return
-  }
-
-  const cliId = globalConfig.get('cliId')
-  const { email, name, userId } = payload
-
-  const defaultTraits = {
-    name,
-    email,
-    cliId,
-  }
-
-  const identifyData = {
-    anonymousId: cliId,
-    userId,
-    traits: { ...defaultTraits, ...payload },
-  }
-
-  return send('identify', identifyData)
-}
+const telemetry = require('./telemetry')
 
 module.exports = {
-  track,
-  identify,
+  ...telemetry,
 }

package/src/utils/telemetry/request.js

@@ -1,4 +1,6 @@
-// Spawn a detached process
+// @ts-check
+// This file is being called by `src/utils/telemetry/telemetry.js` as a child process
+// to run a s a detached process
 const process = require('process')
 
 const fetch = require('node-fetch')