netlify-cli 17.3.2 → 17.4.0

package/src/utils/headers.mjs

@@ -1,7 +1,5 @@
-import { parseAllHeaders } from 'netlify-headers-parser'
-
-import { NETLIFYDEVERR, log } from './command-helpers.mjs'
-
+import { parseAllHeaders } from 'netlify-headers-parser';
+import { NETLIFYDEVERR, log } from './command-helpers.mjs';
 /**
  * Get the matching headers for `path` given a set of `rules`.
  *
@@ -13,39 +11,39 @@ import { NETLIFYDEVERR, log } from './command-helpers.mjs'
  *
  * @returns {Object<string,string[]>}
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'headers' implicitly has an 'any' type.
 export const headersForPath = function (headers, path) {
-  const matchingHeaders = headers.filter(({ forRegExp }) => forRegExp.test(path)).map(getHeaderValues)
-  const headersRules = Object.assign({}, ...matchingHeaders)
-  return headersRules
-}
-
+    // @ts-expect-error TS(7031) FIXME: Binding element 'forRegExp' implicitly has an 'any... Remove this comment to see the full error message
+    const matchingHeaders = headers.filter(({ forRegExp }) => forRegExp.test(path)).map(getHeaderValues);
+    const headersRules = Object.assign({}, ...matchingHeaders);
+    return headersRules;
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'values' implicitly has an 'any' t... Remove this comment to see the full error message
 const getHeaderValues = function ({ values }) {
-  return values
-}
-
+    return values;
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'configPath' implicitly has an 'an... Remove this comment to see the full error message
 export const parseHeaders = async function ({ configPath, headersFiles }) {
-  const { errors, headers } = await parseAllHeaders({
-    headersFiles,
-    netlifyConfigPath: configPath,
-    minimal: false,
-  })
-  handleHeadersErrors(errors)
-  return headers
-}
-
+    const { errors, headers } = await parseAllHeaders({
+        headersFiles,
+        netlifyConfigPath: configPath,
+        minimal: false,
+    });
+    handleHeadersErrors(errors);
+    return headers;
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'errors' implicitly has an 'any' type.
 const handleHeadersErrors = function (errors) {
-  if (errors.length === 0) {
-    return
-  }
-
-  const errorMessage = errors.map(getErrorMessage).join('\n\n')
-  log(NETLIFYDEVERR, `Headers syntax errors:\n${errorMessage}`)
-}
-
+    if (errors.length === 0) {
+        return;
+    }
+    const errorMessage = errors.map(getErrorMessage).join('\n\n');
+    log(NETLIFYDEVERR, `Headers syntax errors:\n${errorMessage}`);
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'message' implicitly has an 'any' ... Remove this comment to see the full error message
 const getErrorMessage = function ({ message }) {
-  return message
-}
-
-export const NFFunctionName = 'x-nf-function-name'
-export const NFFunctionRoute = 'x-nf-function-route'
-export const NFRequestID = 'x-nf-request-id'
+    return message;
+};
+export const NFFunctionName = 'x-nf-function-name';
+export const NFFunctionRoute = 'x-nf-function-route';
+export const NFRequestID = 'x-nf-request-id';

package/src/utils/hooks/requires-site-info.mjs

@@ -1,29 +1,33 @@
-import { error, warn } from '../command-helpers.mjs'
+import { error, warn } from '../command-helpers.mjs';
 /**
  * A preAction hook that errors out if siteInfo is an empty object
  * @param {*} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'command' implicitly has an 'any' type.
 const requiresSiteInfo = async (command) => {
-  const { api, site } = command.netlify
-  const siteId = site.id
-  if (!siteId) {
-    warn('Did you run `netlify link` yet?')
-    return error(`You don't appear to be in a folder that is linked to a site`)
-  }
-  try {
-    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`)
-      return error(`Not authorized to view the currently linked site (${siteId})`)
+    const { api, site } = command.netlify;
+    const siteId = site.id;
+    if (!siteId) {
+        warn('Did you run `netlify link` yet?');
+        return error(`You don't appear to be in a folder that is linked to a site`);
     }
-    // missing
-    if (error_.status === 404) {
-      return error(`The site this folder is linked to can't be found`)
+    try {
+        await api.getSite({ siteId });
     }
-    return error(error_)
-  }
-}
-
-export default requiresSiteInfo
+    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`);
+            return 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) {
+            return 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
+        return error(error_);
+    }
+};
+export default requiresSiteInfo;

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

@@ -1,11 +1,7 @@
-// @ts-check
-import { Octokit } from '@octokit/rest'
-
-import { chalk, error as failAndExit, log } from '../command-helpers.mjs'
-import { getGitHubToken as ghauth } from '../gh-auth.mjs'
-
-import { createDeployKey, formatErrorMessage, getBuildSettings, saveNetlifyToml, setupSite } from './utils.mjs'
-
+import { Octokit } from '@octokit/rest';
+import { chalk, error as failAndExit, log } from '../command-helpers.mjs';
+import { getGitHubToken as ghauth } from '../gh-auth.mjs';
+import { createDeployKey, formatErrorMessage, getBuildSettings, saveNetlifyToml, setupSite } from './utils.mjs';
 /**
  * @typedef Token
  * @type {object}
@@ -13,189 +9,192 @@ import { createDeployKey, formatErrorMessage, getBuildSettings, saveNetlifyToml,
  * @property {string} token - The actual token value.
  * @property {string} provider - The Provider where the token is associated with ('github').
  */
-
+// @ts-expect-error TS(7031) FIXME: Binding element 'repoName' implicitly has an 'any'... Remove this comment to see the full error message
 const formatRepoAndOwner = ({ repoName, repoOwner }) => ({
-  name: chalk.magenta(repoName),
-  owner: chalk.magenta(repoOwner),
-})
-
-const PAGE_SIZE = 100
-
+    name: chalk.magenta(repoName),
+    owner: chalk.magenta(repoOwner),
+});
+const PAGE_SIZE = 100;
 /**
  * Get a valid GitHub token
  * @returns {Promise<string>}
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'globalConfig' implicitly has an '... Remove this comment to see the full error message
 export const getGitHubToken = async ({ globalConfig }) => {
-  const userId = globalConfig.get('userId')
-
-  /** @type {Token} */
-  const githubToken = globalConfig.get(`users.${userId}.auth.github`)
-
-  if (githubToken && githubToken.user && githubToken.token) {
-    try {
-      const octokit = getGitHubClient(githubToken.token)
-      const { status } = await octokit.rest.users.getAuthenticated()
-      if (status < 400) {
-        return githubToken.token
-      }
-    } catch {
-      log(chalk.yellow('Token is expired or invalid!'))
-      log('Generating a new Github token...')
+    const userId = globalConfig.get('userId');
+    /** @type {Token} */
+    const githubToken = globalConfig.get(`users.${userId}.auth.github`);
+    if (githubToken && githubToken.user && githubToken.token) {
+        try {
+            const octokit = getGitHubClient(githubToken.token);
+            const { status } = await octokit.rest.users.getAuthenticated();
+            if (status < 400) {
+                return githubToken.token;
+            }
+        }
+        catch {
+            log(chalk.yellow('Token is expired or invalid!'));
+            log('Generating a new Github token...');
+        }
     }
-  }
-
-  const newToken = await ghauth()
-  globalConfig.set(`users.${userId}.auth.github`, newToken)
-  return newToken.token
-}
-
+    const newToken = await ghauth();
+    globalConfig.set(`users.${userId}.auth.github`, newToken);
+    // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+    return newToken.token;
+};
 /**
  * Retrieves the GitHub octokit client
  * @param {string} token
  * @returns {Octokit}
  */
-const getGitHubClient = (token) =>
-  new Octokit({
+// @ts-expect-error TS(7006) FIXME: Parameter 'token' implicitly has an 'any' type.
+const getGitHubClient = (token) => new Octokit({
     auth: `token ${token}`,
-  })
-
+});
+// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
 const addDeployKey = async ({ api, octokit, repoName, repoOwner }) => {
-  log('Adding deploy key to repository...')
-  const key = await createDeployKey({ api })
-  try {
-    await octokit.repos.createDeployKey({
-      title: 'Netlify Deploy Key',
-      key: key.public_key,
-      owner: repoOwner,
-      repo: repoName,
-      read_only: true,
-    })
-    log('Deploy key added!')
-    return key
-  } catch (error) {
-    let message = formatErrorMessage({ message: 'Failed adding GitHub deploy key', error })
-    if (error.status === 404) {
-      const { name, owner } = formatRepoAndOwner({ repoName, repoOwner })
-      message = `${message}. Does the repository ${name} exist and do ${owner} has the correct permissions to set up deploy keys?`
+    log('Adding deploy key to repository...');
+    const key = await createDeployKey({ api });
+    try {
+        await octokit.repos.createDeployKey({
+            title: 'Netlify Deploy Key',
+            key: key.public_key,
+            owner: repoOwner,
+            repo: repoName,
+            read_only: true,
+        });
+        log('Deploy key added!');
+        return key;
+    }
+    catch (error) {
+        let message = formatErrorMessage({ message: 'Failed adding GitHub deploy key', error });
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        if (error.status === 404) {
+            const { name, owner } = formatRepoAndOwner({ repoName, repoOwner });
+            message = `${message}. Does the repository ${name} exist and do ${owner} has the correct permissions to set up deploy keys?`;
+        }
+        failAndExit(message);
     }
-    failAndExit(message)
-  }
-}
-
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'octokit' implicitly has an 'any' ... Remove this comment to see the full error message
 const getGitHubRepo = async ({ octokit, repoName, repoOwner }) => {
-  try {
-    const { data } = await octokit.repos.get({
-      owner: repoOwner,
-      repo: repoName,
-    })
-    return data
-  } catch (error) {
-    let message = formatErrorMessage({ message: 'Failed retrieving GitHub repository information', error })
-    if (error.status === 404) {
-      const { name, owner } = formatRepoAndOwner({ repoName, repoOwner })
-      message = `${message}. Does the repository ${name} exist and accessible by ${owner}`
+    try {
+        const { data } = await octokit.repos.get({
+            owner: repoOwner,
+            repo: repoName,
+        });
+        return data;
+    }
+    catch (error) {
+        let message = formatErrorMessage({ message: 'Failed retrieving GitHub repository information', error });
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        if (error.status === 404) {
+            const { name, owner } = formatRepoAndOwner({ repoName, repoOwner });
+            message = `${message}. Does the repository ${name} exist and accessible by ${owner}`;
+        }
+        failAndExit(message);
     }
-    failAndExit(message)
-  }
-}
-
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'deployHook' implicitly has an 'an... Remove this comment to see the full error message
 const hookExists = async ({ deployHook, octokit, repoName, repoOwner }) => {
-  try {
-    const { data: hooks } = await octokit.repos.listWebhooks({
-      owner: repoOwner,
-      repo: repoName,
-      per_page: PAGE_SIZE,
-    })
-    const exists = hooks.some((hook) => hook.config.url === deployHook)
-    return exists
-  } catch {
-    // we don't need to fail if listHooks errors out
-    return false
-  }
-}
-
-const addDeployHook = async ({ deployHook, octokit, repoName, repoOwner }) => {
-  const exists = await hookExists({ deployHook, octokit, repoOwner, repoName })
-  if (!exists) {
     try {
-      await octokit.repos.createWebhook({
-        owner: repoOwner,
-        repo: repoName,
-        name: 'web',
-        config: {
-          url: deployHook,
-          content_type: 'json',
-        },
-        events: ['push', 'pull_request', 'delete'],
-        active: true,
-      })
-    } catch (error) {
-      // Ignore exists error if the list doesn't return all installed hooks
-      if (!error.message.includes('Hook already exists on this repository')) {
-        let message = formatErrorMessage({ message: 'Failed creating repo hook', error })
-        if (error.status === 404) {
-          const { name, owner } = formatRepoAndOwner({ repoName, repoOwner })
-          message = `${message}. Does the repository ${name} and do ${owner} has the correct permissions to set up hooks`
+        const { data: hooks } = await octokit.repos.listWebhooks({
+            owner: repoOwner,
+            repo: repoName,
+            per_page: PAGE_SIZE,
+        });
+        // @ts-expect-error TS(7006) FIXME: Parameter 'hook' implicitly has an 'any' type.
+        const exists = hooks.some((hook) => hook.config.url === deployHook);
+        return exists;
+    }
+    catch {
+        // we don't need to fail if listHooks errors out
+        return false;
+    }
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'deployHook' implicitly has an 'an... Remove this comment to see the full error message
+const addDeployHook = async ({ deployHook, octokit, repoName, repoOwner }) => {
+    const exists = await hookExists({ deployHook, octokit, repoOwner, repoName });
+    if (!exists) {
+        try {
+            await octokit.repos.createWebhook({
+                owner: repoOwner,
+                repo: repoName,
+                name: 'web',
+                config: {
+                    url: deployHook,
+                    content_type: 'json',
+                },
+                events: ['push', 'pull_request', 'delete'],
+                active: true,
+            });
+        }
+        catch (error) {
+            // Ignore exists error if the list doesn't return all installed hooks
+            // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+            if (!error.message.includes('Hook already exists on this repository')) {
+                let message = formatErrorMessage({ message: 'Failed creating repo hook', error });
+                // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+                if (error.status === 404) {
+                    const { name, owner } = formatRepoAndOwner({ repoName, repoOwner });
+                    message = `${message}. Does the repository ${name} and do ${owner} has the correct permissions to set up hooks`;
+                }
+                failAndExit(message);
+            }
         }
-        failAndExit(message)
-      }
     }
-  }
-}
-
-const GITHUB_HOOK_EVENTS = ['deploy_created', 'deploy_failed', 'deploy_building']
-const GITHUB_HOOK_TYPE = 'github_commit_status'
-
+};
+const GITHUB_HOOK_EVENTS = ['deploy_created', 'deploy_failed', 'deploy_building'];
+const GITHUB_HOOK_TYPE = 'github_commit_status';
+// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
 const upsertHook = async ({ api, event, ntlHooks, siteId, token }) => {
-  const ntlHook = ntlHooks.find((hook) => hook.type === GITHUB_HOOK_TYPE && hook.event === event)
-
-  if (!ntlHook || ntlHook.disabled) {
-    return await api.createHookBySiteId({
-      site_id: siteId,
-      body: {
-        type: GITHUB_HOOK_TYPE,
-        event,
-        data: {
-          access_token: token,
+    // @ts-expect-error TS(7006) FIXME: Parameter 'hook' implicitly has an 'any' type.
+    const ntlHook = ntlHooks.find((hook) => hook.type === GITHUB_HOOK_TYPE && hook.event === event);
+    if (!ntlHook || ntlHook.disabled) {
+        return await api.createHookBySiteId({
+            site_id: siteId,
+            body: {
+                type: GITHUB_HOOK_TYPE,
+                event,
+                data: {
+                    access_token: token,
+                },
+            },
+        });
+    }
+    return await api.updateHook({
+        hook_id: ntlHook.id,
+        body: {
+            data: {
+                access_token: token,
+            },
         },
-      },
-    })
-  }
-
-  return await api.updateHook({
-    hook_id: ntlHook.id,
-    body: {
-      data: {
-        access_token: token,
-      },
-    },
-  })
-}
-
+    });
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
 const addNotificationHooks = async ({ api, siteId, token }) => {
-  log(`Creating Netlify GitHub Notification Hooks...`)
-
-  let ntlHooks
-  try {
-    ntlHooks = await api.listHooksBySiteId({ siteId })
-  } catch (error) {
-    const message = formatErrorMessage({ message: 'Failed retrieving Netlify hooks', error })
-    failAndExit(message)
-  }
-  await Promise.all(
-    GITHUB_HOOK_EVENTS.map(async (event) => {
-      try {
-        await upsertHook({ ntlHooks, event, api, siteId, token })
-      } catch (error) {
-        const message = formatErrorMessage({ message: `Failed settings Netlify hook ${chalk.magenta(event)}`, error })
-        failAndExit(message)
-      }
-    }),
-  )
-
-  log(`Netlify Notification Hooks configured!`)
-}
-
+    log(`Creating Netlify GitHub Notification Hooks...`);
+    // @ts-expect-error TS(7034) FIXME: Variable 'ntlHooks' implicitly has type 'any' in s... Remove this comment to see the full error message
+    let ntlHooks;
+    try {
+        ntlHooks = await api.listHooksBySiteId({ siteId });
+    }
+    catch (error) {
+        const message = formatErrorMessage({ message: 'Failed retrieving Netlify hooks', error });
+        failAndExit(message);
+    }
+    await Promise.all(GITHUB_HOOK_EVENTS.map(async (event) => {
+        try {
+            // @ts-expect-error TS(7005) FIXME: Variable 'ntlHooks' implicitly has an 'any' type.
+            await upsertHook({ ntlHooks, event, api, siteId, token });
+        }
+        catch (error) {
+            const message = formatErrorMessage({ message: `Failed settings Netlify hook ${chalk.magenta(event)}`, error });
+            failAndExit(message);
+        }
+    }));
+    log(`Netlify Notification Hooks configured!`);
+};
 /**
  * @param {object} config
  * @param {import('../../commands/base-command.mjs').default} config.command
@@ -203,56 +202,45 @@ const addNotificationHooks = async ({ api, siteId, token }) => {
  * @param {string} config.repoOwner
  * @param {string} config.siteId
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'command' implicitly has an 'any' ... Remove this comment to see the full error message
 export const configGithub = async ({ command, repoName, repoOwner, siteId }) => {
-  const { netlify } = command
-  const {
-    api,
-    cachedConfig: { configPath },
-    config,
-    globalConfig,
-    repositoryRoot,
-    site: { root: siteRoot },
-  } = netlify
-
-  const token = await getGitHubToken({ globalConfig })
-
-  const { baseDir, buildCmd, buildDir, functionsDir, pluginsToInstall } = await getBuildSettings({
-    repositoryRoot,
-    siteRoot,
-    config,
-    command,
-  })
-  await saveNetlifyToml({ repositoryRoot, config, configPath, baseDir, buildCmd, buildDir, functionsDir })
-
-  log()
-
-  const octokit = getGitHubClient(token)
-  const [deployKey, githubRepo] = await Promise.all([
-    addDeployKey({ api, octokit, repoOwner, repoName }),
-    getGitHubRepo({ octokit, repoOwner, repoName }),
-  ])
-
-  const repo = {
-    id: githubRepo.id,
-    provider: 'github',
-    repo_path: githubRepo.full_name,
-    repo_branch: githubRepo.default_branch,
-    allowed_branches: [githubRepo.default_branch],
-    deploy_key_id: deployKey.id,
-    base: baseDir,
-    dir: buildDir,
-    functions_dir: functionsDir,
-    ...(buildCmd && { cmd: buildCmd }),
-  }
-
-  const updatedSite = await setupSite({
-    api,
-    siteId,
-    repo,
-    configPlugins: config.plugins,
-    pluginsToInstall,
-  })
-  await addDeployHook({ deployHook: updatedSite.deploy_hook, octokit, repoOwner, repoName })
-  log()
-  await addNotificationHooks({ siteId, api, token })
-}
+    const { netlify } = command;
+    const { api, cachedConfig: { configPath }, config, globalConfig, repositoryRoot, site: { root: siteRoot }, } = netlify;
+    const token = await getGitHubToken({ globalConfig });
+    const { baseDir, buildCmd, buildDir, functionsDir, pluginsToInstall } = await getBuildSettings({
+        // @ts-expect-error TS(2345) FIXME: Argument of type '{ repositoryRoot: any; siteRoot:... Remove this comment to see the full error message
+        repositoryRoot,
+        siteRoot,
+        config,
+        command,
+    });
+    await saveNetlifyToml({ repositoryRoot, config, configPath, baseDir, buildCmd, buildDir, functionsDir });
+    log();
+    const octokit = getGitHubClient(token);
+    const [deployKey, githubRepo] = await Promise.all([
+        addDeployKey({ api, octokit, repoOwner, repoName }),
+        getGitHubRepo({ octokit, repoOwner, repoName }),
+    ]);
+    const repo = {
+        id: githubRepo.id,
+        provider: 'github',
+        repo_path: githubRepo.full_name,
+        repo_branch: githubRepo.default_branch,
+        allowed_branches: [githubRepo.default_branch],
+        deploy_key_id: deployKey.id,
+        base: baseDir,
+        dir: buildDir,
+        functions_dir: functionsDir,
+        ...(buildCmd && { cmd: buildCmd }),
+    };
+    const updatedSite = await setupSite({
+        api,
+        siteId,
+        repo,
+        configPlugins: config.plugins,
+        pluginsToInstall,
+    });
+    await addDeployHook({ deployHook: updatedSite.deploy_hook, octokit, repoOwner, repoName });
+    log();
+    await addNotificationHooks({ siteId, api, token });
+};