netlify-cli 17.3.1 → 17.4.0

package/src/commands/sites/sites.mjs

@@ -1,32 +1,30 @@
-// @ts-check
-import { createSitesFromTemplateCommand } from './sites-create-template.mjs'
-import { createSitesCreateCommand } from './sites-create.mjs'
-import { createSitesDeleteCommand } from './sites-delete.mjs'
-import { createSitesListCommand } from './sites-list.mjs'
-
+import { createSitesFromTemplateCommand } from './sites-create-template.mjs';
+import { createSitesCreateCommand } from './sites-create.mjs';
+import { createSitesDeleteCommand } from './sites-delete.mjs';
+import { createSitesListCommand } from './sites-list.mjs';
 /**
  * The sites command
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 const sites = (options, command) => {
-  command.help()
-}
-
+    command.help();
+};
 /**
  * Creates the `netlify sites` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
 export const createSitesCommand = (program) => {
-  createSitesCreateCommand(program)
-  createSitesFromTemplateCommand(program)
-  createSitesListCommand(program)
-  createSitesDeleteCommand(program)
-
-  return program
-    .command('sites')
-    .description(`Handle various site operations\nThe sites command will help you manage all your sites`)
-    .addExamples(['netlify sites:create --name my-new-site', 'netlify sites:list'])
-    .action(sites)
-}
+    createSitesCreateCommand(program);
+    createSitesFromTemplateCommand(program);
+    createSitesListCommand(program);
+    createSitesDeleteCommand(program);
+    return program
+        .command('sites')
+        .description(`Handle various site operations\nThe sites command will help you manage all your sites`)
+        .addExamples(['netlify sites:create --name my-new-site', 'netlify sites:list'])
+        .action(sites);
+};

package/src/commands/status/index.mjs

@@ -1 +1 @@
-export { createStatusCommand } from './status.mjs'
+export { createStatusCommand } from './status.mjs';

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

@@ -1,49 +1,47 @@
-// @ts-check
-import prettyjson from 'prettyjson'
-
-import { log } from '../../utils/command-helpers.mjs'
-import requiresSiteInfo from '../../utils/hooks/requires-site-info.mjs'
-
+import prettyjson from 'prettyjson';
+import { log } from '../../utils/command-helpers.mjs';
+import requiresSiteInfo from '../../utils/hooks/requires-site-info.mjs';
 /**
  * The status:hooks command
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 const statusHooks = async (options, command) => {
-  const { api, siteInfo } = command.netlify
-
-  await command.authenticate()
-
-  const ntlHooks = await api.listHooksBySiteId({ siteId: siteInfo.id })
-  const data = {
-    site: siteInfo.name,
-    hooks: {},
-  }
-  ntlHooks.forEach((hook) => {
-    data.hooks[hook.id] = {
-      type: hook.type,
-      event: hook.event,
-      id: hook.id,
-      disabled: hook.disabled,
-    }
-    if (siteInfo.build_settings?.repo_url) {
-      data.hooks[hook.id].repo_url = siteInfo.build_settings.repo_url
-    }
-  })
-  log(`─────────────────┐
+    const { api, siteInfo } = command.netlify;
+    await command.authenticate();
+    const ntlHooks = await api.listHooksBySiteId({ siteId: siteInfo.id });
+    const data = {
+        site: siteInfo.name,
+        hooks: {},
+    };
+    // @ts-expect-error TS(7006) FIXME: Parameter 'hook' implicitly has an 'any' type.
+    ntlHooks.forEach((hook) => {
+        // @ts-expect-error TS(7053) FIXME: Element implicitly has an 'any' type because expre... Remove this comment to see the full error message
+        data.hooks[hook.id] = {
+            type: hook.type,
+            event: hook.event,
+            id: hook.id,
+            disabled: hook.disabled,
+        };
+        if (siteInfo.build_settings?.repo_url) {
+            // @ts-expect-error TS(7053) FIXME: Element implicitly has an 'any' type because expre... Remove this comment to see the full error message
+            data.hooks[hook.id].repo_url = siteInfo.build_settings.repo_url;
+        }
+    });
+    log(`─────────────────┐
 Site Hook Status │
-─────────────────┘`)
-  log(prettyjson.render(data))
-}
-
+─────────────────┘`);
+    log(prettyjson.render(data));
+};
 /**
  * Creates the `netlify status:hooks` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createStatusHooksCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createStatusHooksCommand = (program) => program
     .command('status:hooks')
     .description('Print hook information of the linked site')
     .hook('preAction', requiresSiteInfo)
-    .action(statusHooks)
+    .action(statusHooks);

package/src/commands/status/status.mjs

@@ -1,123 +1,116 @@
-// @ts-check
-import clean from 'clean-deep'
-import prettyjson from 'prettyjson'
-
-import { chalk, error, exit, getToken, log, logJson, warn } from '../../utils/command-helpers.mjs'
-
-import { createStatusHooksCommand } from './status-hooks.mjs'
-
+import clean from 'clean-deep';
+import prettyjson from 'prettyjson';
+import { chalk, error, exit, getToken, log, logJson, warn } from '../../utils/command-helpers.mjs';
+import { createStatusHooksCommand } from './status-hooks.mjs';
 /**
  * The status command
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 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(`──────────────────────┐
+    const { api, globalConfig, site } = command.netlify;
+    const current = globalConfig.get('userId');
+    // @ts-expect-error TS(2554) FIXME: Expected 1 arguments, but got 0.
+    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`.')
+──────────────────────┘`);
+    let accounts;
+    let user;
+    try {
+        ;
+        [accounts, user] = await Promise.all([api.listAccountsForUser(), api.getCurrentUser()]);
+    }
+    catch (error_) {
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        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 = {};
+    // @ts-expect-error TS(7006) FIXME: Parameter 'team' implicitly has an 'any' type.
+    accounts.forEach((team) => {
+        // @ts-expect-error TS(7053) FIXME: Element implicitly has an 'any' type because expre... Remove this comment to see the full error message
+        teamsData[team.name] = team.roles_allowed.join(' ');
+    });
+    // @ts-expect-error TS(2339) FIXME: Property 'Teams' does not exist on type '{ Name: a... Remove this comment to see the full error message
+    accountData.Teams = teamsData;
+    // @ts-expect-error
+    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 });
     }
-  }
-
-  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})`)
+    catch (error_) {
+        // unauthorized
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        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
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        if (error_.status === 404) {
+            error(`The site this folder is linked to can't be found`);
+        }
+        // @ts-expect-error TS(2345) FIXME: Argument of type 'unknown' is not assignable to pa... Remove this comment to see the full error message
+        error(error_);
     }
-    // missing
-    if (error_.status === 404) {
-      error(`The site this folder is linked to can't be found`)
+    // 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,
+            },
+        });
     }
-    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(`────────────────────┐
+    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()
-}
-
+────────────────────┘`);
+    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.mjs').default} program
  * @returns
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
 export const createStatusCommand = (program) => {
-  createStatusHooksCommand(program)
-
-  return program
-    .command('status')
-    .description('Print status information')
-    .option('--verbose', 'Output system info')
-    .action(status)
-}
+    createStatusHooksCommand(program);
+    return program
+        .command('status')
+        .description('Print status information')
+        .option('--verbose', 'Output system info')
+        .action(status);
+};

package/src/commands/switch/index.mjs

@@ -1 +1 @@
-export { createSwitchCommand } from './switch.mjs'
+export { createSwitchCommand } from './switch.mjs';

package/src/commands/switch/switch.mjs

@@ -1,48 +1,43 @@
-// @ts-check
-import inquirer from 'inquirer'
-
-import { chalk, log } from '../../utils/command-helpers.mjs'
-import { login } from '../login/index.mjs'
-
-const LOGIN_NEW = 'I would like to login to a new account'
-
+import inquirer from 'inquirer';
+import { chalk, log } from '../../utils/command-helpers.mjs';
+import { login } from '../login/index.mjs';
+const LOGIN_NEW = 'I would like to login to a new account';
 /**
  * The switch command
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 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])}.`)
-  }
-}
-
+    const availableUsersChoices = Object.values(command.netlify.globalConfig.get('users') || {}).reduce((prev, current) => 
+    // @ts-expect-error TS(2769) FIXME: No overload matches this call.
+    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:',
+            // @ts-expect-error TS(2769) FIXME: No overload matches this call.
+            choices: [...Object.entries(availableUsersChoices).map(([, val]) => val), LOGIN_NEW],
+        },
+    ]);
+    if (accountSwitchChoice === LOGIN_NEW) {
+        await login({ new: true }, command);
+    }
+    else {
+        // @ts-expect-error TS(2769) FIXME: No overload matches this call.
+        const selectedAccount = Object.entries(availableUsersChoices).find(([, availableUsersChoice]) => availableUsersChoice === accountSwitchChoice);
+        // @ts-expect-error TS(2532) FIXME: Object is possibly 'undefined'.
+        command.netlify.globalConfig.set('userId', selectedAccount[0]);
+        log('');
+        // @ts-expect-error TS(2532) FIXME: Object is possibly 'undefined'.
+        log(`You're now using ${chalk.bold(selectedAccount[1])}.`);
+    }
+};
 /**
  * Creates the `netlify switch` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createSwitchCommand = (program) =>
-  program.command('switch').description('Switch your active Netlify account').action(switchCommand)
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createSwitchCommand = (program) => program.command('switch').description('Switch your active Netlify account').action(switchCommand);

package/src/commands/types.d.ts

@@ -0,0 +1,31 @@
+import { NetlifyTOML } from '@netlify/build-info'
+import type { NetlifyAPI } from 'netlify'
+
+import StateConfig from '../utils/state-config.mjs'
+
+export type NetlifySite = {
+  root?: string
+  configPath?: string
+  siteId?: string
+  get id(): string | undefined
+  set id(id: string): void
+}
+
+/**
+ * The netlify object inside each command with the state
+ */
+export type NetlifyOptions = {
+  api: NetlifyAPI
+  apiOpts: unknown
+  repositoryRoot: string
+  /** Absolute path of the netlify configuration file */
+  configFilePath: string
+  /** Relative path of the netlify configuration file */
+  relConfigFilePath: string
+  site: NetlifySite
+  siteInfo: unknown
+  config: NetlifyTOML
+  cachedConfig: Record<string, unknown>
+  globalConfig: unknown
+  state: StateConfig
+}

package/src/commands/unlink/index.mjs

@@ -1 +1 @@
-export { createUnlinkCommand } from './unlink.mjs'
+export { createUnlinkCommand } from './unlink.mjs';

package/src/commands/unlink/unlink.mjs

@@ -1,40 +1,34 @@
-// @ts-check
-import { exit, log } from '../../utils/command-helpers.mjs'
-import { track } from '../../utils/telemetry/index.mjs'
-
+import { exit, log } from '../../utils/command-helpers.mjs';
+import { track } from '../../utils/telemetry/index.mjs';
 /**
  * The unlink command
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 const unlink = async (options, command) => {
-  const { site, siteInfo, 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()
-  }
-
-  const siteData = siteInfo
-
-  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')
-  }
-}
-
+    const { site, siteInfo, 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();
+    }
+    const siteData = siteInfo;
+    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.mjs').default} program
  * @returns
  */
-export const createUnlinkCommand = (program) =>
-  program.command('unlink').description('Unlink a local folder from a Netlify site').action(unlink)
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createUnlinkCommand = (program) => program.command('unlink').description('Unlink a local folder from a Netlify site').action(unlink);

package/src/commands/watch/index.mjs

@@ -1 +1 @@
-export { createWatchCommand } from './watch.mjs'
+export { createWatchCommand } from './watch.mjs';