refactor: update command flags for content-type commands to use long options and remove deprecated flags

Author: harshitha-cstk

README.md

@@ -67,14 +67,12 @@ Display recent changes to a Content Type
 
 ```
 USAGE
-  $ csdx content-type:audit -c <value> [-s <value> | -a <value> | -a <value>] [-k <value> |  | ]
+  $ csdx content-type:audit --content-type <value> [-k <value> | -a <value>]
 
 FLAGS
   -a, --alias=<value>          Alias of the management token
-  -a, --token-alias=<value>    Management token alias
-  -c, --content-type=<value>   (required) Content Type UID
   -k, --stack-api-key=<value>  Stack API Key
-  -s, --stack=<value>          Stack UID
+      --content-type=<value>   (required) Content Type UID
 
 DESCRIPTION
   Display recent changes to a Content Type
@@ -85,24 +83,22 @@ EXAMPLES
   $ csdx content-type:audit --alias "management token" --content-type "home_page"
 ```
 
-_See code: [src/commands/content-type/audit.ts](https://github.com/contentstack/contentstack-cli-content-type/blob/v1.3.0/src/commands/content-type/audit.ts)_
+_See code: [src/commands/content-type/audit.ts](https://github.com/contentstack/contentstack-cli-content-type/blob/v1.5.0-beta.0/src/commands/content-type/audit.ts)_
 
 ## `csdx content-type:compare`
 
 Compare two Content Type versions
 
 ```
 USAGE
-  $ csdx content-type:compare -c <value> [-s <value> | -a <value>] [-k <value> | ] [-a <value>] [-l <value> -r <value>]
+  $ csdx content-type:compare --content-type <value> [-k <value> | -a <value>] [--left <value> --right <value>]
 
 FLAGS
   -a, --alias=<value>          Alias of the management token
-  -a, --token-alias=<value>    Management token alias
-  -c, --content-type=<value>   (required) Content Type UID
   -k, --stack-api-key=<value>  Stack API Key
-  -l, --left=<value>           Content Type version, i.e. prev version
-  -r, --right=<value>          Content Type version, i.e. later version
-  -s, --stack=<value>          Stack UID
+      --content-type=<value>   (required) Content Type UID
+      --left=<value>           Content Type version, i.e. prev version
+      --right=<value>          Content Type version, i.e. later version
 
 DESCRIPTION
   Compare two Content Type versions
@@ -115,45 +111,43 @@ EXAMPLES
   $ csdx content-type:compare --alias "management token" --content-type "home_page" --left # --right #
 ```
 
-_See code: [src/commands/content-type/compare.ts](https://github.com/contentstack/contentstack-cli-content-type/blob/v1.3.0/src/commands/content-type/compare.ts)_
+_See code: [src/commands/content-type/compare.ts](https://github.com/contentstack/contentstack-cli-content-type/blob/v1.5.0-beta.0/src/commands/content-type/compare.ts)_
 
 ## `csdx content-type:compare-remote`
 
 compare two Content Types on different Stacks
 
 ```
 USAGE
-  $ csdx content-type:compare-remote (-o <value> -r <value>) -c <value>
+  $ csdx content-type:compare-remote (--origin-stack <value> --remote-stack <value>) --content-type <value>
 
 FLAGS
-  -c, --content-type=<value>  (required) Content Type UID
-  -o, --origin-stack=<value>  (required) Origin Stack API Key
-  -r, --remote-stack=<value>  (required) Remote Stack API Key
+  --content-type=<value>  (required) Content Type UID
+  --origin-stack=<value>  (required) Origin Stack API Key
+  --remote-stack=<value>  (required) Remote Stack API Key
 
 DESCRIPTION
   compare two Content Types on different Stacks
 
 EXAMPLES
-  $ csdx content-type:compare-remote --origin-stack "xxxxxxxxxxxxxxxxxxx" --remote-stack "xxxxxxxxxxxxxxxxxxx" -content-type "home_page"
+  $ csdx content-type:compare-remote --origin-stack "xxxxxxxxxxxxxxxxxxx" --remote-stack "xxxxxxxxxxxxxxxxxxx" --content-type "home_page"
 ```
 
-_See code: [src/commands/content-type/compare-remote.ts](https://github.com/contentstack/contentstack-cli-content-type/blob/v1.3.0/src/commands/content-type/compare-remote.ts)_
+_See code: [src/commands/content-type/compare-remote.ts](https://github.com/contentstack/contentstack-cli-content-type/blob/v1.5.0-beta.0/src/commands/content-type/compare-remote.ts)_
 
 ## `csdx content-type:details`
 
 Display Content Type details
 
 ```
 USAGE
-  $ csdx content-type:details -c <value> [-s <value> | -a <value>] [-k <value> | ] [-a <value>] [-p]
+  $ csdx content-type:details --content-type <value> [-k <value> | -a <value>] [--path]
 
 FLAGS
   -a, --alias=<value>          Alias of the management token
-  -a, --token-alias=<value>    Management token alias
-  -c, --content-type=<value>   (required) Content Type UID
   -k, --stack-api-key=<value>  Stack API Key
-  -p, --[no-]path              show path column
-  -s, --stack=<value>          Stack UID
+      --content-type=<value>   (required) Content Type UID
+      --[no-]path              show path column
 
 DESCRIPTION
   Display Content Type details
@@ -166,26 +160,23 @@ EXAMPLES
   $ csdx content-type:details --alias "management token" --content-type "home_page" --no-path
 ```
 
-_See code: [src/commands/content-type/details.ts](https://github.com/contentstack/contentstack-cli-content-type/blob/v1.3.0/src/commands/content-type/details.ts)_
+_See code: [src/commands/content-type/details.ts](https://github.com/contentstack/contentstack-cli-content-type/blob/v1.5.0-beta.0/src/commands/content-type/details.ts)_
 
 ## `csdx content-type:diagram`
 
 Create a visual diagram of a Stack's Content Types
 
 ```
 USAGE
-  $ csdx content-type:diagram -o <value> -d portrait|landscape -t svg|dot [-s <value> | -a <value> | -a <value>] [-k
-    <value> |  | ]
+  $ csdx content-type:diagram --output <value> --direction portrait|landscape --type svg|dot [-k <value> | -a <value>]
 
 FLAGS
   -a, --alias=<value>          Alias of the management token
-  -a, --token-alias=<value>    Management token alias
-  -d, --direction=<option>     (required) [default: portrait] graph orientation
-                               <options: portrait|landscape>
   -k, --stack-api-key=<value>  Stack API Key
-  -o, --output=<value>         (required) full path to output
-  -s, --stack=<value>          Stack UID
-  -t, --type=<option>          (required) [default: svg] graph output file type
+      --direction=<option>     (required) [default: portrait] graph orientation
+                               <options: portrait|landscape>
+      --output=<value>         (required) full path to output
+      --type=<option>          (required) [default: svg] graph output file type
                                <options: svg|dot>
 
 DESCRIPTION
@@ -201,23 +192,21 @@ EXAMPLES
   $ csdx content-type:diagram --alias "management token" --output "content-model.dot" --type "dot"
 ```
 
-_See code: [src/commands/content-type/diagram.ts](https://github.com/contentstack/contentstack-cli-content-type/blob/v1.3.0/src/commands/content-type/diagram.ts)_
+_See code: [src/commands/content-type/diagram.ts](https://github.com/contentstack/contentstack-cli-content-type/blob/v1.5.0-beta.0/src/commands/content-type/diagram.ts)_
 
 ## `csdx content-type:list`
 
 List all Content Types in a Stack
 
 ```
 USAGE
-  $ csdx content-type:list [-s <value> | -a <value> | -a <value>] [-k <value> |  | ] [-o title|modified]
+  $ csdx content-type:list [-k <value> | -a <value>] [--order title|modified]
 
 FLAGS
   -a, --alias=<value>          Alias of the management token
-  -a, --token-alias=<value>    Management token alias
   -k, --stack-api-key=<value>  Stack API Key
-  -o, --order=<option>         [default: title] order by column
+      --order=<option>         [default: title] order by column
                                <options: title|modified>
-  -s, --stack=<value>          Stack UID
 
 DESCRIPTION
   List all Content Types in a Stack
@@ -230,5 +219,5 @@ EXAMPLES
   $ csdx content-type:list --alias "management token" --order modified
 ```
 
-_See code: [src/commands/content-type/list.ts](https://github.com/contentstack/contentstack-cli-content-type/blob/v1.3.0/src/commands/content-type/list.ts)_
+_See code: [src/commands/content-type/list.ts](https://github.com/contentstack/contentstack-cli-content-type/blob/v1.5.0-beta.0/src/commands/content-type/list.ts)_
 <!-- commandsstop -->

src/commands/content-type/audit.ts

@@ -3,7 +3,6 @@ import {
   flags,
   managementSDKClient,
   cliux,
-  printFlagDeprecation,
 } from "@contentstack/cli-utilities";
 import buildOutput from "../../core/content-type/audit";
 import { getStack, getUsers, getContentType } from "../../utils";
@@ -17,35 +16,21 @@ export default class AuditCommand extends Command {
   ];
 
   static flags: any = {
-    stack: flags.string({
-      char: "s",
-      description: "Stack UID",
-      exclusive: ["token-alias", "alias"],
-      parse: printFlagDeprecation(["-s", "--stack"], ["-k", "--stack-api-key"]),
-    }),
-
     "stack-api-key": flags.string({
       char: "k",
       description: "Stack API Key",
-      exclusive: ["token-alias", "alias"],
-    }),
-
-    "token-alias": flags.string({
-      char: "a",
-      description: "Management token alias",
-      parse: printFlagDeprecation(["--token-alias"], ["-a", "--alias"]),
+      exclusive: ["alias"],
     }),
 
     alias: flags.string({
       char: "a",
       description: "Alias of the management token",
+      exclusive: ["stack-api-key"],
     }),
 
     "content-type": flags.string({
-      char: "c",
       description: "Content Type UID",
       required: true,
-      parse: printFlagDeprecation(["-c"], ["--content-type"]),
     }),
   };
 

src/commands/content-type/compare-remote.ts

@@ -1,10 +1,8 @@
 import Command from "../../core/command";
 import {
   flags,
-  FlagInput,
   managementSDKClient,
   cliux,
-  printFlagDeprecation,
 } from "@contentstack/cli-utilities";
 import buildOutput from "../../core/content-type/compare";
 import { getStack, getContentType } from "../../utils";
@@ -13,38 +11,32 @@ export default class CompareRemoteCommand extends Command {
   static description = "compare two Content Types on different Stacks";
 
   static examples = [
-    '$ csdx content-type:compare-remote --origin-stack "xxxxxxxxxxxxxxxxxxx" --remote-stack "xxxxxxxxxxxxxxxxxxx" -content-type "home_page"',
+    '$ csdx content-type:compare-remote --origin-stack "xxxxxxxxxxxxxxxxxxx" --remote-stack "xxxxxxxxxxxxxxxxxxx" --content-type "home_page"',
   ];
 
   static flags: any = {
     "origin-stack": flags.string({
-      char: "o",
       description: "Origin Stack API Key",
       required: true,
       dependsOn: ["remote-stack"],
-      parse: printFlagDeprecation(["-o"], ["--remote-stack"]),
     }),
 
     "remote-stack": flags.string({
-      char: "r",
       description: "Remote Stack API Key",
       required: true,
       dependsOn: ["origin-stack"],
-      parse: printFlagDeprecation(["-r"], ["--remote-stack"]),
     }),
 
     "content-type": flags.string({
-      char: "c",
       description: "Content Type UID",
       required: true,
-      parse: printFlagDeprecation(["-c"], ["--content-type"]),
     }),
   };
 
   async run() {
     try {
       const { flags } = await this.parse(CompareRemoteCommand);
-      await this.setup({ alias: undefined, stack: flags["origin-stack"] });
+      await this.setup({ "stack-api-key": flags["origin-stack"] });
       this.contentTypeManagementClient = await managementSDKClient({
         host: this.cmaHost,
         "X-CS-CLI": this.context?.analyticsInfo,

src/commands/content-type/compare.ts

@@ -1,5 +1,5 @@
 import Command from '../../core/command'
-import { flags, FlagInput, managementSDKClient, cliux, printFlagDeprecation } from '@contentstack/cli-utilities'
+import { flags, managementSDKClient, cliux } from '@contentstack/cli-utilities'
 import buildOutput from '../../core/content-type/compare'
 import { getStack, getContentType } from '../../utils'
 
@@ -13,49 +13,31 @@ export default class CompareCommand extends Command {
   ]
 
   static flags: any = {
-    stack: flags.string({
-      char: 's',
-      description: 'Stack UID',
-      exclusive: ['token-alias'],
-      parse: printFlagDeprecation(['-s', '--stack'], ['-k', '--stack-api-key'])
-    }),
-
     'stack-api-key': flags.string({
       char: 'k',
       description: 'Stack API Key',
-      exclusive: ['token-alias']
-    }),
-
-    'token-alias': flags.string({
-      char: 'a',
-      description: 'Management token alias',
-      parse: printFlagDeprecation(['--token-alias'], ['-a', '--alias'])
+      exclusive: ['alias']
     }),
 
     alias: flags.string({
       char: 'a',
-      description: 'Alias of the management token'
+      description: 'Alias of the management token',
+      exclusive: ['stack-api-key']
     }),
 
     'content-type': flags.string({
-      char: 'c',
       description: 'Content Type UID',
-      required: true,
-      parse: printFlagDeprecation(['-c'], ['--content-type'])
+      required: true
     }),
 
     left: flags.integer({
-      char: 'l',
       description: 'Content Type version, i.e. prev version',
-      dependsOn: ['right'],
-      parse: printFlagDeprecation(['-l'], ['--left'])
+      dependsOn: ['right']
     }),
 
     right: flags.integer({
-      char: 'r',
       description: 'Content Type version, i.e. later version',
-      dependsOn: ['left'],
-      parse: printFlagDeprecation(['-r'], ['--right'])
+      dependsOn: ['left']
     })
   }
 

src/commands/content-type/details.ts

@@ -1,10 +1,8 @@
 import Command from "../../core/command";
 import {
   flags,
-  FlagInput,
   managementSDKClient,
   cliux,
-  printFlagDeprecation,
 } from "@contentstack/cli-utilities";
 import buildOutput from "../../core/content-type/details";
 import { getStack, getContentType } from "../../utils";
@@ -19,43 +17,27 @@ export default class DetailsCommand extends Command {
   ];
 
   static flags: any = {
-    stack: flags.string({
-      char: "s",
-      description: "Stack UID",
-      exclusive: ["token-alias"],
-      parse: printFlagDeprecation(["-s", "--stack"], ["-k", "--stack-api-key"]),
-    }),
-
     "stack-api-key": flags.string({
       char: "k",
       description: "Stack API Key",
-      exclusive: ["token-alias"],
-    }),
-
-    "token-alias": flags.string({
-      char: "a",
-      description: "Management token alias",
-      parse: printFlagDeprecation(["--token-alias"], ["-a", "--alias"]),
+      exclusive: ["alias"],
     }),
 
     alias: flags.string({
       char: "a",
       description: "Alias of the management token",
+      exclusive: ["stack-api-key"],
     }),
 
     "content-type": flags.string({
-      char: "c",
       description: "Content Type UID",
       required: true,
-      parse: printFlagDeprecation(["-c"], ["--content-type"]),
     }),
 
     path: flags.boolean({
-      char: "p",
       description: "show path column",
       default: true,
       allowNo: true,
-      parse: printFlagDeprecation(["-p"], ["--path"]),
     }),
   };