netlify-cli 8.0.10 → 8.1.0-rc

package/src/commands/{init.js → init/init.js}

@@ -1,18 +1,12 @@
-const { flags: flagsLib } = require('@oclif/command')
-const chalk = require('chalk')
+// @ts-check
 const dotProp = require('dot-prop')
 const inquirer = require('inquirer')
 const isEmpty = require('lodash/isEmpty')
 
-const Command = require('../utils/command')
-const { exit, log } = require('../utils/command-helpers')
-const { getRepoData } = require('../utils/get-repo-data')
-const ensureNetlifyIgnore = require('../utils/gitignore')
-const { configureRepo } = require('../utils/init/config')
-const { track } = require('../utils/telemetry')
-
-const LinkCommand = require('./link')
-const SitesCreateCommand = require('./sites/create')
+const { chalk, ensureNetlifyIgnore, exit, getRepoData, log, track } = require('../../utils')
+const { configureRepo } = require('../../utils/init/config')
+const { link } = require('../link')
+const { sitesCreate } = require('../sites')
 
 const persistState = ({ siteInfo, state }) => {
   // Save to .netlify/state.json file
@@ -37,8 +31,14 @@ const logExistingAndExit = ({ siteInfo }) => {
   exit()
 }
 
-const createNewSiteAndExit = async ({ state }) => {
-  const siteInfo = await SitesCreateCommand.run([])
+/**
+ * Creates and new site and exits the process
+ * @param {object} config
+ * @param {*} config.state
+ * @param {import('../base-command').BaseCommand} config.command
+ */
+const createNewSiteAndExit = async ({ command, state }) => {
+  const siteInfo = await sitesCreate({}, command)
 
   log(`"${siteInfo.name}" site was created`)
   log()
@@ -82,7 +82,14 @@ const logGitSetupInstructionsAndExit = () => {
   exit()
 }
 
-const handleNoGitRemoteAndExit = async ({ error, state }) => {
+/**
+ * Handles the case where no git remote was found.
+ * @param {object} config
+ * @param {import('../base-command').BaseCommand} config.command
+ * @param {object} config.error
+ * @param {object} config.state
+ */
+const handleNoGitRemoteAndExit = async ({ command, error, state }) => {
   log()
   log(`${chalk.yellow('No git remote was found, would you like to set one up?')}`)
   log(`
@@ -112,13 +119,17 @@ git remote add origin https://github.com/YourUserName/RepoName.git
   ])
 
   if (noGitRemoteChoice === NEW_SITE_NO_GIT) {
-    await createNewSiteAndExit({ state })
+    await createNewSiteAndExit({ state, command })
   } else if (noGitRemoteChoice === NO_ABORT) {
     logGitSetupInstructionsAndExit()
   }
 }
 
-const createOrLinkSiteToRepo = async () => {
+/**
+ * Creates a new site or links an existing one to the repository
+ * @param {import('../base-command').BaseCommand} command
+ */
+const createOrLinkSiteToRepo = async (command) => {
   const NEW_SITE = '+  Create & configure a new site'
   const EXISTING_SITE = '⇄  Connect this directory to an existing Netlify site'
 
@@ -139,11 +150,11 @@ const createOrLinkSiteToRepo = async () => {
       type: 'new site',
     })
     // run site:create command
-    return await SitesCreateCommand.run([])
+    return await sitesCreate({}, command)
   }
   if (initChoice === EXISTING_SITE) {
     // run link command
-    return await LinkCommand.run([], false)
+    return await link({}, command)
   }
 }
 
@@ -155,65 +166,65 @@ const logExistingRepoSetupAndExit = ({ repoUrl, siteName }) => {
   exit()
 }
 
-class InitCommand extends Command {
-  async run() {
-    const { flags } = this.parse(InitCommand)
-
-    this.setAnalyticsPayload({ manual: flags.manual, force: flags.force })
-
-    const { netlify } = this
-    const { repositoryRoot, state } = netlify
-    let { siteInfo } = this.netlify
+/**
+ * The init command
+ * @param {import('commander').OptionValues} options
+ * @param {import('../base-command').BaseCommand} command
+ */
+const init = async (options, command) => {
+  command.setAnalyticsPayload({ manual: options.manual, force: options.force })
 
-    // Check logged in status
-    await this.authenticate()
+  const { repositoryRoot, state } = command.netlify
+  let { siteInfo } = command.netlify
 
-    // Add .netlify to .gitignore file
-    await ensureNetlifyIgnore(repositoryRoot)
+  // Check logged in status
+  await command.authenticate()
 
-    const repoUrl = getRepoUrl({ siteInfo })
-    if (repoUrl && !flags.force) {
-      logExistingAndExit({ siteInfo })
-    }
+  // Add .netlify to .gitignore file
+  await ensureNetlifyIgnore(repositoryRoot)
 
-    // Look for local repo
-    const repoData = await getRepoData({ remoteName: flags.gitRemoteName })
-    if (repoData.error) {
-      await handleNoGitRemoteAndExit({ error: repoData.error, state })
-    }
+  const repoUrl = getRepoUrl({ siteInfo })
+  if (repoUrl && !options.force) {
+    logExistingAndExit({ siteInfo })
+  }
 
-    if (isEmpty(siteInfo)) {
-      siteInfo = await createOrLinkSiteToRepo()
-    }
+  // Look for local repo
+  const repoData = await getRepoData({ remoteName: options.gitRemoteName })
+  if (repoData.error) {
+    await handleNoGitRemoteAndExit({ command, error: repoData.error, state })
+  }
 
-    // Check for existing CI setup
-    const remoteBuildRepo = getRepoUrl({ siteInfo })
-    if (remoteBuildRepo && !flags.force) {
-      logExistingRepoSetupAndExit({ siteName: siteInfo.name, repoUrl: remoteBuildRepo })
-    }
+  if (isEmpty(siteInfo)) {
+    siteInfo = await createOrLinkSiteToRepo(command)
+  }
 
-    persistState({ state, siteInfo })
+  // Check for existing CI setup
+  const remoteBuildRepo = getRepoUrl({ siteInfo })
+  if (remoteBuildRepo && !options.force) {
+    logExistingRepoSetupAndExit({ siteName: siteInfo.name, repoUrl: remoteBuildRepo })
+  }
 
-    await configureRepo({ context: this, siteId: siteInfo.id, repoData, manual: flags.manual })
+  persistState({ state, siteInfo })
 
-    return siteInfo
-  }
-}
+  await configureRepo({ command, siteId: siteInfo.id, repoData, manual: options.manual })
 
-InitCommand.description = `Configure continuous deployment for a new or existing site. To create a new site without continuous deployment, use \`netlify sites:create\``
-
-InitCommand.flags = {
-  manual: flagsLib.boolean({
-    char: 'm',
-    description: 'Manually configure a git remote for CI',
-  }),
-  force: flagsLib.boolean({
-    description: 'Reinitialize CI hooks if the linked site is already configured to use CI',
-  }),
-  gitRemoteName: flagsLib.string({
-    description: 'Name of Git remote to use. e.g. "origin"',
-  }),
-  ...InitCommand.flags,
+  return siteInfo
 }
 
-module.exports = InitCommand
+/**
+ * Creates the `netlify init` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createInitCommand = (program) =>
+  program
+    .command('init')
+    .description(
+      'Configure continuous deployment for a new or existing site. To create a new site without continuous deployment, use `netlify sites:create`',
+    )
+    .option('-m, --manual', 'Manually configure a git remote for CI')
+    .option('--force', 'Manually configure a git remote for CI')
+    .option('--gitRemoteName <name>', 'Name of Git remote to use. e.g. "origin"')
+    .action(init)
+
+module.exports = { createInitCommand, init }

package/src/commands/link/index.js

@@ -0,0 +1,6 @@
+const { createLinkCommand, link } = require('./link')
+
+module.exports = {
+  createLinkCommand,
+  link,
+}

package/src/{utils/link/link-by-prompt.js → commands/link/link.js}

@@ -1,16 +1,30 @@
+// @ts-check
+const { join, relative } = require('path')
 const path = require('path')
+const { cwd } = require('process')
 
-const chalk = require('chalk')
 const inquirer = require('inquirer')
 const isEmpty = require('lodash/isEmpty')
 
 const { listSites } = require('../../lib/api')
-const { error, exit, log } = require('../command-helpers')
-const { getRepoData } = require('../get-repo-data')
-const { track } = require('../telemetry')
+const {
+  chalk,
+  ensureNetlifyIgnore,
+  error,
+  exit,
+  generateExamplesHelp,
+  getRepoData,
+  log,
+  track,
+} = require('../../utils')
 
-module.exports = async function linkPrompts(context, flags = {}) {
-  const { api, state } = context.netlify
+/**
+ *
+ * @param {import('../base-command').NetlifyOptions} netlify
+ * @param {import('commander').OptionValues} options
+ */
+const linkPrompt = async (netlify, options) => {
+  const { api, state } = netlify
 
   const SITE_NAME_PROMPT = 'Search by full or partial site name'
   const SITE_LIST_PROMPT = 'Choose from a list of your recently updated sites'
@@ -19,7 +33,7 @@ module.exports = async function linkPrompts(context, flags = {}) {
   let GIT_REMOTE_PROMPT = 'Use the current git remote origin URL'
   let site
   // Get git remote data if exists
-  const repoData = await getRepoData({ remoteName: flags.gitRemoteName })
+  const repoData = await getRepoData({ remoteName: options.gitRemoteName })
 
   let linkChoices = [SITE_NAME_PROMPT, SITE_LIST_PROMPT, SITE_ID_PROMPT]
 
@@ -51,9 +65,7 @@ module.exports = async function linkPrompts(context, flags = {}) {
       const sites = await listSites({ api, options: { filter: 'all' } })
 
       if (isEmpty(sites)) {
-        context.error(
-          new Error(`You don't have any sites yet. Run ${chalk.cyanBright('netlify sites:create')} to create a site.`),
-        )
+        error(`You don't have any sites yet. Run ${chalk.cyanBright('netlify sites:create')} to create a site.`)
       }
 
       const matchingSites = sites.filter(
@@ -79,7 +91,7 @@ Run ${chalk.cyanBright('git remote -v')} to see a list of your git remotes.`)
         site = firstSite
       } else if (matchingSites.length > 1) {
         // Matches multiple sites. Users must choose which to link.
-        console.log(`Found ${matchingSites.length} matching sites!`)
+        log(`Found ${matchingSites.length} matching sites!`)
 
         // Prompt which options
         const { selectedSite } = await inquirer.prompt([
@@ -134,7 +146,7 @@ or run ${chalk.cyanBright('netlify sites:create')} to create a site.`)
       }
 
       if (matchingSites.length > 1) {
-        console.log(`Found ${matchingSites.length} matching sites!`)
+        log(`Found ${matchingSites.length} matching sites!`)
         const { selectedSite } = await inquirer.prompt([
           {
             type: 'list',
@@ -145,7 +157,7 @@ or run ${chalk.cyanBright('netlify sites:create')} to create a site.`)
           },
         ])
         if (!selectedSite) {
-          context.error('No site selected')
+          error('No site selected')
         }
         site = selectedSite
       } else {
@@ -196,6 +208,7 @@ or run ${chalk.cyanBright('netlify sites:create')} to create a site.`)
       ])
 
       try {
+        // @ts-ignore types from API are wrong they cannot recognize `getSite` of API
         site = await api.getSite({ siteId })
       } catch (error_) {
         if (error_.status === 404) {
@@ -231,10 +244,136 @@ or run ${chalk.cyanBright('netlify sites:create')} to create a site.`)
   log(`Site url:  ${chalk.cyanBright(site.ssl_url || site.url)}`)
   log()
 
-  log(`Site id saved to ${path.join(context.netlify.site.root, '/.netlify/state.json')}`)
+  log(`Site id saved to ${path.join(netlify.site.root, '/.netlify/state.json')}`)
   // log(`Local Config: .netlify/config.json`)
   log()
   log(`You can now run other \`netlify\` cli commands in this directory`)
 
   return site
 }
+
+/**
+ * The link command
+ * @param {import('commander').OptionValues} options
+ * @param {import('../base-command').BaseCommand} command
+ */
+const link = async (options, command) => {
+  await command.authenticate()
+
+  const {
+    api,
+    repositoryRoot,
+    site: { id: siteId },
+    state,
+  } = command.netlify
+
+  let siteData
+  try {
+    // @ts-ignore types from API are wrong they cannot recognize `getSite` of API
+    siteData = await api.getSite({ siteId })
+  } catch {
+    // silent api error
+  }
+
+  // Add .netlify to .gitignore file
+  await ensureNetlifyIgnore(repositoryRoot)
+
+  // Site id is incorrect
+  if (siteId && !siteData) {
+    log(`"${siteId}" was not found in your Netlify account.`)
+    log(`Please double check your siteID and which account you are logged into via \`netlify status\`.`)
+    return exit()
+  }
+
+  // If already linked to site. exit and prompt for unlink
+  if (siteData) {
+    log(`Site already linked to "${siteData.name}"`)
+    log(`Admin url: ${siteData.admin_url}`)
+    log()
+    log(`To unlink this site, run: ${chalk.cyanBright('netlify unlink')}`)
+    return exit()
+  }
+
+  if (options.id) {
+    try {
+      // @ts-ignore types from API are wrong they cannot recognize `getSite` of API
+      siteData = await api.getSite({ site_id: options.id })
+    } catch (error_) {
+      if (error_.status === 404) {
+        error(new Error(`Site id ${options.id} not found`))
+      } else {
+        error(error_)
+      }
+    }
+
+    // Save site ID
+    state.set('siteId', siteData.id)
+    log(`Linked to ${siteData.name} in ${state.path}`)
+
+    await track('sites_linked', {
+      siteId: siteData.id,
+      linkType: 'manual',
+      kind: 'byId',
+    })
+
+    return exit()
+  }
+
+  if (options.name) {
+    let results
+    try {
+      results = await listSites({
+        api,
+        options: {
+          name: options.name,
+          filter: 'all',
+        },
+      })
+    } catch (error_) {
+      if (error_.status === 404) {
+        error(new Error(`${options.name} not found`))
+      } else {
+        error(error_)
+      }
+    }
+
+    if (results.length === 0) {
+      error(new Error(`No sites found named ${options.name}`))
+    }
+    const [firstSiteData] = results
+    state.set('siteId', firstSiteData.id)
+
+    log(`Linked to ${firstSiteData.name} in ${relative(join(cwd(), '..'), state.path)}`)
+
+    await track('sites_linked', {
+      siteId: (firstSiteData && firstSiteData.id) || siteId,
+      linkType: 'manual',
+      kind: 'byName',
+    })
+
+    return exit()
+  }
+
+  siteData = await linkPrompt(command.netlify, options)
+  return siteData
+}
+
+/**
+ * Creates the `netlify link` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createLinkCommand = (program) =>
+  program
+    .command('link')
+    .description('Link a local repo or project folder to an existing site on Netlify')
+    .option('--id <id>', 'ID of site to link to')
+    .option('--name <name>', 'Name of site to link to')
+    .option('--gitRemoteName <name>', 'Name of Git remote to use. e.g. "origin"')
+    .addHelpText(
+      'after',
+      generateExamplesHelp(['netlify link', 'netlify link --id 123-123-123-123', 'netlify link --name my-site-name']),
+    )
+    .action(link)
+
+module.exports = { createLinkCommand, link }

package/src/commands/lm/index.js

@@ -1,21 +1,5 @@
-const { isEmptyCommand } = require('../../utils/check-command-inputs')
-const Command = require('../../utils/command')
-const showHelp = require('../../utils/show-help')
+const { createLmCommand } = require('./lm')
 
-class LmCommand extends Command {
-  run() {
-    const { args, flags } = this.parse(LmCommand)
-
-    // Show help on empty sub command
-    if (isEmptyCommand(flags, args)) {
-      showHelp(this.id)
-    }
-  }
+module.exports = {
+  createLmCommand,
 }
-
-LmCommand.description = `Handle Netlify Large Media operations
-The lm command will help you manage large media for a site
-`
-LmCommand.examples = ['netlify lm:info', 'netlify lm:install', 'netlify lm:setup']
-
-module.exports = LmCommand

package/src/commands/lm/lm-info.js

@@ -0,0 +1,42 @@
+// @ts-check
+const Listr = require('listr')
+
+const {
+  checkGitLFSVersionStep,
+  checkGitVersionStep,
+  checkHelperVersionStep,
+  checkLFSFiltersStep,
+} = require('../../utils/lm/steps')
+
+/**
+ * The lm:info command
+ */
+const lmInfo = async () => {
+  const steps = [
+    checkGitVersionStep,
+    checkGitLFSVersionStep,
+    checkLFSFiltersStep((ctx, task, installed) => {
+      if (!installed) {
+        throw new Error('Git LFS filters are not installed, run `git lfs install` to install them')
+      }
+    }),
+    checkHelperVersionStep,
+  ]
+
+  const tasks = new Listr(steps, { concurrent: true, exitOnError: false })
+  try {
+    await tasks.run()
+  } catch {
+    // an error is already reported when a task fails
+  }
+}
+
+/**
+ * Creates the `netlify lm:info` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createLmInfoCommand = (program) =>
+  program.command('lm:info').description('Show large media requirements information.').action(lmInfo)
+
+module.exports = { createLmInfoCommand }

package/src/commands/lm/lm-install.js

@@ -0,0 +1,36 @@
+// @ts-check
+
+const { generateDescriptionHelp } = require('../../utils')
+const { installPlatform } = require('../../utils/lm/install')
+const { printBanner } = require('../../utils/lm/ui')
+
+/**
+ * The lm:install command
+ * @param {import('commander').OptionValues} options
+ */
+const lmInstall = async ({ force }) => {
+  const installed = await installPlatform({ force })
+  if (installed) {
+    printBanner(force)
+  }
+}
+
+/**
+ * Creates the `netlify lm:install` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createLmInstallCommand = (program) =>
+  program
+    .command('lm:install')
+    .alias('lm:init')
+    .description('Configures your computer to use Netlify Large Media')
+    .option('-f, --force', 'Force the credentials helper installation')
+    .addHelpText(
+      'after',
+      generateDescriptionHelp(`It installs the required credentials helper for Git,
+and configures your Git environment with the right credentials.`),
+    )
+    .action(lmInstall)
+
+module.exports = { createLmInstallCommand }

package/src/commands/lm/lm-setup.js

@@ -0,0 +1,106 @@
+// @ts-check
+const Listr = require('listr')
+
+const { error, execa } = require('../../utils')
+const { installPlatform } = require('../../utils/lm/install')
+const { checkHelperVersion } = require('../../utils/lm/requirements')
+const { printBanner } = require('../../utils/lm/ui')
+
+const installHelperIfMissing = async function ({ force }) {
+  let installHelper = false
+  try {
+    const version = await checkHelperVersion()
+    if (!version) {
+      installHelper = true
+    }
+  } catch {
+    installHelper = true
+  }
+
+  if (installHelper) {
+    return installPlatform({ force })
+  }
+
+  return false
+}
+
+const provisionService = async function (siteId, api) {
+  const addonName = 'large-media'
+
+  if (!siteId) {
+    throw new Error('No site id found, please run inside a site folder or `netlify link`')
+  }
+  try {
+    await api.createServiceInstance({
+      siteId,
+      addon: addonName,
+      body: {},
+    })
+  } catch (error_) {
+    // error is JSONHTTPError
+    throw new Error(error_.json.error)
+  }
+}
+
+const configureLFSURL = async function (siteId, api) {
+  const siteInfo = await api.getSite({ siteId })
+  const url = `https://${siteInfo.id_domain}/.netlify/large-media`
+
+  return execa('git', ['config', '-f', '.lfsconfig', 'lfs.url', url])
+}
+
+/**
+ * The lm:setup command
+ * @param {import('commander').OptionValues} options
+ * @param {import('../base-command').BaseCommand} command
+ */
+const lmSetup = async (options, command) => {
+  await command.authenticate()
+
+  const { api, site } = command.netlify
+
+  let helperInstalled = false
+  if (!options.skipInstall) {
+    try {
+      helperInstalled = await installHelperIfMissing({ force: options.forceInstall })
+    } catch (error_) {
+      error(error_)
+    }
+  }
+
+  const tasks = new Listr([
+    {
+      title: 'Provisioning Netlify Large Media',
+      async task() {
+        await provisionService(site.id, api)
+      },
+    },
+    {
+      title: 'Configuring Git LFS for this site',
+      async task() {
+        await configureLFSURL(site.id, api)
+      },
+    },
+  ])
+  await tasks.run().catch(() => {})
+
+  if (helperInstalled) {
+    printBanner(options.forceInstall)
+  }
+}
+
+/**
+ * Creates the `netlify lm:setup` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createLmSetupCommand = (program) =>
+  program
+    .command('lm:setup')
+    .description('Configures your site to use Netlify Large Media')
+    .option('-s, --skip-install', 'Skip the credentials helper installation check')
+    .option('-f, --force-install', 'Force the credentials helper installation')
+    .addHelpText('after', 'It runs the install command if you have not installed the dependencies yet.')
+    .action(lmSetup)
+
+module.exports = { createLmSetupCommand }

package/src/commands/lm/lm-uninstall.js

@@ -0,0 +1,25 @@
+// @ts-check
+const { uninstall } = require('../../utils/lm/install')
+
+/**
+ * The lm:uninstall command
+ */
+const lmUninstall = async () => {
+  await uninstall()
+}
+
+/**
+ * Creates the `netlify lm:uninstall` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createLmUninstallCommand = (program) =>
+  program
+    .command('lm:uninstall', { hidden: true })
+    .alias('lm:remove')
+    .description(
+      'Uninstalls Netlify git credentials helper and cleans up any related configuration changes made by the install command.',
+    )
+    .action(lmUninstall)
+
+module.exports = { createLmUninstallCommand }