netlify-cli 17.3.1 → 17.4.0

package/src/utils/functions/get-functions.mjs

@@ -1,35 +1,34 @@
-// @ts-check
-import { listFunctions } from '@netlify/zip-it-and-ship-it'
-
-import { fileExistsAsync } from '../../lib/fs.mjs'
-
-const getUrlPath = (functionName) => `/.netlify/functions/${functionName}`
-
-export const BACKGROUND = '-background'
-const JS = 'js'
-
+import { listFunctions } from '@netlify/zip-it-and-ship-it';
+import { fileExistsAsync } from '../../lib/fs.mjs';
+// @ts-expect-error TS(7006) FIXME: Parameter 'functionName' implicitly has an 'any' t... Remove this comment to see the full error message
+const getUrlPath = (functionName) => `/.netlify/functions/${functionName}`;
+export const BACKGROUND = '-background';
+const JS = 'js';
+// @ts-expect-error TS(7031) FIXME: Binding element 'mainFile' implicitly has an 'any'... Remove this comment to see the full error message
 const addFunctionProps = ({ mainFile, name, runtime, schedule }) => {
-  const urlPath = getUrlPath(name)
-  const isBackground = name.endsWith(BACKGROUND)
-  return { mainFile, name, runtime, urlPath, isBackground, schedule }
-}
-
+    const urlPath = getUrlPath(name);
+    const isBackground = name.endsWith(BACKGROUND);
+    return { mainFile, name, runtime, urlPath, isBackground, schedule };
+};
 /**
  * @param {Record<string, { schedule?: string }>} functionConfigRecord
  * @returns {Record<string, { schedule?: string }>}
  */
-const extractSchedule = (functionConfigRecord) =>
-  Object.fromEntries(Object.entries(functionConfigRecord).map(([name, { schedule }]) => [name, { schedule }]))
-
+// @ts-expect-error TS(7006) FIXME: Parameter 'functionConfigRecord' implicitly has an... Remove this comment to see the full error message
+const extractSchedule = (functionConfigRecord) => 
+// @ts-expect-error TS(2339) FIXME: Property 'schedule' does not exist on type 'unknow... Remove this comment to see the full error message
+Object.fromEntries(Object.entries(functionConfigRecord).map(([name, { schedule }]) => [name, { schedule }]));
+// @ts-expect-error TS(7006) FIXME: Parameter 'functionsSrcDir' implicitly has an 'any... Remove this comment to see the full error message
 export const getFunctions = async (functionsSrcDir, config = {}) => {
-  if (!(await fileExistsAsync(functionsSrcDir))) {
-    return []
-  }
-
-  const functions = await listFunctions(functionsSrcDir, {
-    config: config.functions ? extractSchedule(config.functions) : undefined,
-    parseISC: true,
-  })
-  const functionsWithProps = functions.filter(({ runtime }) => runtime === JS).map((func) => addFunctionProps(func))
-  return functionsWithProps
-}
+    if (!(await fileExistsAsync(functionsSrcDir))) {
+        return [];
+    }
+    const functions = await listFunctions(functionsSrcDir, {
+        // @ts-expect-error TS(2339) FIXME: Property 'functions' does not exist on type '{}'.
+        config: config.functions ? extractSchedule(config.functions) : undefined,
+        parseISC: true,
+    });
+    // @ts-expect-error TS(2345) FIXME: Argument of type 'ListedFunction' is not assignabl... Remove this comment to see the full error message
+    const functionsWithProps = functions.filter(({ runtime }) => runtime === JS).map((func) => addFunctionProps(func));
+    return functionsWithProps;
+};

package/src/utils/functions/index.mjs

@@ -1,3 +1,3 @@
-export * from './constants.mjs'
-export * from './functions.mjs'
-export * from './get-functions.mjs'
+export * from './constants.mjs';
+export * from './functions.mjs';
+export * from './get-functions.mjs';

package/src/utils/get-global-config.mjs

@@ -1,43 +1,40 @@
-import { readFile } from 'fs/promises'
-
-import Configstore from 'configstore'
-import { v4 as uuidv4 } from 'uuid'
-
-import { getLegacyPathInHome, getPathInHome } from '../lib/settings.mjs'
-
+import { readFile } from 'fs/promises';
+// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'conf... Remove this comment to see the full error message
+import Configstore from 'configstore';
+import { v4 as uuidv4 } from 'uuid';
+import { getLegacyPathInHome, getPathInHome } from '../lib/settings.mjs';
 const globalConfigDefaults = {
-  /* disable stats from being sent to Netlify */
-  telemetryDisabled: false,
-  /* cliId */
-  cliId: uuidv4(),
-}
-
+    /* disable stats from being sent to Netlify */
+    telemetryDisabled: false,
+    /* cliId */
+    cliId: uuidv4(),
+};
 // Memoise config result so that we only load it once
-let configStore
-
+// @ts-expect-error TS(7034) FIXME: Variable 'configStore' implicitly has type 'any' i... Remove this comment to see the full error message
+let configStore;
 /**
  * @returns {Promise<Configstore>}
  */
 const getGlobalConfig = async function () {
-  if (!configStore) {
-    const configPath = getPathInHome(['config.json'])
-    // Legacy config file in home ~/.netlify/config.json
-    const legacyPath = getLegacyPathInHome(['config.json'])
-    let legacyConfig
-    // Read legacy config if exists
-    try {
-      legacyConfig = JSON.parse(await readFile(legacyPath))
-    } catch {}
-    // Use legacy config as default values
-    const defaults = { ...globalConfigDefaults, ...legacyConfig }
-    configStore = new Configstore(null, defaults, { configPath })
-  }
-
-  return configStore
-}
-
+    // @ts-expect-error TS(7005) FIXME: Variable 'configStore' implicitly has an 'any' typ... Remove this comment to see the full error message
+    if (!configStore) {
+        const configPath = getPathInHome(['config.json']);
+        // Legacy config file in home ~/.netlify/config.json
+        const legacyPath = getLegacyPathInHome(['config.json']);
+        let legacyConfig;
+        // Read legacy config if exists
+        try {
+            // @ts-expect-error TS(2345) FIXME: Argument of type 'Buffer' is not assignable to par... Remove this comment to see the full error message
+            legacyConfig = JSON.parse(await readFile(legacyPath));
+        }
+        catch { }
+        // Use legacy config as default values
+        const defaults = { ...globalConfigDefaults, ...legacyConfig };
+        configStore = new Configstore(null, defaults, { configPath });
+    }
+    return configStore;
+};
 export const resetConfigCache = () => {
-  configStore = undefined
-}
-
-export default getGlobalConfig
+    configStore = undefined;
+};
+export default getGlobalConfig;

package/src/utils/get-package-json.mjs

@@ -1,16 +1,15 @@
-import { readFile } from 'fs/promises'
-import { dirname, join } from 'path'
-import { fileURLToPath } from 'url'
-
-let packageJson
-
+import { readFile } from 'fs/promises';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+// @ts-expect-error TS(7034) FIXME: Variable 'packageJson' implicitly has type 'any' i... Remove this comment to see the full error message
+let packageJson;
 const getPackageJson = async () => {
-  if (!packageJson) {
-    const packageJsonPath = join(dirname(fileURLToPath(import.meta.url)), '../../package.json')
-    packageJson = JSON.parse(await readFile(packageJsonPath))
-  }
-
-  return packageJson
-}
-
-export default getPackageJson
+    // @ts-expect-error TS(7005) FIXME: Variable 'packageJson' implicitly has an 'any' typ... Remove this comment to see the full error message
+    if (!packageJson) {
+        const packageJsonPath = join(dirname(fileURLToPath(import.meta.url)), '../../package.json');
+        // @ts-expect-error TS(2345) FIXME: Argument of type 'Buffer' is not assignable to par... Remove this comment to see the full error message
+        packageJson = JSON.parse(await readFile(packageJsonPath));
+    }
+    return packageJson;
+};
+export default getPackageJson;

package/src/utils/get-repo-data.mjs

@@ -1,14 +1,12 @@
-// @ts-check
-import { dirname } from 'path'
-import util from 'util'
-
-import { findUp } from 'find-up'
-import gitRepoInfo from 'git-repo-info'
-import gitconfiglocal from 'gitconfiglocal'
-import parseGitRemote from 'parse-github-url'
-
-import { log } from './command-helpers.mjs'
-
+import { dirname } from 'path';
+import util from 'util';
+import { findUp } from 'find-up';
+import gitRepoInfo from 'git-repo-info';
+// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'gitc... Remove this comment to see the full error message
+import gitconfiglocal from 'gitconfiglocal';
+// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'pars... Remove this comment to see the full error message
+import parseGitRemote from 'parse-github-url';
+import { log } from './command-helpers.mjs';
 /**
  *
  * @param {object} config
@@ -16,60 +14,52 @@ import { log } from './command-helpers.mjs'
  * @param {string} config.workingDir
  * @returns
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'remoteName' implicitly has an 'an... Remove this comment to see the full error message
 const getRepoData = async function ({ remoteName, workingDir }) {
-  try {
-    const [gitConfig, gitDirectory] = await Promise.all([
-      util.promisify(gitconfiglocal)(workingDir),
-      findUp('.git', { cwd: workingDir, type: 'directory' }),
-    ])
-
-    if (!gitDirectory || !gitConfig || !gitConfig.remote || Object.keys(gitConfig.remote).length === 0) {
-      throw new Error('No Git remote found')
+    try {
+        const [gitConfig, gitDirectory] = await Promise.all([
+            util.promisify(gitconfiglocal)(workingDir),
+            findUp('.git', { cwd: workingDir, type: 'directory' }),
+        ]);
+        if (!gitDirectory || !gitConfig || !gitConfig.remote || Object.keys(gitConfig.remote).length === 0) {
+            throw new Error('No Git remote found');
+        }
+        const baseGitPath = dirname(gitDirectory);
+        if (workingDir !== baseGitPath) {
+            log(`Git directory located in ${baseGitPath}`);
+        }
+        if (!remoteName) {
+            const remotes = Object.keys(gitConfig.remote);
+            remoteName = remotes.find((remote) => remote === 'origin') || remotes[0];
+        }
+        if (!Object.prototype.hasOwnProperty.call(gitConfig.remote, remoteName) ||
+            !gitConfig.remote[remoteName] ||
+            Object.keys(gitConfig.remote[remoteName]).length === 0) {
+            throw new Error(`The specified remote "${remoteName}" is not defined in Git repo. Please use --git-remote-name flag to specify a remote.`);
+        }
+        const { url } = gitConfig.remote[remoteName];
+        const { host, name, owner, repo } = parseGitRemote(url);
+        const { branch } = gitRepoInfo();
+        return {
+            name,
+            owner,
+            repo,
+            url,
+            branch,
+            // @ts-expect-error TS(7053) FIXME: Element implicitly has an 'any' type because expre... Remove this comment to see the full error message
+            provider: PROVIDERS[host] || host,
+            httpsUrl: `https://${host}/${repo}`,
+        };
     }
-
-    const baseGitPath = dirname(gitDirectory)
-
-    if (workingDir !== baseGitPath) {
-      log(`Git directory located in ${baseGitPath}`)
+    catch (error) {
+        return {
+            // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+            error: error.message,
+        };
     }
-
-    if (!remoteName) {
-      const remotes = Object.keys(gitConfig.remote)
-      remoteName = remotes.find((remote) => remote === 'origin') || remotes[0]
-    }
-
-    if (
-      !Object.prototype.hasOwnProperty.call(gitConfig.remote, remoteName) ||
-      !gitConfig.remote[remoteName] ||
-      Object.keys(gitConfig.remote[remoteName]).length === 0
-    ) {
-      throw new Error(
-        `The specified remote "${remoteName}" is not defined in Git repo. Please use --git-remote-name flag to specify a remote.`,
-      )
-    }
-
-    const { url } = gitConfig.remote[remoteName]
-    const { host, name, owner, repo } = parseGitRemote(url)
-    const { branch } = gitRepoInfo()
-    return {
-      name,
-      owner,
-      repo,
-      url,
-      branch,
-      provider: PROVIDERS[host] || host,
-      httpsUrl: `https://${host}/${repo}`,
-    }
-  } catch (error) {
-    return {
-      error: error.message,
-    }
-  }
-}
-
+};
 const PROVIDERS = {
-  'github.com': 'github',
-  'gitlab.com': 'gitlab',
-}
-
-export default getRepoData
+    'github.com': 'github',
+    'gitlab.com': 'gitlab',
+};
+export default getRepoData;

package/src/utils/get-site.mjs

@@ -1,16 +1,16 @@
-import { error } from './command-helpers.mjs'
-
+import { error } from './command-helpers.mjs';
+// @ts-expect-error TS(7006) FIXME: Parameter 'api' implicitly has an 'any' type.
 export const getSiteByName = async (api, siteName) => {
-  try {
-    const sites = await api.listSites({ name: siteName, filter: 'all' })
-    const siteFoundByName = sites.find((filteredSite) => filteredSite.name === siteName)
-
-    if (!siteFoundByName) {
-      throw Error
+    try {
+        const sites = await api.listSites({ name: siteName, filter: 'all' });
+        // @ts-expect-error TS(7006) FIXME: Parameter 'filteredSite' implicitly has an 'any' t... Remove this comment to see the full error message
+        const siteFoundByName = sites.find((filteredSite) => filteredSite.name === siteName);
+        if (!siteFoundByName) {
+            throw Error;
+        }
+        return siteFoundByName;
     }
-
-    return siteFoundByName
-  } catch {
-    error('Site not found. Please rerun "netlify link"')
-  }
-}
+    catch {
+        error('Site not found. Please rerun "netlify link"');
+    }
+};

package/src/utils/gh-auth.mjs

@@ -1,18 +1,13 @@
-// @ts-check
 // A simple ghauth inspired library for getting a personal access token
-import http from 'http'
-import process from 'process'
-
-import { Octokit } from '@octokit/rest'
-import getPort from 'get-port'
-import inquirer from 'inquirer'
-
-import { log } from './command-helpers.mjs'
-import createDeferred from './create-deferred.mjs'
-import openBrowser from './open-browser.mjs'
-
-const SERVER_PORT = 3000
-
+import http from 'http';
+import process from 'process';
+import { Octokit } from '@octokit/rest';
+import getPort from 'get-port';
+import inquirer from 'inquirer';
+import { log } from './command-helpers.mjs';
+import createDeferred from './create-deferred.mjs';
+import openBrowser from './open-browser.mjs';
+const SERVER_PORT = 3000;
 /**
  * @typedef Token
  * @type {object}
@@ -20,106 +15,90 @@ const SERVER_PORT = 3000
  * @property {string} token - The actual token value starting with `gho_`
  * @property {string} provider - The Provider where the token is associated with ('github').
  */
-
 const promptForAuthMethod = async () => {
-  const authChoiceNetlify = 'Authorize with GitHub through app.netlify.com'
-  const authChoiceToken = 'Authorize with a GitHub personal access token'
-  const authChoices = [authChoiceNetlify, authChoiceToken]
-
-  const { authMethod } = await inquirer.prompt([
-    {
-      type: 'list',
-      name: 'authMethod',
-      message:
-        'Netlify CLI needs access to your GitHub account to configure Webhooks and Deploy Keys. ' +
-        'What would you like to do?',
-      choices: authChoices,
-    },
-  ])
-
-  return authMethod === authChoiceNetlify
-}
-
+    const authChoiceNetlify = 'Authorize with GitHub through app.netlify.com';
+    const authChoiceToken = 'Authorize with a GitHub personal access token';
+    const authChoices = [authChoiceNetlify, authChoiceToken];
+    const { authMethod } = await inquirer.prompt([
+        {
+            type: 'list',
+            name: 'authMethod',
+            message: 'Netlify CLI needs access to your GitHub account to configure Webhooks and Deploy Keys. ' +
+                'What would you like to do?',
+            choices: authChoices,
+        },
+    ]);
+    return authMethod === authChoiceNetlify;
+};
 /**
  * Authenticate with the netlify app
  * @returns {Promise<Token>} Returns a Promise with a token object
  */
 export const authWithNetlify = async () => {
-  const port = await getPort({ port: SERVER_PORT })
-  const { promise: deferredPromise, reject: deferredReject, resolve: deferredResolve } = createDeferred()
-
-  const server = http.createServer(function onRequest(req, res) {
-    const parameters = new URLSearchParams(req.url.slice(req.url.indexOf('?') + 1))
-    if (parameters.get('token')) {
-      deferredResolve(Object.fromEntries(parameters))
-      res.end(
-        `${
-          "<html><head><script>if(history.replaceState){history.replaceState({},'','/')}</script><style>html{font-family:sans-serif;background:#0e1e25}body{overflow:hidden;position:relative;display:flex;flex-direction:column;align-items:center;justify-content:center;height:100vh;width:100vw;}h3{margin:0}.card{position:relative;display:flex;flex-direction:column;width:75%;max-width:364px;padding:24px;background:white;color:rgb(14,30,37);border-radius:8px;box-shadow:0 2px 4px 0 rgba(14,30,37,.16);}</style></head>" +
-          "<body><div class=card><h3>Logged In</h3><p>You're now logged into Netlify CLI with your "
-        }${parameters.get('provider')} credentials. Please close this window.</p></div>`,
-      )
-      server.close()
-      return
-    }
-    res.end('BAD PARAMETERS')
-    server.close()
-    deferredReject(new Error('Got invalid parameters for CLI login'))
-  })
-
-  await new Promise(function waitForListening(resolve, reject) {
-    server.on('error', reject)
-    server.listen(port, resolve)
-  })
-
-  const webUI = process.env.NETLIFY_WEB_UI || 'https://app.netlify.com'
-  const urlParams = new URLSearchParams({
-    host: `http://localhost:${port}`,
-    provider: 'github',
-  })
-  const url = `${webUI}/cli?${urlParams.toString()}`
-
-  await openBrowser({ url })
-
-  return deferredPromise
-}
-
+    const port = await getPort({ port: SERVER_PORT });
+    const { promise: deferredPromise, reject: deferredReject, resolve: deferredResolve } = createDeferred();
+    const server = http.createServer(function onRequest(req, res) {
+        // @ts-expect-error TS(2532) FIXME: Object is possibly 'undefined'.
+        const parameters = new URLSearchParams(req.url.slice(req.url.indexOf('?') + 1));
+        if (parameters.get('token')) {
+            // @ts-expect-error TS(2722) FIXME: Cannot invoke an object which is possibly 'undefin... Remove this comment to see the full error message
+            deferredResolve(Object.fromEntries(parameters));
+            res.end(`${"<html><head><script>if(history.replaceState){history.replaceState({},'','/')}</script><style>html{font-family:sans-serif;background:#0e1e25}body{overflow:hidden;position:relative;display:flex;flex-direction:column;align-items:center;justify-content:center;height:100vh;width:100vw;}h3{margin:0}.card{position:relative;display:flex;flex-direction:column;width:75%;max-width:364px;padding:24px;background:white;color:rgb(14,30,37);border-radius:8px;box-shadow:0 2px 4px 0 rgba(14,30,37,.16);}</style></head>" +
+                "<body><div class=card><h3>Logged In</h3><p>You're now logged into Netlify CLI with your "}${parameters.get('provider')} credentials. Please close this window.</p></div>`);
+            server.close();
+            return;
+        }
+        res.end('BAD PARAMETERS');
+        server.close();
+        // @ts-expect-error TS(2722) FIXME: Cannot invoke an object which is possibly 'undefin... Remove this comment to see the full error message
+        deferredReject(new Error('Got invalid parameters for CLI login'));
+    });
+    await new Promise(function waitForListening(resolve, reject) {
+        server.on('error', reject);
+        // @ts-expect-error TS(2769) FIXME: No overload matches this call.
+        server.listen(port, resolve);
+    });
+    const webUI = process.env.NETLIFY_WEB_UI || 'https://app.netlify.com';
+    const urlParams = new URLSearchParams({
+        host: `http://localhost:${port}`,
+        provider: 'github',
+    });
+    const url = `${webUI}/cli?${urlParams.toString()}`;
+    // @ts-expect-error TS(2345) FIXME: Argument of type '{ url: string; }' is not assigna... Remove this comment to see the full error message
+    await openBrowser({ url });
+    return deferredPromise;
+};
 const getPersonalAccessToken = async () => {
-  const { token } = await inquirer.prompt([
-    {
-      type: 'input',
-      name: 'token',
-      message: 'Your GitHub personal access token:',
-      filter: (input) => input.trim(),
-    },
-  ])
-
-  return { token }
-}
-
+    const { token } = await inquirer.prompt([
+        {
+            type: 'input',
+            name: 'token',
+            message: 'Your GitHub personal access token:',
+            filter: (input) => input.trim(),
+        },
+    ]);
+    return { token };
+};
 /**
  * Authenticate with the netlify app
  * @returns {Promise<Token>} Returns a Promise with a token object
  */
 const authWithToken = async () => {
-  const { token } = await getPersonalAccessToken()
-  if (!token) {
-    throw new Error('GitHub authentication failed')
-  }
-
-  const octokit = new Octokit({ auth: `token ${token}` })
-  const { login: user } = await octokit.users.getAuthenticated()
-
-  return { token, user, provider: 'github' }
-}
-
+    const { token } = await getPersonalAccessToken();
+    if (!token) {
+        throw new Error('GitHub authentication failed');
+    }
+    const octokit = new Octokit({ auth: `token ${token}` });
+    // @ts-expect-error TS(2339) FIXME: Property 'login' does not exist on type 'OctokitRe... Remove this comment to see the full error message
+    const { login: user } = await octokit.users.getAuthenticated();
+    return { token, user, provider: 'github' };
+};
 /**
  * Get a GitHub token
  * @returns {Promise<Token>} Returns a Promise with a token object
  */
 export const getGitHubToken = async () => {
-  log('')
-
-  const withNetlify = await promptForAuthMethod()
-
-  return withNetlify ? await authWithNetlify() : await authWithToken()
-}
+    log('');
+    const withNetlify = await promptForAuthMethod();
+    return withNetlify ? await authWithNetlify() : await authWithToken();
+};

package/src/utils/gitignore.mjs

@@ -1,42 +1,39 @@
-// @ts-check
-import { readFile, writeFile } from 'fs/promises'
-import path from 'path'
-
-import parseIgnore from 'parse-gitignore'
-
-import { fileExistsAsync } from '../lib/fs.mjs'
-
-import { log } from './command-helpers.mjs'
-
+import { readFile, writeFile } from 'fs/promises';
+import path from 'path';
+// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'pars... Remove this comment to see the full error message
+import parseIgnore from 'parse-gitignore';
+import { fileExistsAsync } from '../lib/fs.mjs';
+import { log } from './command-helpers.mjs';
+// @ts-expect-error TS(7006) FIXME: Parameter 'dir' implicitly has an 'any' type.
 const hasGitIgnore = async function (dir) {
-  const gitIgnorePath = path.join(dir, '.gitignore')
-  const hasIgnore = await fileExistsAsync(gitIgnorePath)
-  return hasIgnore
-}
-
+    const gitIgnorePath = path.join(dir, '.gitignore');
+    const hasIgnore = await fileExistsAsync(gitIgnorePath);
+    return hasIgnore;
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'dir' implicitly has an 'any' type.
 export const ensureNetlifyIgnore = async function (dir) {
-  const gitIgnorePath = path.join(dir, '.gitignore')
-  const ignoreContent = '# Local Netlify folder\n.netlify\n'
-
-  /* No .gitignore file. Create one and ignore .netlify folder */
-  if (!(await hasGitIgnore(dir))) {
-    await writeFile(gitIgnorePath, ignoreContent, 'utf8')
-    return false
-  }
-
-  let gitIgnoreContents
-  let ignorePatterns
-  try {
-    gitIgnoreContents = await readFile(gitIgnorePath, 'utf8')
-    ignorePatterns = parseIgnore.parse(gitIgnoreContents)
-  } catch {
-    // ignore
-  }
-  /* Not ignoring .netlify folder. Add to .gitignore */
-  if (!ignorePatterns || !ignorePatterns.patterns.some((pattern) => /(^|\/|\\)\.netlify($|\/|\\)/.test(pattern))) {
-    log()
-    log('Adding local .netlify folder to .gitignore file...')
-    const newContents = `${gitIgnoreContents}\n${ignoreContent}`
-    await writeFile(gitIgnorePath, newContents, 'utf8')
-  }
-}
+    const gitIgnorePath = path.join(dir, '.gitignore');
+    const ignoreContent = '# Local Netlify folder\n.netlify\n';
+    /* No .gitignore file. Create one and ignore .netlify folder */
+    if (!(await hasGitIgnore(dir))) {
+        await writeFile(gitIgnorePath, ignoreContent, 'utf8');
+        return false;
+    }
+    let gitIgnoreContents;
+    let ignorePatterns;
+    try {
+        gitIgnoreContents = await readFile(gitIgnorePath, 'utf8');
+        ignorePatterns = parseIgnore.parse(gitIgnoreContents);
+    }
+    catch {
+        // ignore
+    }
+    /* Not ignoring .netlify folder. Add to .gitignore */
+    // @ts-expect-error TS(7006) FIXME: Parameter 'pattern' implicitly has an 'any' type.
+    if (!ignorePatterns || !ignorePatterns.patterns.some((pattern) => /(^|\/|\\)\.netlify($|\/|\\)/.test(pattern))) {
+        log();
+        log('Adding local .netlify folder to .gitignore file...');
+        const newContents = `${gitIgnoreContents}\n${ignoreContent}`;
+        await writeFile(gitIgnorePath, newContents, 'utf8');
+    }
+};