netlify-cli 17.3.1 → 17.4.0

package/src/utils/addons/prepare.mjs

@@ -1,85 +1,90 @@
-// @ts-check
-import { chalk, error, exit, log, warn } from '../command-helpers.mjs'
-
+import { chalk, error, exit, log, warn } from '../command-helpers.mjs';
 export const ADDON_VALIDATION = {
-  EXISTS: 'EXISTS',
-  NOT_EXISTS: 'NOT_EXISTS',
-}
-
+    EXISTS: 'EXISTS',
+    NOT_EXISTS: 'NOT_EXISTS',
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'addon' implicitly has an 'any' ty... Remove this comment to see the full error message
 const validateExists = ({ addon, addonName, siteData }) => {
-  if (!addon || !addon.id) {
-    log(`Add-on ${addonName} doesn't exist for ${siteData.name}`)
-    log(`> Run \`netlify addons:create ${addonName}\` to create an instance for this site`)
-    exit(1)
-  }
-}
-
-const validateNotExists = ({ addon, addonName, siteData }) => {
-  if (addon && addon.id) {
-    log(`The "${addonName} add-on" already exists for ${siteData.name}`)
-    log()
-    const cmd = chalk.cyan(`\`netlify addons:config ${addonName}\``)
-    log(`- To update this add-on run: ${cmd}`)
-    const deleteCmd = chalk.cyan(`\`netlify addons:delete ${addonName}\``)
-    log(`- To remove this add-on run: ${deleteCmd}`)
-    log()
-    exit(1)
-  }
-}
-
-export const getCurrentAddon = ({ addonName, addons }) => addons.find((addon) => addon.service_slug === addonName)
-
-const validateCurrentAddon = ({ addon, addonName, siteData, validation }) => {
-  switch (validation) {
-    case ADDON_VALIDATION.EXISTS: {
-      validateExists({ addon, addonName, siteData })
-      break
+    if (!addon || !addon.id) {
+        log(`Add-on ${addonName} doesn't exist for ${siteData.name}`);
+        log(`> Run \`netlify addons:create ${addonName}\` to create an instance for this site`);
+        exit(1);
     }
-    case ADDON_VALIDATION.NOT_EXISTS: {
-      validateNotExists({ addon, addonName, siteData })
-      break
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'addon' implicitly has an 'any' ty... Remove this comment to see the full error message
+const validateNotExists = ({ addon, addonName, siteData }) => {
+    if (addon && addon.id) {
+        log(`The "${addonName} add-on" already exists for ${siteData.name}`);
+        log();
+        const cmd = chalk.cyan(`\`netlify addons:config ${addonName}\``);
+        log(`- To update this add-on run: ${cmd}`);
+        const deleteCmd = chalk.cyan(`\`netlify addons:delete ${addonName}\``);
+        log(`- To remove this add-on run: ${deleteCmd}`);
+        log();
+        exit(1);
     }
-    default: {
-      warn(`Unknown addons validation: ${validation}`)
-      break
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'addonName' implicitly has an 'any... Remove this comment to see the full error message
+export const getCurrentAddon = ({ addonName, addons }) => addons.find((addon) => addon.service_slug === addonName);
+// @ts-expect-error TS(7031) FIXME: Binding element 'addon' implicitly has an 'any' ty... Remove this comment to see the full error message
+const validateCurrentAddon = ({ addon, addonName, siteData, validation }) => {
+    switch (validation) {
+        case ADDON_VALIDATION.EXISTS: {
+            validateExists({ addon, addonName, siteData });
+            break;
+        }
+        case ADDON_VALIDATION.NOT_EXISTS: {
+            validateNotExists({ addon, addonName, siteData });
+            break;
+        }
+        default: {
+            warn(`Unknown addons validation: ${validation}`);
+            break;
+        }
     }
-  }
-}
-
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'addonName' implicitly has an 'any... Remove this comment to see the full error message
 export const getAddonManifest = async ({ addonName, api }) => {
-  let manifest
-  try {
-    manifest = await api.showServiceManifest({ addonName })
-  } catch (error_) {
-    if (typeof error_.message === 'string' && error_.message.includes('Not Found')) {
-      error(`No add-on "${addonName}" found. Please double check your add-on name and try again`)
-    } else {
-      error(error_.message)
+    let manifest;
+    try {
+        manifest = await api.showServiceManifest({ addonName });
+    }
+    catch (error_) {
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        if (typeof error_.message === 'string' && error_.message.includes('Not Found')) {
+            error(`No add-on "${addonName}" found. Please double check your add-on name and try again`);
+        }
+        else {
+            // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+            error(error_.message);
+        }
     }
-  }
-  return manifest
-}
-
+    return manifest;
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
 export const getSiteData = async ({ api, siteId }) => {
-  let siteData
-  try {
-    siteData = await api.getSite({ siteId })
-  } catch (error_) {
-    error(`Failed getting list of site data: ${error_.message}`)
-  }
-  return siteData
-}
-
+    let siteData;
+    try {
+        siteData = await api.getSite({ siteId });
+    }
+    catch (error_) {
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        error(`Failed getting list of site data: ${error_.message}`);
+    }
+    return siteData;
+};
+// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
 export const getAddons = async ({ api, siteId }) => {
-  let addons
-  try {
-    addons = await api.listServiceInstancesForSite({ siteId })
-  } catch (error_) {
-    error(`Failed getting list of addons: ${error_.message}`)
-  }
-  return addons
-}
-
+    let addons;
+    try {
+        addons = await api.listServiceInstancesForSite({ siteId });
+    }
+    catch (error_) {
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        error(`Failed getting list of addons: ${error_.message}`);
+    }
+    return addons;
+};
 /**
  *
  * @param {object} config
@@ -87,28 +92,26 @@ export const getAddons = async ({ api, siteId }) => {
  * @param {string} [config.addonName]
  * @param {keyof ADDON_VALIDATION} [config.validation]
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'addonName' implicitly has an 'any... Remove this comment to see the full error message
 export const prepareAddonCommand = async ({ addonName, command, validation }) => {
-  const { netlify } = command
-  const { api, site } = netlify
-  const siteId = site.id
-  if (!siteId) {
-    error('No site id found, please run inside a site folder or `netlify link`')
-  }
-
-  await command.authenticate()
-
-  const [manifest, siteData, addons] = await Promise.all([
-    // TODO: check as `getAddonManifest` did not accept a parameter error
-    addonName ? getAddonManifest({ api, addonName, error }) : Promise.resolve(),
-    getSiteData({ api, siteId }),
-    getAddons({ api, siteId }),
-  ])
-
-  let addon
-  if (addonName) {
-    addon = getCurrentAddon({ addons, addonName })
-    validateCurrentAddon({ addon, validation, addonName, siteData })
-  }
-
-  return { manifest, addons, addon, siteData }
-}
+    const { netlify } = command;
+    const { api, site } = netlify;
+    const siteId = site.id;
+    if (!siteId) {
+        error('No site id found, please run inside a site folder or `netlify link`');
+    }
+    await command.authenticate();
+    const [manifest, siteData, addons] = await Promise.all([
+        // TODO: check as `getAddonManifest` did not accept a parameter error
+        // @ts-expect-error TS(2345) FIXME: Argument of type '{ api: any; addonName: any; erro... Remove this comment to see the full error message
+        addonName ? getAddonManifest({ api, addonName, error }) : Promise.resolve(),
+        getSiteData({ api, siteId }),
+        getAddons({ api, siteId }),
+    ]);
+    let addon;
+    if (addonName) {
+        addon = getCurrentAddon({ addons, addonName });
+        validateCurrentAddon({ addon, validation, addonName, siteData });
+    }
+    return { manifest, addons, addon, siteData };
+};

package/src/utils/addons/prompts.mjs

@@ -1,78 +1,74 @@
-// @ts-check
-import { chalk } from '../command-helpers.mjs'
-
+import { chalk } from '../command-helpers.mjs';
 /* programmatically generate CLI prompts */
+// @ts-expect-error TS(7006) FIXME: Parameter 'settings' implicitly has an 'any' type.
 export default function generatePrompts(settings) {
-  const { config, configValues } = settings
-  const configItems = Object.keys(config)
-
-  return configItems
-    .map((key, index) => {
-      const setting = config[key]
-      // const { type, displayName } = setting
-      let prompt
-      // Tell user to use types
-      if (!setting.type) {
-        console.log(`⚠️   ${chalk.yellowBright(`Warning: no \`type\` is set for config key: ${configItems[index]}`)}`)
-        console.log(
-          `It's highly recommended that you type your configuration values. It will help with automatic documentation, sharing of your services, and make your services configurable through a GUI`,
-        )
-        console.log('')
-      }
-
-      // Handle shorthand config. Probably will be removed. Severely limited + not great UX
-      if (typeof setting === 'string' || typeof setting === 'boolean') {
-        if (typeof setting === 'string') {
-          prompt = {
-            type: 'input',
-            name: key,
-            message: `Enter string value for '${key}':`,
-          }
-          // if current stage value set show as default
-          if (configValues[key]) {
-            prompt.default = configValues[key]
-          }
-        } else if (typeof setting === 'boolean') {
-          prompt = {
-            type: 'confirm',
-            name: key,
-            message: `Do you want '${key}':`,
-          }
+    const { config, configValues } = settings;
+    const configItems = Object.keys(config);
+    return configItems
+        .map((key, index) => {
+        const setting = config[key];
+        // const { type, displayName } = setting
+        let prompt;
+        // Tell user to use types
+        if (!setting.type) {
+            console.log(`⚠️   ${chalk.yellowBright(`Warning: no \`type\` is set for config key: ${configItems[index]}`)}`);
+            console.log(`It's highly recommended that you type your configuration values. It will help with automatic documentation, sharing of your services, and make your services configurable through a GUI`);
+            console.log('');
         }
-        return prompt
-      }
-
-      // For future use. Once UX is decided
-      // const defaultValidation = (setting.required) ? validateRequired : noValidate
-      const defaultValidation = noValidate
-      const validateFunction = setting.pattern ? validate(setting.pattern) : defaultValidation
-      const isRequiredText = setting.required ? ` (${chalk.yellow('required')})` : ''
-      if (setting.type === 'string' || /string/.test(setting.type)) {
-        prompt = {
-          type: 'input',
-          name: key,
-          message: `${chalk.white(key)}${isRequiredText} - ${setting.displayName}` || `Please enter value for ${key}`,
-          validate: validateFunction,
+        // Handle shorthand config. Probably will be removed. Severely limited + not great UX
+        if (typeof setting === 'string' || typeof setting === 'boolean') {
+            if (typeof setting === 'string') {
+                prompt = {
+                    type: 'input',
+                    name: key,
+                    message: `Enter string value for '${key}':`,
+                };
+                // if current stage value set show as default
+                if (configValues[key]) {
+                    // @ts-expect-error TS(2339) FIXME: Property 'default' does not exist on type '{ type:... Remove this comment to see the full error message
+                    prompt.default = configValues[key];
+                }
+            }
+            else if (typeof setting === 'boolean') {
+                prompt = {
+                    type: 'confirm',
+                    name: key,
+                    message: `Do you want '${key}':`,
+                };
+            }
+            return prompt;
         }
-        // if value previously set show it
-        if (configValues[key]) {
-          prompt.default = configValues[key]
-          // else show default value if provided
-        } else if (setting.default) {
-          prompt.default = setting.default
+        // For future use. Once UX is decided
+        // const defaultValidation = (setting.required) ? validateRequired : noValidate
+        const defaultValidation = noValidate;
+        const validateFunction = setting.pattern ? validate(setting.pattern) : defaultValidation;
+        const isRequiredText = setting.required ? ` (${chalk.yellow('required')})` : '';
+        if (setting.type === 'string' || /string/.test(setting.type)) {
+            prompt = {
+                type: 'input',
+                name: key,
+                message: `${chalk.white(key)}${isRequiredText} - ${setting.displayName}` || `Please enter value for ${key}`,
+                validate: validateFunction,
+            };
+            // if value previously set show it
+            if (configValues[key]) {
+                // @ts-expect-error TS(2339) FIXME: Property 'default' does not exist on type '{ type:... Remove this comment to see the full error message
+                prompt.default = configValues[key];
+                // else show default value if provided
+            }
+            else if (setting.default) {
+                // @ts-expect-error TS(2339) FIXME: Property 'default' does not exist on type '{ type:... Remove this comment to see the full error message
+                prompt.default = setting.default;
+            }
+            return prompt;
         }
-        return prompt
-      }
-
-      return false
+        return false;
     })
-    .filter(Boolean)
+        .filter(Boolean);
 }
-
 const noValidate = function () {
-  return true
-}
-
+    return true;
+};
 // Will use this soon
 // function validateRequired(value) {
 //   // eslint-disable-line
@@ -81,13 +77,14 @@ const noValidate = function () {
 //   }
 //   return `Please enter a value this field is required`
 // }
-
+// @ts-expect-error TS(7006) FIXME: Parameter 'pattern' implicitly has an 'any' type.
 const validate = function (pattern) {
-  return function validateValue(value) {
-    const regex = new RegExp(pattern)
-    if (regex.test(value)) {
-      return true
-    }
-    return `Please enter a value matching regex pattern: /${chalk.yellowBright(pattern)}/`
-  }
-}
+    // @ts-expect-error TS(7006) FIXME: Parameter 'value' implicitly has an 'any' type.
+    return function validateValue(value) {
+        const regex = new RegExp(pattern);
+        if (regex.test(value)) {
+            return true;
+        }
+        return `Please enter a value matching regex pattern: /${chalk.yellowBright(pattern)}/`;
+    };
+};

package/src/utils/addons/render.mjs

@@ -1,39 +1,36 @@
-// @ts-check
-import AsciiTable from 'ascii-table'
-
-import { chalk } from '../command-helpers.mjs'
-
+import AsciiTable from 'ascii-table';
+import { chalk } from '../command-helpers.mjs';
+// @ts-expect-error TS(7006) FIXME: Parameter 'values' implicitly has an 'any' type.
 export const renderMissingValues = function (values, manifest) {
-  const display = values
-    .map((item) => {
-      const itemDisplay = chalk.redBright.bold(`${item}`)
-      const niceNameDisplay = manifest.config[item].displayName
-      return ` - ${itemDisplay} ${niceNameDisplay}`
+    const display = values
+        // @ts-expect-error TS(7006) FIXME: Parameter 'item' implicitly has an 'any' type.
+        .map((item) => {
+        const itemDisplay = chalk.redBright.bold(`${item}`);
+        const niceNameDisplay = manifest.config[item].displayName;
+        return ` - ${itemDisplay} ${niceNameDisplay}`;
     })
-    .join('\n')
-  console.log(display)
-}
-
+        .join('\n');
+    console.log(display);
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'addonName' implicitly has an 'any' type... Remove this comment to see the full error message
 export const renderConfigValues = function (addonName, values, currentValue) {
-  const table = new AsciiTable(`${addonName} add-on settings`)
-
-  const tableHeader = currentValue
-    ? ['Setting Name', 'Current Value', 'Description']
-    : ['Setting Name', 'Description', 'Type', 'Required']
-
-  table.setHeading(...tableHeader)
-
-  Object.keys(values).forEach((key) => {
-    const { displayName, required, type } = values[key]
-    const requiredText = required ? `true` : `false`
-    const typeInfo = type || ''
-    const description = displayName || ''
-    if (currentValue) {
-      const value = currentValue[key] || 'Not supplied'
-      table.addRow(key, value, description)
-    } else {
-      table.addRow(key, description, typeInfo, requiredText)
-    }
-  })
-  console.log(table.toString())
-}
+    const table = new AsciiTable(`${addonName} add-on settings`);
+    const tableHeader = currentValue
+        ? ['Setting Name', 'Current Value', 'Description']
+        : ['Setting Name', 'Description', 'Type', 'Required'];
+    table.setHeading(...tableHeader);
+    Object.keys(values).forEach((key) => {
+        const { displayName, required, type } = values[key];
+        const requiredText = required ? `true` : `false`;
+        const typeInfo = type || '';
+        const description = displayName || '';
+        if (currentValue) {
+            const value = currentValue[key] || 'Not supplied';
+            table.addRow(key, value, description);
+        }
+        else {
+            table.addRow(key, description, typeInfo, requiredText);
+        }
+    });
+    console.log(table.toString());
+};

package/src/utils/addons/validation.mjs

@@ -1,18 +1,22 @@
+// @ts-expect-error TS(7006) FIXME: Parameter 'config' implicitly has an 'any' type.
 export const requiredConfigValues = function (config) {
-  return Object.keys(config).filter((key) => config[key].required)
-}
-
+    return Object.keys(config).filter((key) => config[key].required);
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'requiredConfig' implicitly has an 'any'... Remove this comment to see the full error message
 export const missingConfigValues = function (requiredConfig, providedConfig) {
-  return requiredConfig.filter((key) => !providedConfig[key])
-}
-
+    // @ts-expect-error TS(7006) FIXME: Parameter 'key' implicitly has an 'any' type.
+    return requiredConfig.filter((key) => !providedConfig[key]);
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'allowedConfig' implicitly has an 'any' ... Remove this comment to see the full error message
 export const updateConfigValues = function (allowedConfig, currentConfig, newConfig) {
-  return Object.keys(allowedConfig).reduce((acc, key) => {
-    if (newConfig[key]) {
-      acc[key] = newConfig[key]
-      return acc
-    }
-    acc[key] = currentConfig[key]
-    return acc
-  }, {})
-}
+    return Object.keys(allowedConfig).reduce((acc, key) => {
+        if (newConfig[key]) {
+            // @ts-expect-error TS(7053) FIXME: Element implicitly has an 'any' type because expre... Remove this comment to see the full error message
+            acc[key] = newConfig[key];
+            return acc;
+        }
+        // @ts-expect-error TS(7053) FIXME: Element implicitly has an 'any' type because expre... Remove this comment to see the full error message
+        acc[key] = currentConfig[key];
+        return acc;
+    }, {});
+};

package/src/utils/banner.mjs

@@ -1,17 +1,12 @@
-// @ts-check
-import boxen from 'boxen'
-
-import { chalk, log, NETLIFYDEVLOG } from './command-helpers.mjs'
-
+import boxen from 'boxen';
+import { chalk, log, NETLIFYDEVLOG } from './command-helpers.mjs';
+// @ts-expect-error TS(7031) FIXME: Binding element 'url' implicitly has an 'any' type... Remove this comment to see the full error message
 export const printBanner = ({ url }) => {
-  const banner = chalk.bold(`${NETLIFYDEVLOG} Server now ready on ${url}`)
-
-  log(
-    boxen(banner, {
-      padding: 1,
-      margin: 1,
-      align: 'center',
-      borderColor: '#00c7b7',
-    }),
-  )
-}
+    const banner = chalk.bold(`${NETLIFYDEVLOG} Server now ready on ${url}`);
+    log(boxen(banner, {
+        padding: 1,
+        margin: 1,
+        align: 'center',
+        borderColor: '#00c7b7',
+    }));
+};