netlify-cli 8.0.7 → 8.1.0-rc

package/src/commands/sites/sites-delete.js

@@ -0,0 +1,108 @@
+// @ts-check
+const inquirer = require('inquirer')
+
+const { chalk, error, exit, generateDescriptionHelp, generateExamplesHelp, log } = require('../../utils')
+
+/**
+ * The sites:delete command
+ * @param {string} siteId
+ * @param {import('commander').OptionValues} options
+ * @param {import('../base-command').BaseCommand} command
+ */
+const sitesDelete = async (siteId, options, command) => {
+  command.setAnalyticsPayload({ force: options.force })
+
+  const { api, site } = command.netlify
+  const cwdSiteId = site.id
+
+  // 1. Prompt user for verification
+  await command.authenticate(options.auth)
+
+  let siteData
+  try {
+    siteData = await api.getSite({ siteId })
+  } catch (error_) {
+    if (error_.status === 404) {
+      error(`No site with id ${siteId} found. Please verify the siteId & try again.`)
+    }
+  }
+
+  if (!siteData) {
+    error(`Unable to process site`)
+  }
+
+  const noForce = options.force !== true
+
+  /* Verify the user wants to delete the site */
+  if (noForce) {
+    log(`${chalk.redBright('Warning')}: You are about to permanently delete "${chalk.bold(siteData.name)}"`)
+    log(`         Verify this siteID "${siteId}" supplied is correct and proceed.`)
+    log('         To skip this prompt, pass a --force flag to the delete command')
+    log()
+    log(`${chalk.bold('Be careful here. There is no undo!')}`)
+    log()
+    const { wantsToDelete } = await inquirer.prompt({
+      type: 'confirm',
+      name: 'wantsToDelete',
+      message: `WARNING: Are you sure you want to delete the "${siteData.name}" site?`,
+      default: false,
+    })
+    log()
+    if (!wantsToDelete) {
+      exit()
+    }
+  }
+
+  /* Validation logic if siteId passed in does not match current site ID */
+  if (noForce && cwdSiteId && cwdSiteId !== siteId) {
+    log(`${chalk.redBright('Warning')}: The siteId supplied does not match the current working directory siteId`)
+    log()
+    log(`Supplied:       "${siteId}"`)
+    log(`Current Site:   "${cwdSiteId}"`)
+    log()
+    log(`Verify this siteID "${siteId}" supplied is correct and proceed.`)
+    log('To skip this prompt, pass a --force flag to the delete command')
+    const { wantsToDelete } = await inquirer.prompt({
+      type: 'confirm',
+      name: 'wantsToDelete',
+      message: `Verify & Proceed with deletion of site "${siteId}"?`,
+      default: false,
+    })
+    if (!wantsToDelete) {
+      exit()
+    }
+  }
+
+  log(`Deleting site "${siteId}"...`)
+
+  try {
+    await api.deleteSite({ site_id: siteId })
+  } catch (error_) {
+    if (error_.status === 404) {
+      error(`No site with id ${siteId} found. Please verify the siteId & try again.`)
+    } else {
+      error(`Delete Site error: ${error_.status}: ${error_.message}`)
+    }
+  }
+  log(`Site "${siteId}" successfully deleted!`)
+}
+
+/**
+ * Creates the `netlify sites:delete` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createSitesDeleteCommand = (program) =>
+  program
+    .command('sites:delete')
+    .description('Delete a site')
+    .argument('<siteId>', 'Site ID to delete.')
+    .option('-f, --force', 'delete without prompting (useful for CI)')
+    .addHelpText(
+      'after',
+      generateDescriptionHelp('This command will permanently delete the site on Netlify. Use with caution.'),
+    )
+    .addHelpText('after', generateExamplesHelp(['netlify sites:delete 1234-3262-1211']))
+    .action(sitesDelete)
+
+module.exports = { createSitesDeleteCommand }

package/src/commands/sites/sites-list.js

@@ -0,0 +1,89 @@
+// @ts-check
+
+const { cli } = require('cli-ux')
+
+const { listSites } = require('../../lib/api')
+const { chalk, log, logJson } = require('../../utils')
+
+/**
+ * The sites:list command
+ * @param {import('commander').OptionValues} options
+ * @param {import('../base-command').BaseCommand} command
+ * @returns {Promise<{ id: any; name: any; ssl_url: any; account_name: any; }|boolean>}
+ */
+const sitesList = async (options, command) => {
+  const { api } = command.netlify
+  if (!options.json) {
+    cli.action.start('Loading your sites')
+  }
+  await command.authenticate()
+
+  const sites = await listSites({ api, options: { filter: 'all' } })
+  if (!options.json) {
+    cli.action.stop()
+  }
+
+  if (sites && sites.length !== 0) {
+    const logSites = sites.map((site) => {
+      const siteInfo = {
+        id: site.id,
+        name: site.name,
+        ssl_url: site.ssl_url,
+        account_name: site.account_name,
+      }
+
+      if (site.build_settings && site.build_settings.repo_url) {
+        siteInfo.repo_url = site.build_settings.repo_url
+      }
+
+      return siteInfo
+    })
+
+    // Json response for piping commands
+    if (options.json) {
+      const redactedSites = sites.map((site) => {
+        if (site && site.build_settings) {
+          delete site.build_settings.env
+        }
+        return site
+      })
+      logJson(redactedSites)
+      return false
+    }
+
+    log(`
+────────────────────────────┐
+ Current Netlify Sites    │
+────────────────────────────┘
+
+Count: ${logSites.length}
+`)
+
+    logSites.forEach((logSite) => {
+      log(`${chalk.greenBright(logSite.name)} - ${logSite.id}`)
+      log(`  ${chalk.whiteBright.bold('url:')}  ${chalk.yellowBright(logSite.ssl_url)}`)
+      if (logSite.repo_url) {
+        log(`  ${chalk.whiteBright.bold('repo:')} ${chalk.white(logSite.repo_url)}`)
+      }
+      if (logSite.account_name) {
+        log(`  ${chalk.whiteBright.bold('account:')} ${chalk.white(logSite.account_name)}`)
+      }
+      log(`─────────────────────────────────────────────────`)
+    })
+  }
+}
+
+/**
+ * Creates the `netlify sites:list` command
+ * @param {import('../base-command').BaseCommand} program
+ */
+const createSitesListCommand = (program) =>
+  program
+    .command('sites:list')
+    .description('List all sites you have access to')
+    .option('--json', 'Output site data as JSON')
+    .action(async (options, command) => {
+      await sitesList(options, command)
+    })
+
+module.exports = { createSitesListCommand }

package/src/commands/sites/sites.js

@@ -0,0 +1,36 @@
+// @ts-check
+const { generateCommandsHelp, generateDescriptionHelp, generateExamplesHelp } = require('../../utils')
+
+const { createSitesCreateCommand } = require('./sites-create')
+const { createSitesDeleteCommand } = require('./sites-delete')
+const { createSitesListCommand } = require('./sites-list')
+
+/**
+ * The sites command
+ * @param {import('commander').OptionValues} options
+ * @param {import('../base-command').BaseCommand} command
+ */
+const sites = (options, command) => {
+  command.help()
+}
+
+/**
+ * Creates the `netlify sites` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createSitesCommand = (program) => {
+  createSitesCreateCommand(program)
+  createSitesListCommand(program)
+  createSitesDeleteCommand(program)
+
+  return program
+    .command('sites')
+    .description('Handle various site operations')
+    .addHelpText('after', generateDescriptionHelp('The sites command will help you manage all your sites'))
+    .addHelpText('after', generateExamplesHelp(['netlify sites:create --name my-new-site', 'netlify sites:list']))
+    .addHelpText('after', generateCommandsHelp('sites', program))
+    .action(sites)
+}
+
+module.exports = { createSitesCommand }

package/src/commands/status/index.js

@@ -1,120 +1,5 @@
-const { flags: flagsLib } = require('@oclif/command')
-const chalk = require('chalk')
-const clean = require('clean-deep')
-const prettyjson = require('prettyjson')
+const { createStatusCommand } = require('./status')
 
-const Command = require('../../utils/command')
-const { error, exit, getToken, log, logJson, warn } = require('../../utils/command-helpers')
-
-class StatusCommand extends Command {
-  async run() {
-    const { api, globalConfig, site } = this.netlify
-    const { flags } = this.parse(StatusCommand)
-
-    const current = globalConfig.get('userId')
-    const [accessToken] = await getToken()
-
-    if (!accessToken) {
-      log(`Not logged in. Please log in to see site status.`)
-      log()
-      log('Login with "netlify login" command')
-      exit()
-    }
-
-    const siteId = site.id
-
-    log(`──────────────────────┐
- Current Netlify User │
-──────────────────────┘`)
-
-    let accounts
-    let user
-
-    try {
-      ;[accounts, user] = await Promise.all([api.listAccountsForUser(), api.getCurrentUser()])
-    } catch (error_) {
-      if (error_.status === 401) {
-        error(
-          'Your session has expired. Please try to re-authenticate by running `netlify logout` and `netlify login`.',
-        )
-      }
-    }
-
-    const ghuser = this.netlify.globalConfig.get(`users.${current}.auth.github.user`)
-    const accountData = {
-      Name: user.full_name,
-      Email: user.email,
-      GitHub: ghuser,
-    }
-    const teamsData = {}
-
-    accounts.forEach((team) => {
-      teamsData[team.name] = team.roles_allowed.join(' ')
-    })
-
-    accountData.Teams = teamsData
-
-    const cleanAccountData = clean(accountData)
-
-    log(prettyjson.render(cleanAccountData))
-
-    if (!siteId) {
-      warn('Did you run `netlify link` yet?')
-      error(`You don't appear to be in a folder that is linked to a site`)
-    }
-    let siteData
-    try {
-      siteData = await api.getSite({ siteId })
-    } catch (error_) {
-      // unauthorized
-      if (error_.status === 401) {
-        warn(`Log in with a different account or re-link to a site you have permission for`)
-        error(`Not authorized to view the currently linked site (${siteId})`)
-      }
-      // missing
-      if (error_.status === 404) {
-        error(`The site this folder is linked to can't be found`)
-      }
-      error(error_)
-    }
-
-    // Json only logs out if --json flag is passed
-    if (flags.json) {
-      logJson({
-        account: cleanAccountData,
-        siteData: {
-          'site-name': `${siteData.name}`,
-          'config-path': site.configPath,
-          'admin-url': siteData.admin_url,
-          'site-url': siteData.ssl_url || siteData.url,
-          'site-id': siteData.id,
-        },
-      })
-    }
-
-    log(`────────────────────┐
- Netlify Site Info  │
-────────────────────┘`)
-    log(
-      prettyjson.render({
-        'Current site': `${siteData.name}`,
-        'Netlify TOML': site.configPath,
-        'Admin URL': chalk.magentaBright(siteData.admin_url),
-        'Site URL': chalk.cyanBright(siteData.ssl_url || siteData.url),
-        'Site Id': chalk.yellowBright(siteData.id),
-      }),
-    )
-    log()
-  }
+module.exports = {
+  createStatusCommand,
 }
-
-StatusCommand.description = `Print status information`
-
-StatusCommand.flags = {
-  verbose: flagsLib.boolean({
-    description: 'Output system info',
-  }),
-  ...StatusCommand.flags,
-}
-
-module.exports = StatusCommand

package/src/commands/status/status-hooks.js

@@ -0,0 +1,73 @@
+// @ts-check
+const { get } = require('dot-prop')
+const prettyjson = require('prettyjson')
+
+const { error, log, warn } = require('../../utils')
+
+/**
+ * The status:hooks command
+ * @param {import('commander').OptionValues} options
+ * @param {import('../base-command').BaseCommand} command
+ */
+const statusHooks = async (options, command) => {
+  const { api, site } = command.netlify
+
+  await command.authenticate()
+
+  const siteId = site.id
+  if (!siteId) {
+    warn('Did you run `netlify link` yet?')
+    error(`You don't appear to be in a folder that is linked to a site`)
+  }
+
+  let siteData
+  try {
+    siteData = await api.getSite({ siteId })
+  } catch (error_) {
+    // unauthorized
+    if (error_.status === 401) {
+      warn(`Log in with a different account or re-link to a site you have permission for`)
+      error(`Not authorized to view the currently linked site (${siteId})`)
+    }
+    // missing
+    if (error_.status === 404) {
+      error(`The site this folder is linked to can't be found`)
+    }
+    error(error_)
+  }
+
+  const ntlHooks = await api.listHooksBySiteId({ siteId: siteData.id })
+  const data = {
+    site: siteData.name,
+    hooks: {},
+  }
+  ntlHooks.forEach((hook) => {
+    data.hooks[hook.id] = {
+      type: hook.type,
+      event: hook.event,
+      id: hook.id,
+      disabled: hook.disabled,
+    }
+    if (get(siteData, 'build_settings.repo_url')) {
+      data.hooks[hook.id].repo_url = get(siteData, 'build_settings.repo_url')
+    }
+  })
+  log(`─────────────────┐
+Site Hook Status │
+─────────────────┘`)
+  log(prettyjson.render(data))
+}
+
+/**
+ * Creates the `netlify status:hooks` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createStatusHooksCommand = (program) =>
+  program
+    .command('status:hooks')
+    .description('Print hook information of the linked site')
+    .option('--verbose', 'Output system info', false)
+    .action(statusHooks)
+
+module.exports = { createStatusHooksCommand }

package/src/commands/status/status.js

@@ -0,0 +1,125 @@
+// @ts-check
+const clean = require('clean-deep')
+const prettyjson = require('prettyjson')
+
+const { chalk, error, exit, generateCommandsHelp, getToken, log, logJson, warn } = require('../../utils')
+
+const { createStatusHooksCommand } = require('./status-hooks')
+
+/**
+ * The status command
+ * @param {import('commander').OptionValues} options
+ * @param {import('../base-command').BaseCommand} command
+ */
+const status = async (options, command) => {
+  const { api, globalConfig, site } = command.netlify
+  const current = globalConfig.get('userId')
+  const [accessToken] = await getToken()
+
+  if (!accessToken) {
+    log(`Not logged in. Please log in to see site status.`)
+    log()
+    log('Login with "netlify login" command')
+    exit()
+  }
+
+  const siteId = site.id
+
+  log(`──────────────────────┐
+ Current Netlify User │
+──────────────────────┘`)
+
+  let accounts
+  let user
+
+  try {
+    ;[accounts, user] = await Promise.all([api.listAccountsForUser(), api.getCurrentUser()])
+  } catch (error_) {
+    if (error_.status === 401) {
+      error('Your session has expired. Please try to re-authenticate by running `netlify logout` and `netlify login`.')
+    }
+  }
+
+  const ghuser = command.netlify.globalConfig.get(`users.${current}.auth.github.user`)
+  const accountData = {
+    Name: user.full_name,
+    Email: user.email,
+    GitHub: ghuser,
+  }
+  const teamsData = {}
+
+  accounts.forEach((team) => {
+    teamsData[team.name] = team.roles_allowed.join(' ')
+  })
+
+  accountData.Teams = teamsData
+
+  const cleanAccountData = clean(accountData)
+
+  log(prettyjson.render(cleanAccountData))
+
+  if (!siteId) {
+    warn('Did you run `netlify link` yet?')
+    error(`You don't appear to be in a folder that is linked to a site`)
+  }
+  let siteData
+  try {
+    siteData = await api.getSite({ siteId })
+  } catch (error_) {
+    // unauthorized
+    if (error_.status === 401) {
+      warn(`Log in with a different account or re-link to a site you have permission for`)
+      error(`Not authorized to view the currently linked site (${siteId})`)
+    }
+    // missing
+    if (error_.status === 404) {
+      error(`The site this folder is linked to can't be found`)
+    }
+    error(error_)
+  }
+
+  // Json only logs out if --json flag is passed
+  if (options.json) {
+    logJson({
+      account: cleanAccountData,
+      siteData: {
+        'site-name': `${siteData.name}`,
+        'config-path': site.configPath,
+        'admin-url': siteData.admin_url,
+        'site-url': siteData.ssl_url || siteData.url,
+        'site-id': siteData.id,
+      },
+    })
+  }
+
+  log(`────────────────────┐
+ Netlify Site Info  │
+────────────────────┘`)
+  log(
+    prettyjson.render({
+      'Current site': `${siteData.name}`,
+      'Netlify TOML': site.configPath,
+      'Admin URL': chalk.magentaBright(siteData.admin_url),
+      'Site URL': chalk.cyanBright(siteData.ssl_url || siteData.url),
+      'Site Id': chalk.yellowBright(siteData.id),
+    }),
+  )
+  log()
+}
+
+/**
+ * Creates the `netlify status` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createStatusCommand = (program) => {
+  createStatusHooksCommand(program)
+
+  return program
+    .command('status')
+    .description('Print status information')
+    .option('--verbose', 'Output system info')
+    .addHelpText('after', generateCommandsHelp('status', program))
+    .action(status)
+}
+module.exports = { createStatusCommand }

package/src/commands/switch/index.js

@@ -0,0 +1,5 @@
+const { createSwitchCommand } = require('./switch')
+
+module.exports = {
+  createSwitchCommand,
+}

package/src/commands/switch/switch.js

@@ -0,0 +1,50 @@
+// @ts-check
+const inquirer = require('inquirer')
+
+const { chalk, log } = require('../../utils')
+const { login } = require('../login')
+
+const LOGIN_NEW = 'I would like to login to a new account'
+
+/**
+ * The switch command
+ * @param {import('commander').OptionValues} options
+ * @param {import('../base-command').BaseCommand} command
+ */
+const switchCommand = async (options, command) => {
+  const availableUsersChoices = Object.values(command.netlify.globalConfig.get('users')).reduce(
+    (prev, current) =>
+      Object.assign(prev, { [current.id]: current.name ? `${current.name} (${current.email})` : current.email }),
+    {},
+  )
+
+  const { accountSwitchChoice } = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'accountSwitchChoice',
+      message: 'Please select the account you want to use:',
+      choices: [...Object.entries(availableUsersChoices).map(([, val]) => val), LOGIN_NEW],
+    },
+  ])
+
+  if (accountSwitchChoice === LOGIN_NEW) {
+    await login({ new: true }, command)
+  } else {
+    const selectedAccount = Object.entries(availableUsersChoices).find(
+      ([, availableUsersChoice]) => availableUsersChoice === accountSwitchChoice,
+    )
+    command.netlify.globalConfig.set('userId', selectedAccount[0])
+    log('')
+    log(`You're now using ${chalk.bold(selectedAccount[1])}.`)
+  }
+}
+
+/**
+ * Creates the `netlify switch` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createSwitchCommand = (program) =>
+  program.command('switch').description('Switch your active Netlify account').action(switchCommand)
+
+module.exports = { createSwitchCommand }

package/src/commands/unlink/index.js

@@ -0,0 +1,5 @@
+const { createUnlinkCommand } = require('./unlink')
+
+module.exports = {
+  createUnlinkCommand,
+}

package/src/commands/unlink/unlink.js

@@ -0,0 +1,48 @@
+// @ts-check
+
+const { exit, log, track } = require('../../utils')
+
+/**
+ * The unlink command
+ * @param {import('commander').OptionValues} options
+ * @param {import('../base-command').BaseCommand} command
+ */
+const unlink = async (options, command) => {
+  const { site, state } = command.netlify
+  const siteId = site.id
+
+  if (!siteId) {
+    log(`Folder is not linked to a Netlify site. Run 'netlify link' to link it`)
+    return exit()
+  }
+
+  let siteData = {}
+  try {
+    // @ts-ignore types from API are wrong they cannot recognize `getSite` of API
+    siteData = await command.netlify.api.getSite({ siteId })
+  } catch (error) {
+    // ignore errors if we can't get the site
+  }
+
+  state.delete('siteId')
+
+  await track('sites_unlinked', {
+    siteId: siteData.id || siteId,
+  })
+
+  if (site) {
+    log(`Unlinked ${site.configPath} from ${siteData ? siteData.name : siteId}`)
+  } else {
+    log('Unlinked site')
+  }
+}
+
+/**
+ * Creates the `netlify unlink` command
+ * @param {import('../base-command').BaseCommand} program
+ * @returns
+ */
+const createUnlinkCommand = (program) =>
+  program.command('unlink').description('Unlink a local folder from a Netlify site').action(unlink)
+
+module.exports = { createUnlinkCommand }

package/src/commands/watch/index.js

@@ -0,0 +1,5 @@
+const { createWatchCommand } = require('./watch')
+
+module.exports = {
+  createWatchCommand,
+}