netlify-cli 17.3.1 → 17.4.0

package/src/recipes/vscode/index.mjs

@@ -1,106 +1,90 @@
-// @ts-check
-import { join } from 'path'
-
-import { DenoBridge } from '@netlify/edge-bundler'
-import execa from 'execa'
-import inquirer from 'inquirer'
-
-import { NETLIFYDEVLOG, NETLIFYDEVWARN, chalk, error, log } from '../../utils/command-helpers.mjs'
-
-import { applySettings, getSettings, writeSettings } from './settings.mjs'
-
-export const description = 'Create VS Code settings for an optimal experience with Netlify projects'
-
+import { join } from 'path';
+import { DenoBridge } from '@netlify/edge-bundler';
+import execa from 'execa';
+import inquirer from 'inquirer';
+import { NETLIFYDEVLOG, NETLIFYDEVWARN, chalk, error, log } from '../../utils/command-helpers.mjs';
+import { applySettings, getSettings, writeSettings } from './settings.mjs';
+export const description = 'Create VS Code settings for an optimal experience with Netlify projects';
+// @ts-expect-error TS(7031) FIXME: Binding element 'fileExists' implicitly has an 'an... Remove this comment to see the full error message
 const getPrompt = ({ fileExists, path }) => {
-  const formattedPath = chalk.underline(path)
-  const message = fileExists
-    ? `There is a VS Code settings file at ${formattedPath}. Can we update it?`
-    : `A new VS Code settings file will be created at ${formattedPath}`
-
-  return inquirer.prompt({
-    type: 'confirm',
-    name: 'confirm',
-    message,
-    default: true,
-  })
-}
-
-const getEdgeFunctionsPath = ({ config, repositoryRoot }) =>
-  config.build.edge_functions || join(repositoryRoot, 'netlify', 'edge-functions')
-
+    const formattedPath = chalk.underline(path);
+    const message = fileExists
+        ? `There is a VS Code settings file at ${formattedPath}. Can we update it?`
+        : `A new VS Code settings file will be created at ${formattedPath}`;
+    return inquirer.prompt({
+        type: 'confirm',
+        name: 'confirm',
+        message,
+        default: true,
+    });
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'config' implicitly has an 'any' t... Remove this comment to see the full error message
+const getEdgeFunctionsPath = ({ config, repositoryRoot }) => config.build.edge_functions || join(repositoryRoot, 'netlify', 'edge-functions');
 /**
  * @param {string} repositoryRoot
  */
-const getSettingsPath = (repositoryRoot) => join(repositoryRoot, '.vscode', 'settings.json')
-
+// @ts-expect-error TS(7006) FIXME: Parameter 'repositoryRoot' implicitly has an 'any'... Remove this comment to see the full error message
+const getSettingsPath = (repositoryRoot) => join(repositoryRoot, '.vscode', 'settings.json');
 /**
  * @param {string} repositoryRoot
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'repositoryRoot' implicitly has an 'any'... Remove this comment to see the full error message
 const hasDenoVSCodeExt = async (repositoryRoot) => {
-  const { stdout: extensions } = await execa('code', ['--list-extensions'], { stderr: 'inherit', cwd: repositoryRoot })
-  return extensions.split('\n').includes('denoland.vscode-deno')
-}
-
+    const { stdout: extensions } = await execa('code', ['--list-extensions'], { stderr: 'inherit', cwd: repositoryRoot });
+    return extensions.split('\n').includes('denoland.vscode-deno');
+};
 /**
  * @param {string} repositoryRoot
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'repositoryRoot' implicitly has an 'any'... Remove this comment to see the full error message
 const getDenoVSCodeExt = async (repositoryRoot) => {
-  await execa('code', ['--install-extension', 'denoland.vscode-deno'], { stdio: 'inherit', cwd: repositoryRoot })
-}
-
+    await execa('code', ['--install-extension', 'denoland.vscode-deno'], { stdio: 'inherit', cwd: repositoryRoot });
+};
 const getDenoExtPrompt = () => {
-  const message = 'The Deno VS Code extension is recommended. Would you like to install it now?'
-
-  return inquirer.prompt({
-    type: 'confirm',
-    name: 'confirm',
-    message,
-    default: true,
-  })
-}
-
+    const message = 'The Deno VS Code extension is recommended. Would you like to install it now?';
+    return inquirer.prompt({
+        type: 'confirm',
+        name: 'confirm',
+        message,
+        default: true,
+    });
+};
 /**
  * @param {object} params
  * @param {*} params.config
  * @param {string} params.repositoryRoot
  * @returns
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'config' implicitly has an 'any' t... Remove this comment to see the full error message
 export const run = async ({ config, repositoryRoot }) => {
-  const deno = new DenoBridge({
-    onBeforeDownload: () =>
-      log(`${NETLIFYDEVWARN} Setting up the Edge Functions environment. This may take a couple of minutes.`),
-  })
-  const denoBinary = await deno.getBinaryPath()
-  const settingsPath = getSettingsPath(repositoryRoot)
-  const edgeFunctionsPath = getEdgeFunctionsPath({ config, repositoryRoot })
-  const { fileExists, settings: existingSettings } = await getSettings(settingsPath)
-  const settings = applySettings(existingSettings, { denoBinary, edgeFunctionsPath, repositoryRoot })
-  const { confirm } = await getPrompt({ fileExists, path: settingsPath })
-
-  if (!confirm) {
-    return
-  }
-
-  try {
-    if (!(await hasDenoVSCodeExt(repositoryRoot))) {
-      const { confirm: denoExtConfirm } = await getDenoExtPrompt()
-      if (denoExtConfirm) {
-        getDenoVSCodeExt(repositoryRoot)
-      }
+    const deno = new DenoBridge({
+        onBeforeDownload: () => log(`${NETLIFYDEVWARN} Setting up the Edge Functions environment. This may take a couple of minutes.`),
+    });
+    const denoBinary = await deno.getBinaryPath();
+    const settingsPath = getSettingsPath(repositoryRoot);
+    const edgeFunctionsPath = getEdgeFunctionsPath({ config, repositoryRoot });
+    const { fileExists, settings: existingSettings } = await getSettings(settingsPath);
+    const settings = applySettings(existingSettings, { denoBinary, edgeFunctionsPath, repositoryRoot });
+    const { confirm } = await getPrompt({ fileExists, path: settingsPath });
+    if (!confirm) {
+        return;
     }
-  } catch {
-    log(
-      `${NETLIFYDEVWARN} Unable to install Deno VS Code extension. To install it manually, visit ${chalk.blue(
-        'https://ntl.fyi/deno-vscode',
-      )}.`,
-    )
-  }
-
-  try {
-    await writeSettings({ settings, settingsPath })
-
-    log(`${NETLIFYDEVLOG} VS Code settings file ${fileExists ? 'updated' : 'created'}.`)
-  } catch {
-    error('Could not write VS Code settings file.')
-  }
-}
+    try {
+        if (!(await hasDenoVSCodeExt(repositoryRoot))) {
+            const { confirm: denoExtConfirm } = await getDenoExtPrompt();
+            if (denoExtConfirm) {
+                getDenoVSCodeExt(repositoryRoot);
+            }
+        }
+    }
+    catch {
+        log(`${NETLIFYDEVWARN} Unable to install Deno VS Code extension. To install it manually, visit ${chalk.blue('https://ntl.fyi/deno-vscode')}.`);
+    }
+    try {
+        await writeSettings({ settings, settingsPath });
+        log(`${NETLIFYDEVLOG} VS Code settings file ${fileExists ? 'updated' : 'created'}.`);
+    }
+    catch {
+        error('Could not write VS Code settings file.');
+    }
+};

package/src/recipes/vscode/settings.mjs

@@ -1,65 +1,60 @@
-import { mkdir, readFile, stat, writeFile } from 'fs/promises'
-import { dirname, relative } from 'path'
-
+import { mkdir, readFile, stat, writeFile } from 'fs/promises';
+import { dirname, relative } from 'path';
 // eslint-disable-next-line import/no-namespace
-import * as JSONC from 'comment-json'
-import unixify from 'unixify'
-
+import * as JSONC from 'comment-json';
+// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'unix... Remove this comment to see the full error message
+import unixify from 'unixify';
+// @ts-expect-error TS(7006) FIXME: Parameter 'existingSettings' implicitly has an 'an... Remove this comment to see the full error message
 export const applySettings = (existingSettings, { denoBinary, edgeFunctionsPath, repositoryRoot }) => {
-  const relativeEdgeFunctionsPath = unixify(relative(repositoryRoot, edgeFunctionsPath))
-  const settings = JSONC.assign(existingSettings, {
-    'deno.enable': true,
-    'deno.enablePaths': existingSettings['deno.enablePaths'] || [],
-    'deno.unstable': true,
-    'deno.importMap': '.netlify/edge-functions-import-map.json',
-  })
-
-  // If the Edge Functions path isn't already in `deno.enabledPaths`, let's add
-  // it.
-  if (!settings['deno.enablePaths'].includes(relativeEdgeFunctionsPath)) {
-    settings['deno.enablePaths'].push(relativeEdgeFunctionsPath)
-  }
-
-  // If the Deno CLI binary isn't globally installed, we need to set the path
-  // to it in the settings file or the extension won't know where to find it.
-  // The only exception is when `deno.path` has already been defined, because
-  // we don't want to override that.
-  if (!denoBinary.global && settings['deno.path'] === undefined) {
-    settings['deno.path'] = denoBinary.path
-  }
-
-  return settings
-}
-
-export const getSettings = async (settingsPath) => {
-  try {
-    const stats = await stat(settingsPath)
-
-    if (!stats.isFile()) {
-      throw new Error(`${settingsPath} is not a valid file.`)
+    const relativeEdgeFunctionsPath = unixify(relative(repositoryRoot, edgeFunctionsPath));
+    const settings = JSONC.assign(existingSettings, {
+        'deno.enable': true,
+        'deno.enablePaths': existingSettings['deno.enablePaths'] || [],
+        'deno.unstable': true,
+        'deno.importMap': '.netlify/edge-functions-import-map.json',
+    });
+    // If the Edge Functions path isn't already in `deno.enabledPaths`, let's add
+    // it.
+    if (!settings['deno.enablePaths'].includes(relativeEdgeFunctionsPath)) {
+        settings['deno.enablePaths'].push(relativeEdgeFunctionsPath);
     }
-
-    const file = await readFile(settingsPath, 'utf8')
-
-    return {
-      fileExists: true,
-      settings: JSONC.parse(file),
+    // If the Deno CLI binary isn't globally installed, we need to set the path
+    // to it in the settings file or the extension won't know where to find it.
+    // The only exception is when `deno.path` has already been defined, because
+    // we don't want to override that.
+    if (!denoBinary.global && settings['deno.path'] === undefined) {
+        settings['deno.path'] = denoBinary.path;
     }
-  } catch (error) {
-    if (error.code !== 'ENOENT') {
-      throw new Error(`Could not open VS Code settings file: ${error.message}`)
+    return settings;
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'settingsPath' implicitly has an 'any' t... Remove this comment to see the full error message
+export const getSettings = async (settingsPath) => {
+    try {
+        const stats = await stat(settingsPath);
+        if (!stats.isFile()) {
+            throw new Error(`${settingsPath} is not a valid file.`);
+        }
+        const file = await readFile(settingsPath, 'utf8');
+        return {
+            fileExists: true,
+            settings: JSONC.parse(file),
+        };
     }
-
-    return {
-      fileExists: false,
-      settings: {},
+    catch (error) {
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        if (error.code !== 'ENOENT') {
+            // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+            throw new Error(`Could not open VS Code settings file: ${error.message}`);
+        }
+        return {
+            fileExists: false,
+            settings: {},
+        };
     }
-  }
-}
-
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'settings' implicitly has an 'any'... Remove this comment to see the full error message
 export const writeSettings = async ({ settings, settingsPath }) => {
-  const serializedSettings = JSONC.stringify(settings, null, 2)
-
-  await mkdir(dirname(settingsPath), { recursive: true })
-  await writeFile(settingsPath, serializedSettings)
-}
+    const serializedSettings = JSONC.stringify(settings, null, 2);
+    await mkdir(dirname(settingsPath), { recursive: true });
+    await writeFile(settingsPath, serializedSettings);
+};

package/src/utils/addons/compare.mjs

@@ -1,34 +1,33 @@
-import isEqual from 'lodash/isEqual.js'
-
+import isEqual from 'lodash/isEqual.js';
+// @ts-expect-error TS(7006) FIXME: Parameter 'oldValues' implicitly has an 'any' type... Remove this comment to see the full error message
 export default function compare(oldValues, newValues) {
-  const initialData = {
-    // default everything is equal
-    isEqual: true,
-    // Keys that are different
-    keys: [],
-    // Values of the keys that are different
-    diffs: {},
-  }
-
-  const oldKeys = Object.keys(oldValues)
-  const newKeys = Object.keys(newValues)
-  const set = new Set([...newKeys, ...oldKeys])
-
-  return [...set].reduce((acc, current) => {
-    // if values not deep equal. There are changes
-    if (!isEqual(newValues[current], oldValues[current])) {
-      return {
-        isEqual: false,
-        keys: [...acc.keys, current],
-        diffs: {
-          ...acc.diffs,
-          [`${current}`]: {
-            newValue: newValues[current],
-            oldValue: oldValues[current],
-          },
-        },
-      }
-    }
-    return acc
-  }, initialData)
+    const initialData = {
+        // default everything is equal
+        isEqual: true,
+        // Keys that are different
+        keys: [],
+        // Values of the keys that are different
+        diffs: {},
+    };
+    const oldKeys = Object.keys(oldValues);
+    const newKeys = Object.keys(newValues);
+    const set = new Set([...newKeys, ...oldKeys]);
+    // @ts-expect-error TS(2769) FIXME: No overload matches this call.
+    return [...set].reduce((acc, current) => {
+        // if values not deep equal. There are changes
+        if (!isEqual(newValues[current], oldValues[current])) {
+            return {
+                isEqual: false,
+                keys: [...acc.keys, current],
+                diffs: {
+                    ...acc.diffs,
+                    [`${current}`]: {
+                        newValue: newValues[current],
+                        oldValue: oldValues[current],
+                    },
+                },
+            };
+        }
+        return acc;
+    }, initialData);
 }

package/src/utils/addons/diffs/index.mjs

@@ -1,20 +1,19 @@
-// @ts-check
-import concordance from 'concordance'
-
-import { concordanceDiffOptions, concordanceOptions } from './options.mjs'
-
+// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'conc... Remove this comment to see the full error message
+import concordance from 'concordance';
+import { concordanceDiffOptions, concordanceOptions } from './options.mjs';
+// @ts-expect-error TS(7006) FIXME: Parameter 'actualDescriptor' implicitly has an 'an... Remove this comment to see the full error message
 const formatDescriptorDiff = function (actualDescriptor, expectedDescriptor, options) {
-  const diffOptions = { ...options, ...concordanceDiffOptions }
-  return concordance.diffDescriptors(actualDescriptor, expectedDescriptor, diffOptions)
-}
-
+    const diffOptions = { ...options, ...concordanceDiffOptions };
+    return concordance.diffDescriptors(actualDescriptor, expectedDescriptor, diffOptions);
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'actual' implicitly has an 'any' type.
 export default function diffValues(actual, expected) {
-  const result = concordance.compare(actual, expected, concordanceOptions)
-  if (result.pass) {
-    return null
-  }
-  const actualDescriptor = result.actual || concordance.describe(actual, concordanceOptions)
-  const expectedDescriptor = result.expected || concordance.describe(expected, concordanceOptions)
-
-  return formatDescriptorDiff(actualDescriptor, expectedDescriptor)
+    const result = concordance.compare(actual, expected, concordanceOptions);
+    if (result.pass) {
+        return null;
+    }
+    const actualDescriptor = result.actual || concordance.describe(actual, concordanceOptions);
+    const expectedDescriptor = result.expected || concordance.describe(expected, concordanceOptions);
+    // @ts-expect-error TS(2554) FIXME: Expected 3 arguments, but got 2.
+    return formatDescriptorDiff(actualDescriptor, expectedDescriptor);
 }

package/src/utils/addons/diffs/options.mjs

@@ -1,108 +1,106 @@
-// @ts-check
-import ansiStyles from 'ansi-styles'
+import ansiStyles from 'ansi-styles';
 // eslint-disable-next-line no-restricted-imports
-import { Chalk } from 'chalk'
-
-const forceColor = new Chalk({ level: 1 })
-
+import { Chalk } from 'chalk';
+const forceColor = new Chalk({ level: 1 });
 const colorTheme = {
-  boolean: ansiStyles.yellow,
-  circular: forceColor.grey('[Circular]'),
-  date: {
-    invalid: forceColor.red('invalid'),
-    value: ansiStyles.blue,
-  },
-  diffGutters: {
-    actual: `${forceColor.red('-')} `,
-    expected: `${forceColor.green('+')} `,
-    padding: '  ',
-  },
-  error: {
-    ctor: {
-      open: `${ansiStyles.grey.open}(`,
-      close: `)${ansiStyles.grey.close}`,
+    boolean: ansiStyles.yellow,
+    circular: forceColor.grey('[Circular]'),
+    date: {
+        invalid: forceColor.red('invalid'),
+        value: ansiStyles.blue,
     },
-    name: ansiStyles.magenta,
-  },
-  function: {
-    name: ansiStyles.blue,
-    stringTag: ansiStyles.magenta,
-  },
-  global: ansiStyles.magenta,
-  item: {
-    after: forceColor.grey(','),
-  },
-  list: {
-    openBracket: forceColor.grey('['),
-    closeBracket: forceColor.grey(']'),
-  },
-  mapEntry: {
-    after: forceColor.grey(','),
-  },
-  maxDepth: forceColor.grey('…'),
-  null: ansiStyles.yellow,
-  number: ansiStyles.yellow,
-  object: {
-    openBracket: forceColor.grey('{'),
-    closeBracket: forceColor.grey('}'),
-    ctor: ansiStyles.magenta,
-    stringTag: {
-      open: `${ansiStyles.magenta.open}@`,
-      close: ansiStyles.magenta.close,
+    diffGutters: {
+        actual: `${forceColor.red('-')} `,
+        expected: `${forceColor.green('+')} `,
+        padding: '  ',
     },
-    secondaryStringTag: {
-      open: `${ansiStyles.grey.open}@`,
-      close: ansiStyles.grey.close,
+    error: {
+        ctor: {
+            open: `${ansiStyles.grey.open}(`,
+            close: `)${ansiStyles.grey.close}`,
+        },
+        name: ansiStyles.magenta,
     },
-  },
-  property: {
-    after: forceColor.grey(','),
-    keyBracket: { open: forceColor.grey('['), close: forceColor.grey(']') },
-    valueFallback: forceColor.grey('…'),
-  },
-  regexp: {
-    source: {
-      open: `${ansiStyles.blue.open}/`,
-      close: `/${ansiStyles.blue.close}`,
+    function: {
+        name: ansiStyles.blue,
+        stringTag: ansiStyles.magenta,
     },
-    flags: ansiStyles.yellow,
-  },
-  stats: { separator: forceColor.grey('---') },
-  string: {
-    open: ansiStyles.white.open,
-    close: ansiStyles.white.close,
-    line: { open: forceColor.white("'"), close: forceColor.white("'") },
-    multiline: { start: forceColor.white('`'), end: forceColor.white('`') },
-    controlPicture: ansiStyles.grey,
-    diff: {
-      insert: {
-        open: ansiStyles.bgGreen.open + ansiStyles.black.open,
-        close: ansiStyles.black.close + ansiStyles.bgGreen.close,
-      },
-      delete: {
-        open: ansiStyles.bgRed.open + ansiStyles.black.open,
-        close: ansiStyles.black.close + ansiStyles.bgRed.close,
-      },
-      equal: ansiStyles.white,
-      insertLine: {
-        open: ansiStyles.green.open,
-        close: ansiStyles.green.close,
-      },
-      deleteLine: {
-        open: ansiStyles.red.open,
-        close: ansiStyles.red.close,
-      },
+    global: ansiStyles.magenta,
+    item: {
+        after: forceColor.grey(','),
     },
-  },
-  symbol: ansiStyles.yellow,
-  typedArray: {
-    bytes: ansiStyles.yellow,
-  },
-  undefined: ansiStyles.yellow,
-}
-
-const plugins = []
-const theme = colorTheme
-
-export const concordanceOptions = { maxDepth: 3, plugins, theme }
-export const concordanceDiffOptions = { maxDepth: 1, plugins, theme }
+    list: {
+        openBracket: forceColor.grey('['),
+        closeBracket: forceColor.grey(']'),
+    },
+    mapEntry: {
+        after: forceColor.grey(','),
+    },
+    maxDepth: forceColor.grey('…'),
+    null: ansiStyles.yellow,
+    number: ansiStyles.yellow,
+    object: {
+        openBracket: forceColor.grey('{'),
+        closeBracket: forceColor.grey('}'),
+        ctor: ansiStyles.magenta,
+        stringTag: {
+            open: `${ansiStyles.magenta.open}@`,
+            close: ansiStyles.magenta.close,
+        },
+        secondaryStringTag: {
+            open: `${ansiStyles.grey.open}@`,
+            close: ansiStyles.grey.close,
+        },
+    },
+    property: {
+        after: forceColor.grey(','),
+        keyBracket: { open: forceColor.grey('['), close: forceColor.grey(']') },
+        valueFallback: forceColor.grey('…'),
+    },
+    regexp: {
+        source: {
+            open: `${ansiStyles.blue.open}/`,
+            close: `/${ansiStyles.blue.close}`,
+        },
+        flags: ansiStyles.yellow,
+    },
+    stats: { separator: forceColor.grey('---') },
+    string: {
+        open: ansiStyles.white.open,
+        close: ansiStyles.white.close,
+        line: { open: forceColor.white("'"), close: forceColor.white("'") },
+        multiline: { start: forceColor.white('`'), end: forceColor.white('`') },
+        controlPicture: ansiStyles.grey,
+        diff: {
+            insert: {
+                open: ansiStyles.bgGreen.open + ansiStyles.black.open,
+                close: ansiStyles.black.close + ansiStyles.bgGreen.close,
+            },
+            delete: {
+                open: ansiStyles.bgRed.open + ansiStyles.black.open,
+                close: ansiStyles.black.close + ansiStyles.bgRed.close,
+            },
+            equal: ansiStyles.white,
+            insertLine: {
+                open: ansiStyles.green.open,
+                close: ansiStyles.green.close,
+            },
+            deleteLine: {
+                open: ansiStyles.red.open,
+                close: ansiStyles.red.close,
+            },
+        },
+    },
+    symbol: ansiStyles.yellow,
+    typedArray: {
+        bytes: ansiStyles.yellow,
+    },
+    undefined: ansiStyles.yellow,
+};
+// @ts-expect-error TS(7034) FIXME: Variable 'plugins' implicitly has type 'any[]' in ... Remove this comment to see the full error message
+const plugins = [];
+const theme = colorTheme;
+// @ts-expect-error TS(7005) FIXME: Variable 'plugins' implicitly has an 'any[]' type.
+export const concordanceOptions = { maxDepth: 3, plugins, theme };
+// @ts-expect-error TS(7005) FIXME: Variable 'plugins' implicitly has an 'any[]' type.
+export const concordanceDiffOptions = { maxDepth: 1, plugins, theme };