feat!: remove deprecated camelCase option variants (#7046)

* feat!: remove deprecated camelCase options

These commands option have been deprecated since 12.8.0 (25 months ago):
https://github.com/netlify/cli/releases/tag/v12.8.0.

Removes:
- `--httpProxyCertificateFilename`
- `--prodIfUnlocked`
- `--functionsPort`
- `--targetPort`
- `--edgeInspect`
- `--edgeInspectBrk`
- `--replaceExisting`
- `--gitRemoteName`

The change in 12.8.0 also intended to rename `--httpProxy` to `--http-proxy` but there was a typo resulting in that
never happening. To err on the safe side, this fixes that change without removing the camel case variant yet.

* fix: update references to renamed options

* feat!: rename `--httpProxy` to `--http-proxy`

This was not a documented option, so this is arguably not breaking, but marking as
breaking to err on the side of caution.

Author: serhalp

src/commands/base-command.ts

@@ -191,18 +191,10 @@ export default class BaseCommand extends Command {
       .addOption(new Option('-o, --offline').hideHelp(true))
       .addOption(new Option('--auth <token>', 'Netlify auth token').hideHelp(true))
       .addOption(
-        new Option('--httpProxy [address]', 'Old, prefer --http-proxy. Proxy server address to route requests through.')
+        new Option('--http-proxy [address]', 'Proxy server address to route requests through.')
           .default(process.env.HTTP_PROXY || process.env.HTTPS_PROXY)
           .hideHelp(true),
       )
-      .addOption(
-        new Option(
-          '--httpProxyCertificateFilename [file]',
-          'Old, prefer --http-proxy-certificate-filename. Certificate file to use when connecting using a proxy server.',
-        )
-          .default(process.env.NETLIFY_PROXY_CERTIFICATE_FILENAME)
-          .hideHelp(true),
-      )
       .addOption(
         new Option(
           '--http-proxy-certificate-filename [file]',
@@ -211,11 +203,6 @@ export default class BaseCommand extends Command {
           .default(process.env.NETLIFY_PROXY_CERTIFICATE_FILENAME)
           .hideHelp(true),
       )
-      .addOption(
-        new Option('--httpProxy [address]', 'Proxy server address to route requests through.')
-          .default(process.env.HTTP_PROXY || process.env.HTTPS_PROXY)
-          .hideHelp(true),
-      )
       .option('--debug', 'Print debugging information')
 
     // only add the `--filter` option to commands that are workspace aware

src/commands/deploy/index.ts

@@ -80,18 +80,15 @@ Support for package.json's main field, and intrinsic index.js entrypoints are co
     .option('-d, --dir <path>', 'Specify a folder to deploy')
     .option('-f, --functions <folder>', 'Specify a functions folder to deploy')
     .addOption(
-      new Option('-p, --prod', 'Deploy to production').default(false).conflicts(['alias', 'branch', 'prodIfUnlocked']),
+      new Option('-p, --prod', 'Deploy to production')
+        .default(false)
+        .conflicts(['alias', 'branch', 'prod-if-unlocked']),
     )
     .addOption(
-      new Option(
-        '--prodIfUnlocked',
-        'Old, prefer --prod-if-unlocked. Deploy to production if unlocked, create a draft otherwise',
-      )
+      new Option('--prod-if-unlocked', 'Deploy to production if unlocked, create a draft otherwise')
         .default(false)
-        .hideHelp(true)
         .conflicts(['alias', 'branch', 'prod']),
     )
-    .option('--prod-if-unlocked', 'Deploy to production if unlocked, create a draft otherwise', false)
     .option(
       '--alias <name>',
       'Specifies the alias for deployment, the string at the beginning of the deploy subdomain. Useful for creating predictable deployment URLs. Avoid setting an alias string to the same value as a deployed branch. `alias` doesn’t create a branch deploy and can’t be used in conjunction with the branch subdomain feature. Maximum 37 characters.',

src/commands/dev/dev.ts

@@ -266,11 +266,6 @@ export const createDevCommand = (program: BaseCommand) => {
       normalizeContext,
     )
     .option('-p ,--port <port>', 'port of netlify dev', (value) => Number.parseInt(value))
-    .addOption(
-      new Option('--targetPort <port>', 'Old, prefer --target-port. Port of target app server')
-        .argParser((value) => Number.parseInt(value))
-        .hideHelp(true),
-    )
     .addOption(new Option('--skip-wait-port', 'disables waiting for target port to become available').hideHelp(true))
     .addOption(new Option('--no-open', 'disables the automatic opening of a browser window'))
     .option('--target-port <port>', 'port of target app server', (value) => Number.parseInt(value))
@@ -292,11 +287,6 @@ export const createDevCommand = (program: BaseCommand) => {
       'start a public live session; optionally, supply a subdomain to generate a custom URL',
       false,
     )
-    .addOption(
-      new Option('--functionsPort <port>', 'Old, prefer --functions-port. Port of functions server')
-        .argParser((value) => Number.parseInt(value))
-        .hideHelp(true),
-    )
     .option('--functions-port <port>', 'port of functions server', (value) => Number.parseInt(value))
     .addOption(
       new Option(
@@ -317,15 +307,6 @@ export const createDevCommand = (program: BaseCommand) => {
         .argParser((value) => Number.parseInt(value))
         .hideHelp(),
     )
-    .addOption(
-      new Option(
-        '-e, --edgeInspect [address]',
-        'Old, prefer --edge-inspect. Enable the V8 Inspector Protocol for Edge Functions, with an optional address in the host:port format',
-      )
-        .conflicts('edgeInspectBrk')
-        .argParser(validateShortFlagArgs)
-        .hideHelp(true),
-    )
     .addOption(
       new Option(
         '-e, --edge-inspect [address]',
@@ -334,15 +315,6 @@ export const createDevCommand = (program: BaseCommand) => {
         .conflicts('edgeInspectBrk')
         .argParser(validateShortFlagArgs),
     )
-    .addOption(
-      new Option(
-        '-E, --edgeInspectBrk [address]',
-        'Old, prefer --edge-inspect-brk. Enable the V8 Inspector Protocol for Edge Functions and pause execution on the first line of code, with an optional address in the host:port format',
-      )
-        .conflicts('edgeInspect')
-        .hideHelp(true)
-        .argParser(validateShortFlagArgs),
-    )
     .addOption(
       new Option(
         '-E, --edge-inspect-brk [address]',

src/commands/env/env.ts

@@ -37,14 +37,6 @@ export const createEnvCommand = (program: BaseCommand) => {
   program
     .command('env:import')
     .argument('<fileName>', '.env file to import')
-    .addOption(
-      new Option(
-        '-r --replaceExisting',
-        'Old, prefer --replace-existing. Replace all existing variables instead of merging them with the current ones',
-      )
-        .default(false)
-        .hideHelp(true),
-    )
     .option(
       '-r, --replace-existing',
       'Replace all existing variables instead of merging them with the current ones',

src/commands/init/index.ts

@@ -9,12 +9,6 @@ export const createInitCommand = (program: BaseCommand) =>
       'Configure continuous deployment for a new or existing site. To create a new site without continuous deployment, use `netlify sites:create`',
     )
     .option('-m, --manual', 'Manually configure a git remote for CI')
-    .addOption(
-      new Option(
-        '--gitRemoteName <name>',
-        'Old, prefer --git-remote-name. Name of Git remote to use. e.g. "origin"',
-      ).hideHelp(true),
-    )
     .option('--git-remote-name <name>', 'Name of Git remote to use. e.g. "origin"')
     .action(async (options: OptionValues, command: BaseCommand) => {
       const { init } = await import('./init.js')

src/commands/link/index.ts

@@ -8,12 +8,6 @@ export const createLinkCommand = (program: BaseCommand) =>
     .description('Link a local repo or project folder to an existing site on Netlify')
     .option('--id <id>', 'ID of site to link to')
     .option('--name <name>', 'Name of site to link to')
-    .addOption(
-      new Option(
-        '--gitRemoteName <name>',
-        'Old, prefer --git-remote-name. Name of Git remote to use. e.g. "origin"',
-      ).hideHelp(true),
-    )
     .option('--git-remote-name <name>', 'Name of Git remote to use. e.g. "origin"')
     .addExamples(['netlify link', 'netlify link --id 123-123-123-123', 'netlify link --name my-site-name'])
     .action(async (options: OptionValues, command: BaseCommand) => {

src/commands/serve/index.ts

@@ -25,11 +25,6 @@ export const createServeCommand = (program: BaseCommand) =>
         "disables edge functions. use this if your environment doesn't support Deno. This option is internal and should not be used by end users.",
       ).hideHelp(true),
     )
-    .addOption(
-      new Option('--functionsPort <port>', 'Old, prefer --functions-port. Port of functions server')
-        .argParser((value) => Number.parseInt(value))
-        .hideHelp(true),
-    )
     .option('--functions-port <port>', 'port of functions server', (value) => Number.parseInt(value))
     .addOption(
       new Option(

src/utils/command-helpers.ts

@@ -57,7 +57,7 @@ export const version = packageVersion
 export const USER_AGENT = `${name}/${version} ${platform}-${arch} node-${process.version}`
 
 /** A list of base command flags that needs to be sorted down on documentation and on help pages */
-const BASE_FLAGS = new Set(['--debug', '--httpProxy', '--httpProxyCertificateFilename'])
+const BASE_FLAGS = new Set(['--debug', '--http-proxy', '--http-proxy-certificate-filename'])
 
 export const NETLIFY_CYAN = chalk.rgb(40, 180, 170)
 

tests/integration/commands/deploy/deploy.test.ts

@@ -1046,14 +1046,12 @@ describe.skipIf(process.env.NETLIFY_TEST_DISABLE_LIVE === 'true').concurrent('co
     await withSiteBuilder(t, async (builder) => {
       await builder.build()
       try {
-        await callCli(['deploy', '--prodIfUnlocked', '--prod'], {
+        await callCli(['deploy', '--prod-if-unlocked', '--prod'], {
           cwd: builder.directory,
           env: { NETLIFY_SITE_ID: context.siteId },
         })
       } catch (error) {
-        expect(error.stderr.includes(`Error: option '-p, --prod' cannot be used with option '--prodIfUnlocked`)).toBe(
-          true,
-        )
+        expect(error.stderr).toContain(`Error: option '--prod-if-unlocked' cannot be used with option '-p, --prod'`)
       }
     })
   })