feat: add kebab-case options to cli flags - first example

Author: khendrikse

src/commands/addons/addons.mjs

@@ -30,7 +30,6 @@ export const createAddonsCommand = (program) => {
     .command('addons')
     .alias('addon')
     .description('(Beta) Manage Netlify Add-ons')
-    .noHelpOptions()
     .addExamples([
       'netlify addons:create addon-xyz',
       'netlify addons:list',

src/commands/base-command.mjs

@@ -25,6 +25,11 @@ import {
 } from '../utils/command-helpers.mjs'
 import getGlobalConfig from '../utils/get-global-config.mjs'
 import openBrowser from '../utils/open-browser.mjs'
+import {
+  warnForDeprecatedOptions,
+  deprecatedArgParser,
+  returnDeprecatedOptionValue,
+} from '../utils/option-deprecation.mjs'
 import StateConfig from '../utils/state-config.mjs'
 import { identify, track } from '../utils/telemetry/index.mjs'
 
@@ -99,13 +104,20 @@ export default class BaseCommand extends Command {
         .addOption(new Option('--cwd <cwd>').hideHelp(true))
         .addOption(new Option('-o, --offline').hideHelp(true))
         .addOption(new Option('--auth <token>', 'Netlify auth token').hideHelp(true))
+        // TODO v13: remove this deprecated command
+        .addOption(
+          new Option('--httpProxy [address]', '[DEPRECATED IN V13] Proxy server address to route requests through.')
+            .default(process.env.HTTP_PROXY || process.env.HTTPS_PROXY)
+            .hideHelp(true)
+            .argParser(deprecatedArgParser),
+        )
         .option(
           '--httpProxyCertificateFilename [file]',
           'Certificate file to use when connecting using a proxy server',
           process.env.NETLIFY_PROXY_CERTIFICATE_FILENAME,
         )
         .option(
-          '--httpProxy [address]',
+          '--http-proxy [address]',
           'Proxy server address to route requests through.',
           process.env.HTTP_PROXY || process.env.HTTPS_PROXY,
         )
@@ -117,6 +129,11 @@ export default class BaseCommand extends Command {
           await this.init(actionCommand)
           debug(`${name}:preAction`)('end')
         })
+        .hook('preAction', (parentCommand) => {
+          const options = parentCommand.opts()
+          if (!options) return
+          warnForDeprecatedOptions(options)
+        })
     )
   }
 
@@ -419,8 +436,9 @@ export default class BaseCommand extends Command {
     const cachedConfig = await actionCommand.getConfig({ cwd, state, token, ...apiUrlOpts })
     const { buildDir, config, configPath, repositoryRoot, siteInfo } = cachedConfig
     const normalizedConfig = normalizeConfig(config)
+
     const agent = await getAgent({
-      httpProxy: options.httpProxy,
+      httpProxy: returnDeprecatedOptionValue(options.httpProxy),
       certificateFile: options.httpProxyCertificateFilename,
     })
     const apiOpts = { ...apiUrlOpts, agent }

src/utils/option-deprecation.mjs

@@ -0,0 +1,30 @@
+import { chalk, log, NETLIFYDEVWARN } from './command-helpers.mjs'
+
+// This file contains logic for flags in camelcase that will be deprecated in v13 and replaced in kebab-case.
+// Flags to be deprecated in v13
+const DEPRECATED_OPTIONS = {
+  httpProxy: { option: '--httpProxy', newOption: '--http-proxy', deprecatedVersion: 'v13' },
+}
+
+export const deprecatedArgParser = (value) => ({
+  value,
+  deprecationWarn: true,
+})
+
+// TODO v13: remove all uses of this function in the code so they can fall back on just using `option` instead of `option.value`
+export const returnDeprecatedOptionValue = (option) => (option.value ? option.value : option)
+
+export const warnForDeprecatedOptions = (options) => {
+  Object.entries(options).forEach(([option, value]) => {
+    const deprecatedOption = DEPRECATED_OPTIONS[option]
+
+    if (value.deprecationWarn && deprecatedOption) {
+      log(
+        NETLIFYDEVWARN,
+        chalk.yellowBright(
+          `The flag ${deprecatedOption.option} is replaced by ${deprecatedOption.newOption} and will be deprecated in ${deprecatedOption.deprecatedVersion}`,
+        ),
+      )
+    }
+  })
+}