making path optional; default compare to recent change

Author: michaeled

README.md

@@ -55,7 +55,7 @@ _See code: [src/commands/command.ts](https://github.com/Contentstack-Solutions/c
 
 ## `csdx content-type:audit`
 
-display audit logs for recent changes to a Content Type
+display Audit Logs for recent changes to a Content Type
 
 ```
 USAGE
@@ -84,14 +84,14 @@ USAGE
 OPTIONS
   -a, --token-alias=token-alias    management token alias
   -c, --content-type=content-type  (required) Content Type UID
-  -l, --left=left                  (required) previous Content Type version
-  -r, --right=right                (required) current Content Type version
+  -l, --left=left                  (required) Content Type version
+  -r, --right=right                (required) Content Type version
   -s, --stack=stack                stack uid
 
 EXAMPLES
   $ csdx content-type:compare -s "xxxxxxxxxxxxxxxxxxx" -c "home_page"
-  $ csdx content-type:compare -s "xxxxxxxxxxxxxxxxxxx" -c "home_page" -left # -right #
-  $ csdx content-type:compare -a "management token" -c "home_page" -left # -right #
+  $ csdx content-type:compare -s "xxxxxxxxxxxxxxxxxxx" -c "home_page" -l # -r #
+  $ csdx content-type:compare -a "management token" -c "home_page" -l # -r #
 ```
 
 _See code: [src/commands/content-type/compare.ts](https://github.com/Contentstack-Solutions/contentstack-cli-content-type/blob/v1.0.0/src/commands/content-type/compare.ts)_
@@ -107,11 +107,13 @@ USAGE
 OPTIONS
   -a, --token-alias=token-alias    management token alias
   -c, --content-type=content-type  (required) Content Type UID
+  -p, --[no-]path                  show path column
   -s, --stack=stack                stack uid
 
 EXAMPLES
   $ csdx content-type:details -s "xxxxxxxxxxxxxxxxxxx" -c "home_page"
   $ csdx content-type:details -a "management token" -c "home_page"
+  $ csdx content-type:details -a "management token" -c "home_page" --no-path
 ```
 
 _See code: [src/commands/content-type/details.ts](https://github.com/Contentstack-Solutions/contentstack-cli-content-type/blob/v1.0.0/src/commands/content-type/details.ts)_

oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.0.0","commands":{"command":{"id":"command","pluginName":"contentstack-cli-content-type","pluginType":"core","aliases":[],"flags":{},"args":[]},"":{"id":"","pluginName":"contentstack-cli-content-type","pluginType":"core","aliases":[],"flags":{},"args":[]},"content-type:audit":{"id":"content-type:audit","description":"display audit logs for recent changes to a Content Type","pluginName":"contentstack-cli-content-type","pluginType":"core","aliases":[],"examples":["$ csdx content-type:audit -s \"xxxxxxxxxxxxxxxxxxx\" -c \"home_page\"","$ csdx content-type:audit -a \"management token\" -c \"home_page\""],"flags":{"stack":{"name":"stack","type":"option","char":"s","description":"stack uid","required":false},"token-alias":{"name":"token-alias","type":"option","char":"a","description":"management token alias","required":false},"content-type":{"name":"content-type","type":"option","char":"c","description":"Content Type UID","required":true}},"args":[]},"content-type:compare":{"id":"content-type:compare","description":"compare two Content Type versions","pluginName":"contentstack-cli-content-type","pluginType":"core","aliases":[],"examples":["$ csdx content-type:compare -s \"xxxxxxxxxxxxxxxxxxx\" -c \"home_page\"","$ csdx content-type:compare -s \"xxxxxxxxxxxxxxxxxxx\" -c \"home_page\" -left # -right #","$ csdx content-type:compare -a \"management token\" -c \"home_page\" -left # -right #"],"flags":{"stack":{"name":"stack","type":"option","char":"s","description":"stack uid","required":false},"token-alias":{"name":"token-alias","type":"option","char":"a","description":"management token alias","hidden":false,"required":false},"content-type":{"name":"content-type","type":"option","char":"c","description":"Content Type UID","required":true},"left":{"name":"left","type":"option","char":"l","description":"previous Content Type version","required":true},"right":{"name":"right","type":"option","char":"r","description":"current Content Type version","required":true}},"args":[]},"content-type:details":{"id":"content-type:details","description":"display Content Type details","pluginName":"contentstack-cli-content-type","pluginType":"core","aliases":[],"examples":["$ csdx content-type:details -s \"xxxxxxxxxxxxxxxxxxx\" -c \"home_page\"","$ csdx content-type:details -a \"management token\" -c \"home_page\""],"flags":{"stack":{"name":"stack","type":"option","char":"s","description":"stack uid","required":false},"token-alias":{"name":"token-alias","type":"option","char":"a","description":"management token alias","required":false},"content-type":{"name":"content-type","type":"option","char":"c","description":"Content Type UID","required":true}},"args":[]},"content-type:list":{"id":"content-type:list","description":"list all Content Types in a Stack","pluginName":"contentstack-cli-content-type","pluginType":"core","aliases":[],"examples":["$ csdx content-type:list -s \"xxxxxxxxxxxxxxxxxxx\"","$ csdx content-type:list -a \"management token\"","$ csdx content-type:list -a \"management token\" -o modified"],"flags":{"stack":{"name":"stack","type":"option","char":"s","description":"stack uid","required":false},"token-alias":{"name":"token-alias","type":"option","char":"a","description":"management token alias","required":false},"order":{"name":"order","type":"option","char":"o","description":"order by column","required":false,"options":["title","modified"],"default":"title"}},"args":[]}}}
+{"version":"1.0.0","commands":{"command":{"id":"command","pluginName":"contentstack-cli-content-type","pluginType":"core","aliases":[],"flags":{},"args":[]},"":{"id":"","pluginName":"contentstack-cli-content-type","pluginType":"core","aliases":[],"flags":{},"args":[]},"content-type:audit":{"id":"content-type:audit","description":"display Audit Logs for recent changes to a Content Type","pluginName":"contentstack-cli-content-type","pluginType":"core","aliases":[],"examples":["$ csdx content-type:audit -s \"xxxxxxxxxxxxxxxxxxx\" -c \"home_page\"","$ csdx content-type:audit -a \"management token\" -c \"home_page\""],"flags":{"stack":{"name":"stack","type":"option","char":"s","description":"stack uid","required":false},"token-alias":{"name":"token-alias","type":"option","char":"a","description":"management token alias","required":false},"content-type":{"name":"content-type","type":"option","char":"c","description":"Content Type UID","required":true}},"args":[]},"content-type:compare":{"id":"content-type:compare","description":"compare two Content Type versions","pluginName":"contentstack-cli-content-type","pluginType":"core","aliases":[],"examples":["$ csdx content-type:compare -s \"xxxxxxxxxxxxxxxxxxx\" -c \"home_page\"","$ csdx content-type:compare -s \"xxxxxxxxxxxxxxxxxxx\" -c \"home_page\" -l # -r #","$ csdx content-type:compare -a \"management token\" -c \"home_page\" -l # -r #"],"flags":{"stack":{"name":"stack","type":"option","char":"s","description":"stack uid","required":false},"token-alias":{"name":"token-alias","type":"option","char":"a","description":"management token alias","hidden":false,"required":false},"content-type":{"name":"content-type","type":"option","char":"c","description":"Content Type UID","required":true},"left":{"name":"left","type":"option","char":"l","description":"Content Type version","required":true},"right":{"name":"right","type":"option","char":"r","description":"Content Type version","required":true}},"args":[]},"content-type:details":{"id":"content-type:details","description":"display Content Type details","pluginName":"contentstack-cli-content-type","pluginType":"core","aliases":[],"examples":["$ csdx content-type:details -s \"xxxxxxxxxxxxxxxxxxx\" -c \"home_page\"","$ csdx content-type:details -a \"management token\" -c \"home_page\"","$ csdx content-type:details -a \"management token\" -c \"home_page\" --no-path"],"flags":{"stack":{"name":"stack","type":"option","char":"s","description":"stack uid","required":false},"token-alias":{"name":"token-alias","type":"option","char":"a","description":"management token alias","required":false},"content-type":{"name":"content-type","type":"option","char":"c","description":"Content Type UID","required":true},"path":{"name":"path","type":"boolean","char":"p","description":"show path column","allowNo":true}},"args":[]},"content-type:list":{"id":"content-type:list","description":"list all Content Types in a Stack","pluginName":"contentstack-cli-content-type","pluginType":"core","aliases":[],"examples":["$ csdx content-type:list -s \"xxxxxxxxxxxxxxxxxxx\"","$ csdx content-type:list -a \"management token\"","$ csdx content-type:list -a \"management token\" -o modified"],"flags":{"stack":{"name":"stack","type":"option","char":"s","description":"stack uid","required":false},"token-alias":{"name":"token-alias","type":"option","char":"a","description":"management token alias","required":false},"order":{"name":"order","type":"option","char":"o","description":"order by column","required":false,"options":["title","modified"],"default":"title"}},"args":[]}}}

package-lock.json

@@ -9,6 +9,7 @@
     "@oclif/command": "^1.8.0",
     "@oclif/config": "^1.17.0",
     "@types/git-diff": "^2.0.0",
+    "@types/hogan.js": "^3.0.0",
     "@types/table": "^6.0.0",
     "@types/tmp": "^0.2.0",
     "axios": "^0.21.0",

package.json

@@ -4,7 +4,9 @@ import ContentstackClient from '../core/contentstack/client'
 
 export default class ContentTypeCommand extends Command {
   protected static RequestDataMessage = 'Requesting data';
+
   protected apiKey!: string;
+
   protected client!: ContentstackClient;
 
   setup(flags: any) {

src/commands/command.ts

@@ -36,14 +36,16 @@ export default class CompareCommand extends Command {
 
     left: flags.integer({
       char: 'l',
-      description: 'Content Type version',
-      required: true,
+      description: 'Content Type version, i.e. prev version',
+      required: false,
+      dependsOn: ['right']
     }),
 
     right: flags.integer({
       char: 'r',
-      description: 'Content Type version',
-      required: true,
+      description: 'Content Type version, i.e. later version',
+      required: false,
+      dependsOn: ['left']
     }),
   }
 
@@ -53,6 +55,16 @@ export default class CompareCommand extends Command {
       this.setup(flags)
 
       cli.action.start(Command.RequestDataMessage)
+      
+      if (!flags.left) {
+        const discovery = await this.client.getContentType(this.apiKey, flags['content-type'], false);
+        const version = discovery.content_type._version;
+
+        flags.left = version;
+        flags.right = version > 1 ? version - 1 : version;
+
+        this.log(`Comparing versions: ${flags.left} <-> ${flags.right}.`)
+      }
 
       const [stack, previous, current] = await Promise.all([
         this.client.getStack(this.apiKey),
@@ -64,6 +76,10 @@ export default class CompareCommand extends Command {
 
       const output = await buildOutput(flags['content-type'], previous, current)
       this.printOutput(output, 'changes', flags['content-type'], stack.name)
+
+      if (flags.left && flags.left === flags.right) {
+        this.warn('Comparing the same version does not produce useful results.')
+      }
     } catch (error) {
       this.error(error, {exit: 1, suggestions: error.suggestions})
     }

src/commands/content-type/compare.ts

@@ -9,6 +9,7 @@ export default class DetailsCommand extends Command {
   static examples = [
     '$ csdx content-type:details -s "xxxxxxxxxxxxxxxxxxx" -c "home_page"',
     '$ csdx content-type:details -a "management token" -c "home_page"',
+    '$ csdx content-type:details -a "management token" -c "home_page" --no-path',
   ];
 
   static flags = {
@@ -31,6 +32,13 @@ export default class DetailsCommand extends Command {
       description: 'Content Type UID',
       required: true,
     }),
+
+    path: flags.boolean({
+      char: 'p',
+      description: 'show path column',
+      default: true,
+      allowNo: true,
+    }),
   }
 
   async run() {
@@ -48,7 +56,7 @@ export default class DetailsCommand extends Command {
 
       cli.action.stop()
 
-      const output = buildOutput(contentType, references)
+      const output = buildOutput(contentType, references, {showPath: flags.path})
       this.printOutput(output, 'details', flags['content-type'], stack.name)
     } catch (error) {
       this.error(error, {exit: 1, suggestions: error.suggestions})

src/commands/content-type/details.ts

@@ -4,7 +4,13 @@ import * as format from './formatting'
 
 const {table} = tableImport
 
-export default function buildOutput(contentType: any, references: any): BuildOutput {
+let buildOptions = {
+  showPath: true,
+}
+
+export default function buildOutput(contentType: any, references: any, options: any): BuildOutput {
+  buildOptions = Object.assign(buildOptions, options)
+
   const header = buildHeader(contentType.content_type, references.references)
   const body = buildBody(contentType.content_type.schema)
 
@@ -19,7 +25,15 @@ export default function buildOutput(contentType: any, references: any): BuildOut
 function buildBody(schema: any) {
   const rows = []
 
-  rows.push(['Display Name', 'UID', 'Data Type', 'Path', 'Required', 'Multiple', 'Unique'])
+  const headers = [
+    'Display Name',
+    'UID',
+    'Data Type',
+    buildOptions.showPath ? 'Path' : null,
+    'Req | Mult | Unique',
+  ].filter(v => v !== null)
+
+  rows.push(headers)
   rows.push(...processFields(schema))
 
   return {
@@ -59,11 +73,9 @@ function buildRow(field: any, parent = null, depth = 0, prefix = '') {
     displayName,
     field.uid,
     field.data_type,
-    path,
-    format.checked(field.mandatory),
-    format.checked(field.multiple),
-    format.checked(field.unique),
-  ]
+    buildOptions.showPath ? path : null,
+    buildOptionsColumn(field),
+  ].filter(v => v !== null)
 }
 
 function buildHeader(contentType: any, references: string[]) {
@@ -88,3 +100,21 @@ function buildHeader(contentType: any, references: string[]) {
 
   return result.join('\n')
 }
+
+function buildOptionsColumn(field: any) {
+  let output = ''
+
+  if (field.mandatory) {
+    output += 'R'
+  }
+
+  if (field.multiple) {
+    output += 'M'
+  }
+
+  if (field.unique) {
+    output += 'U'
+  }
+
+  return output
+}