Fix/merge conflits (#1662)

* Fixed merge conflits * Fixed merge conflits * resolved conflits * Resolved merge conflits * updated readme file
contentstack · Nov 6, 2024 · eb6988f · eb6988f
1 parent edbdc62
commit eb6988f
Show file tree

Hide file tree

Showing 43 changed files with 1,387 additions and 1,039 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/contentstack-auth/README.md b/packages/contentstack-auth/README.md
@@ -49,8 +49,8 @@ USAGE
   $ csdx auth:login [-u <value> | --oauth] [-p <value> | ]
 
 FLAGS
-  -p, --password=<value>  Password
-  -u, --username=<value>  User name
+  -p, --password=<value>  Password of your Contentstack app
+  -u, --username=<value>  Email address of your Contentstack account.
   --oauth                 Enables single sign-on (SSO) in Contentstack CLI
 
 DESCRIPTION
@@ -141,7 +141,7 @@ USAGE
   $ csdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]
 
 FLAGS
-  -a, --alias=<value>          Name of the token alias
+  -a, --alias=<value>          Alias (name) you want to assign to the token
   -d, --delivery               Set this flag to save delivery token
   -e, --environment=<value>    Environment name for delivery token
   -k, --stack-api-key=<value>  Stack API Key
@@ -187,8 +187,8 @@ USAGE
   $ csdx auth:tokens:remove [-a <value>] [-i]
 
 FLAGS
-  -a, --alias=<value>  Token alias
-  -i, --ignore         Ignore
+  -a, --alias=<value>  Alias (name) of the token to delete.
+  -i, --ignore         Ignores if the token is not present.
 
 DESCRIPTION
   Removes selected tokens
@@ -230,8 +230,8 @@ USAGE
   $ csdx login [-u <value> | --oauth] [-p <value> | ]
 
 FLAGS
-  -p, --password=<value>  Password
-  -u, --username=<value>  User name
+  -p, --password=<value>  Password of your Contentstack app
+  -u, --username=<value>  Email address of your Contentstack account.
   --oauth                 Enables single sign-on (SSO) in Contentstack CLI
 
 DESCRIPTION

diff --git a/packages/contentstack-auth/src/commands/auth/login.ts b/packages/contentstack-auth/src/commands/auth/login.ts
@@ -27,14 +27,14 @@ export default class LoginCommand extends BaseCommand<typeof LoginCommand> {
   static flags: FlagInput = {
     username: flags.string({
       char: 'u',
-      description: 'User name',
+      description: 'Email address of your Contentstack account.',
       multiple: false,
       required: false,
       exclusive: ['oauth'],
     }),
     password: flags.string({
       char: 'p',
-      description: 'Password',
+      description: 'Password of your Contentstack app',
       multiple: false,
       required: false,
       exclusive: ['oauth'],

diff --git a/packages/contentstack-auth/src/commands/auth/tokens/add.ts b/packages/contentstack-auth/src/commands/auth/tokens/add.ts
@@ -30,7 +30,7 @@ export default class TokensAddCommand extends BaseCommand<typeof TokensAddComman
   ];
 
   static flags: FlagInput = {
-    alias: Flags.string({ char: 'a', description: 'Name of the token alias' }),
+    alias: Flags.string({ char: 'a', description: 'Alias (name) you want to assign to the token' }),
     delivery: flags.boolean({
       char: 'd',
       description: 'Set this flag to save delivery token',

diff --git a/packages/contentstack-auth/src/commands/auth/tokens/remove.ts b/packages/contentstack-auth/src/commands/auth/tokens/remove.ts
@@ -6,8 +6,8 @@ export default class TokensRemoveCommand extends BaseCommand<typeof TokensRemove
   static description = 'Removes selected tokens';
   static examples = ['$ csdx auth:tokens:remove', '$ csdx auth:tokens:remove -a <alias>'];
   static flags: FlagInput = {
-    alias: flags.string({ char: 'a', description: 'Token alias' }),
-    ignore: flags.boolean({ char: 'i', description: 'Ignore' }),
+    alias: flags.string({ char: 'a', description: 'Alias (name) of the token to delete.' }),
+    ignore: flags.boolean({ char: 'i', description: 'Ignores if the token is not present.' }),
   };
 
   async run(): Promise<any> {

diff --git a/packages/contentstack-branches/README.md b/packages/contentstack-branches/README.md
@@ -63,8 +63,8 @@ USAGE
   $ csdx cm:branches
 
 FLAGS
-  -k, --stack-api-key=<value>  Stack API Key
-  --verbose                    Verbose
+  -k, --stack-api-key=<value>  Stack API key
+  --verbose                    Verbose, display information in detailed format.
 
 DESCRIPTION
   List the branches
@@ -91,8 +91,8 @@ USAGE
 
 FLAGS
   -k, --stack-api-key=<value>  Stack API key
-  --source=<value>             Source branch from which new branch to be created
-  --uid=<value>                Branch UID to be created
+  --source=<value>             Source branch from which a new branch is to be created.
+  --uid=<value>                Branch UID (unique name) to be created.
 
 DESCRIPTION
   Create a new branch
@@ -145,12 +145,13 @@ USAGE
   $ csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]
 
 FLAGS
-  -k, --stack-api-key=<value>  Provide Stack API key to show difference between branches
-  --base-branch=<value>        Base branch
-  --compare-branch=<value>     Compare branch
-  --format=<option>            [default: compact-text] [Optional] Type of flags to show branches differences
+  -k, --stack-api-key=<value>  [optional] Provide the Stack API key to show the difference between branches.
+  --base-branch=<value>        [optional] Base branch (Target branch).
+  --compare-branch=<value>     [optional] Compare branch (Source branch).
+  --format=<option>            [default: compact-text] [default: compact-text] [optional] Type of flags to show the
+                               difference between two branches. <options: compact-text, detailed-text>
                                <options: compact-text|detailed-text>
-  --module=<option>            Module
+  --module=<option>            [optional] Module. <options: content-types, global-fields, all>
                                <options: content-types|global-fields|all>
 
 DESCRIPTION
@@ -194,13 +195,13 @@ USAGE
     [--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]
 
 FLAGS
-  -k, --stack-api-key=<value>    Provide Stack API key to show difference between branches
-  --base-branch=<value>          Base branch
-  --comment=<value>              Merge comment
-  --compare-branch=<value>       Compare branch name
-  --export-summary-path=<value>  Export summary file path
-  --no-revert                    If passed, will not create the new revert branch
-  --use-merge-summary=<value>    Path of merge summary file
+  -k, --stack-api-key=<value>    [optional] Provide stack API key to show the difference between the branches.
+  --base-branch=<value>          [optional] Base branch (Target branch).
+  --comment=<value>              [optional] Pass a comment.
+  --compare-branch=<value>       [optional] Compare branch (Source branch).
+  --export-summary-path=<value>  [optional] Export summary file path.
+  --no-revert                    [optional] If passed, will not create the new revert branch.
+  --use-merge-summary=<value>    [optional] Path of merge summary file.
 
 DESCRIPTION
   Merge changes from a branch

diff --git a/packages/contentstack-branches/src/commands/cm/branches/create.ts b/packages/contentstack-branches/src/commands/cm/branches/create.ts
@@ -19,8 +19,8 @@ export default class BranchCreateCommand extends Command {
   ]; // Note: Add and modify the usage
 
   static flags = {
-    uid: flags.string({ description: 'Branch UID to be created' }),
-    source: flags.string({ description: 'Source branch from which new branch to be created' }),
+    uid: flags.string({ description: 'Branch UID (unique name) to be created.' }),
+    source: flags.string({ description: 'Source branch from which a new branch is to be created.' }),
     'stack-api-key': flags.string({ char: 'k', description: 'Stack API key' }),
   };
 

diff --git a/packages/contentstack-branches/src/commands/cm/branches/diff.ts b/packages/contentstack-branches/src/commands/cm/branches/diff.ts
@@ -26,26 +26,26 @@ export default class BranchDiffCommand extends Command {
 
   static flags = {
     'base-branch': flags.string({
-      description: 'Base branch',
+      description: '[optional] Base branch (Target branch).',
     }),
     'compare-branch': flags.string({
-      description: 'Compare branch',
+      description: '[optional] Compare branch (Source branch).',
     }),
     module: flags.string({
-      description: 'Module',
+      description: '[optional] Module. <options: content-types, global-fields, all>',
       options: ['content-types', 'global-fields', 'all'],
     }),
     'stack-api-key': flags.string({
       char: 'k',
-      description: 'Provide Stack API key to show difference between branches',
+      description: '[optional] Provide the Stack API key to show the difference between branches.',
     }),
     format: flags.string({
       default: 'compact-text',
       multiple: false,
       options: ['compact-text', 'detailed-text'],
-      description: '[Optional] Type of flags to show branches differences',
+      description: '[default: compact-text] [optional] Type of flags to show the difference between two branches. <options: compact-text, detailed-text>',
     }),
-  };
+  };  
 
   static aliases: string[] = []; // Note: alternative usage if any
 

diff --git a/packages/contentstack-branches/src/commands/cm/branches/index.ts b/packages/contentstack-branches/src/commands/cm/branches/index.ts
@@ -10,8 +10,8 @@ export default class BranchListCommand extends Command {
   static usage: string = 'cm:branches'; // Note: Add and modify the usage
 
   static flags = {
-    'stack-api-key': flags.string({ char: 'k', description: 'Stack API Key' }),
-    verbose: flags.boolean({ description: 'Verbose' }),
+    'stack-api-key': flags.string({ char: 'k', description: 'Stack API key' }),
+    verbose: flags.boolean({ description: 'Verbose, display information in detailed format.' }),
   };
 
   static aliases: string[] = []; // Note: alternative usage if any

diff --git a/packages/contentstack-branches/src/commands/cm/branches/merge.ts b/packages/contentstack-branches/src/commands/cm/branches/merge.ts
@@ -20,40 +20,40 @@ export default class BranchMergeCommand extends Command {
 
   // TBD improve flag descriptions
   static flags = {
-    'compare-branch': flags.string({
-      description: 'Compare branch name',
+  'compare-branch': flags.string({
+      description: '[optional] Compare branch (Source branch).',
     }),
     'base-branch': flags.string({
-      description: 'Base branch',
+      description: '[optional] Base branch (Target branch).',
     }),
     comment: flags.string({
-      description: 'Merge comment',
+      description: '[optional] Pass a comment.',
     }),
     'stack-api-key': flags.string({
       char: 'k',
-      description: 'Provide Stack API key to show difference between branches',
+      description: '[optional] Provide stack API key to show the difference between the branches.',
     }),
     'export-summary-path': flags.string({
-      description: 'Export summary file path',
+      description: '[optional] Export summary file path.',
     }),
     'use-merge-summary': flags.string({
-      description: 'Path of merge summary file',
+      description: '[optional] Path of merge summary file.',
     }),
     'no-revert': flags.boolean({
-      description: 'If passed, will not create the new revert branch',
+      description: '[optional] If passed, will not create the new revert branch.',
     }),
     strategy: flags.string({
-      description: 'Merge strategy',
+      description: '[hidden] Merge strategy.',
       options: ['merge_prefer_base', 'merge_prefer_compare', 'overwrite_with_compare', 'custom_preferences'],
       hidden: true,
     }),
     'strategy-sub-options': flags.string({
-      description: 'Merge strategy sub options',
+      description: '[hidden] Merge strategy sub options.',
       options: ['new', 'modified', 'both'],
       hidden: true,
     }),
     'merge-action': flags.string({
-      description: 'Merge strategy',
+      description: '[hidden] Merge action.',
       options: ['export', 'execute', 'both'],
       hidden: true,
     }),