@contentstack/cli-cm-branches 1.0.0

package/messages/index.json

@@ -0,0 +1,12 @@
+{
+  "CLI_BRANCH_API_FAILED": "Something went wrong. Unable to fetch the details.",
+  "CLI_BRANCH_BASE_BRANCH": "Enter base branch name:",
+  "CLI_BRANCH_COMPARE_BRANCH": "Enter compare branch name:",
+  "CLI_BRANCH_STACK_API_KEY": "Enter Stack API key:",
+  "CLI_BRANCH_MODULE": "Choose a module:",
+  "CLI_BRANCH_REQUIRED_FIELD": "This field can't be empty.",
+  "CLI_BRANCH_CONFIG_ERROR": "Please set the config using 'cm:config:set:branch' command",
+  "CLI_BRANCH_BRANCH_UID": "Enter branch UID:",
+  "CLI_BRANCH_SOURCE_BRANCH": "Enter source branch:",
+  "CLI_BRANCH_NAME_CONFIRMATION": "To delete the branch, type the branch name to confirm:"
+}

package/oclif.manifest.json

@@ -0,0 +1,289 @@
+{
+  "version": "1.0.0",
+  "commands": {
+    "cm:branches:create": {
+      "id": "cm:branches:create",
+      "description": "Create a new branch",
+      "strict": true,
+      "usage": [
+        "cm:branches:create",
+        "cm:branches:create [--source <value>] [--uid <value>] [-k <value>]",
+        "cm:branches:create [--source <value>] [--uid <value>] [--stack-api-key <value>]"
+      ],
+      "pluginName": "@contentstack/cli-cm-branches",
+      "pluginAlias": "@contentstack/cli-cm-branches",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "csdx cm:branches:create",
+        "csdx cm:branches:create --source main -uid new_branch -k bltxxxxxxxx",
+        "csdx cm:branches:create --source main --uid new_branch --stack-api-key bltxxxxxxxx"
+      ],
+      "flags": {
+        "uid": {
+          "name": "uid",
+          "type": "option",
+          "description": "Branch UID to be created",
+          "multiple": false
+        },
+        "source": {
+          "name": "source",
+          "type": "option",
+          "description": "Source branch from which new branch to be created",
+          "multiple": false
+        },
+        "stack-api-key": {
+          "name": "stack-api-key",
+          "type": "option",
+          "char": "k",
+          "description": "Stack API key",
+          "multiple": false
+        }
+      },
+      "args": {}
+    },
+    "cm:branches:delete": {
+      "id": "cm:branches:delete",
+      "description": "Delete a branch",
+      "strict": true,
+      "usage": [
+        "cm:branches:delete [-uid <value>] [-k <value>]",
+        "cm:branches:delete [--uid <value>] [--stack-api-key <value>]"
+      ],
+      "pluginName": "@contentstack/cli-cm-branches",
+      "pluginAlias": "@contentstack/cli-cm-branches",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "csdx cm:branches:delete",
+        "csdx cm:branches:delete --uid main -k bltxxxxxxxx",
+        "csdx cm:branches:delete --uid main --stack-api-key bltxxxxxxxx",
+        "csdx cm:branches:delete --uid main --stack-api-key bltxxxxxxxx --yes"
+      ],
+      "flags": {
+        "uid": {
+          "name": "uid",
+          "type": "option",
+          "description": "Branch UID to be deleted",
+          "multiple": false
+        },
+        "stack-api-key": {
+          "name": "stack-api-key",
+          "type": "option",
+          "char": "k",
+          "description": "Stack API key",
+          "multiple": false
+        },
+        "yes": {
+          "name": "yes",
+          "type": "boolean",
+          "char": "y",
+          "description": "Force the deletion of the branch by skipping the confirmation",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "cm:branches:diff": {
+      "id": "cm:branches:diff",
+      "description": "Differences between two branches",
+      "strict": true,
+      "usage": "cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]",
+      "pluginName": "@contentstack/cli-cm-branches",
+      "pluginAlias": "@contentstack/cli-cm-branches",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "csdx cm:branches:diff",
+        "csdx cm:branches:diff --stack-api-key \"bltxxxxxxxx\"",
+        "csdx cm:branches:diff --compare-branch \"develop\"",
+        "csdx cm:branches:diff --compare-branch \"develop\" --stack-api-key \"bltxxxxxxxx\"",
+        "csdx cm:branches:diff --compare-branch \"develop\" --module \"content-types\"",
+        "csdx cm:branches:diff --module \"content-types\" --format \"detailed-text\"",
+        "csdx cm:branches:diff --compare-branch \"develop\" --format \"detailed-text\"",
+        "csdx cm:branches:diff --stack-api-key \"bltxxxxxxxx\" --base-branch \"main\"",
+        "csdx cm:branches:diff --stack-api-key \"bltxxxxxxxx\" --base-branch \"main\" --compare-branch \"develop\"",
+        "csdx cm:branches:diff --stack-api-key \"bltxxxxxxxx\" --base-branch \"main\" --module \"content-types\"",
+        "csdx cm:branches:diff --stack-api-key \"bltxxxxxxxx\" --base-branch \"main\" --compare-branch \"develop\" --module \"content-types\"",
+        "csdx cm:branches:diff --stack-api-key \"bltxxxxxxxx\" --base-branch \"main\" --compare-branch \"develop\" --module \"content-types\" --format \"detailed-text\""
+      ],
+      "flags": {
+        "base-branch": {
+          "name": "base-branch",
+          "type": "option",
+          "description": "Base branch",
+          "multiple": false
+        },
+        "compare-branch": {
+          "name": "compare-branch",
+          "type": "option",
+          "description": "Compare branch",
+          "multiple": false
+        },
+        "module": {
+          "name": "module",
+          "type": "option",
+          "description": "Module",
+          "multiple": false,
+          "options": [
+            "content-types",
+            "global-fields",
+            "all"
+          ]
+        },
+        "stack-api-key": {
+          "name": "stack-api-key",
+          "type": "option",
+          "char": "k",
+          "description": "Provide Stack API key to show difference between branches",
+          "multiple": false
+        },
+        "format": {
+          "name": "format",
+          "type": "option",
+          "description": "[Optional] Type of flags to show branches differences",
+          "multiple": false,
+          "options": [
+            "compact-text",
+            "detailed-text"
+          ],
+          "default": "compact-text"
+        }
+      },
+      "args": {}
+    },
+    "cm:branches": {
+      "id": "cm:branches",
+      "description": "List the branches",
+      "strict": true,
+      "usage": "cm:branches",
+      "pluginName": "@contentstack/cli-cm-branches",
+      "pluginAlias": "@contentstack/cli-cm-branches",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "csdx cm:branches",
+        "csdx cm:branches --verbose",
+        "csdx cm:branches -k <stack api key>"
+      ],
+      "flags": {
+        "stack-api-key": {
+          "name": "stack-api-key",
+          "type": "option",
+          "char": "k",
+          "description": "Stack API Key",
+          "multiple": false
+        },
+        "verbose": {
+          "name": "verbose",
+          "type": "boolean",
+          "description": "Verbose",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "cm:branches:merge": {
+      "id": "cm:branches:merge",
+      "description": "Merge changes from a branch",
+      "strict": true,
+      "usage": "cm:branches:merge [-k <value>][--compare-branch <value>] [--no-revert] [--export-summary-path <value>] [--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]",
+      "pluginName": "@contentstack/cli-cm-branches",
+      "pluginAlias": "@contentstack/cli-cm-branches",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "csdx cm:branches:merge --stack-api-key bltxxxxxxxx --compare-branch feature-branch",
+        "csdx cm:branches:merge --stack-api-key bltxxxxxxxx --comment \"merge comment\"",
+        "csdx cm:branches:merge -k bltxxxxxxxx --base-branch base-branch",
+        "csdx cm:branches:merge --export-summary-path file/path",
+        "csdx cm:branches:merge --use-merge-summary file-path",
+        "csdx cm:branches:merge -k bltxxxxxxxx --no-revert",
+        "csdx cm:branches:merge -k bltxxxxxxxx --compare-branch feature-branch --no-revert"
+      ],
+      "flags": {
+        "compare-branch": {
+          "name": "compare-branch",
+          "type": "option",
+          "description": "Compare branch name",
+          "multiple": false
+        },
+        "base-branch": {
+          "name": "base-branch",
+          "type": "option",
+          "description": "Base branch",
+          "multiple": false
+        },
+        "comment": {
+          "name": "comment",
+          "type": "option",
+          "description": "Merge comment",
+          "multiple": false
+        },
+        "stack-api-key": {
+          "name": "stack-api-key",
+          "type": "option",
+          "char": "k",
+          "description": "Provide Stack API key to show difference between branches",
+          "multiple": false
+        },
+        "export-summary-path": {
+          "name": "export-summary-path",
+          "type": "option",
+          "description": "Export summary file path",
+          "multiple": false
+        },
+        "use-merge-summary": {
+          "name": "use-merge-summary",
+          "type": "option",
+          "description": "Path of merge summary file",
+          "multiple": false
+        },
+        "no-revert": {
+          "name": "no-revert",
+          "type": "boolean",
+          "description": "If passed, will not create the new revert branch",
+          "allowNo": false
+        },
+        "strategy": {
+          "name": "strategy",
+          "type": "option",
+          "description": "Merge strategy",
+          "hidden": true,
+          "multiple": false,
+          "options": [
+            "merge_prefer_base",
+            "merge_prefer_compare",
+            "overwrite_with_compare",
+            "custom_preferences"
+          ]
+        },
+        "strategy-sub-options": {
+          "name": "strategy-sub-options",
+          "type": "option",
+          "description": "Merge strategy sub options",
+          "hidden": true,
+          "multiple": false,
+          "options": [
+            "new",
+            "modified",
+            "both"
+          ]
+        },
+        "merge-action": {
+          "name": "merge-action",
+          "type": "option",
+          "description": "Merge strategy",
+          "hidden": true,
+          "multiple": false,
+          "options": [
+            "export",
+            "execute",
+            "both"
+          ]
+        }
+      },
+      "args": {}
+    }
+  }
+}

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "@contentstack/cli-cm-branches",
+  "description": "Contentstack CLI plugin to do branches operations",
+  "version": "1.0.0",
+  "author": "Contentstack",
+  "bugs": "https://github.com/contentstack/cli/issues",
+  "dependencies": {
+    "@contentstack/cli-command": "^1.2.3",
+    "@contentstack/cli-utilities": "^1.4.0",
+    "@oclif/command": "^1.8.16",
+    "@oclif/config": "^1.18.3",
+    "@oclif/core": "^2.3.0",
+    "async": "^3.2.4",
+    "big-json": "^3.2.0",
+    "bluebird": "^3.7.2",
+    "chalk": "^4.1.2",
+    "is-valid-path": "^0.1.1",
+    "just-diff": "^6.0.2",
+    "lodash": "^4.17.20",
+    "merge": "^2.1.1",
+    "mkdirp": "^1.0.4",
+    "path": "^0.12.7",
+    "progress-stream": "^2.0.0",
+    "promise-limit": "^2.7.0",
+    "proxyquire": "^2.1.3",
+    "tslib": "^2.4.1",
+    "winston": "^3.7.2"
+  },
+  "devDependencies": {
+    "@contentstack/cli-auth": "^1.2.0",
+    "@contentstack/cli-config": "^1.2.0",
+    "@contentstack/cli-dev-dependencies": "^1.2.0",
+    "@oclif/plugin-help": "^5.1.19",
+    "@oclif/test": "^1.2.6",
+    "@types/flat": "^5.0.2",
+    "assert": "^2.0.0",
+    "chai": "^4.2.0",
+    "dotenv": "^16.0.1",
+    "dotenv-expand": "^9.0.0",
+    "eslint": "^8.18.0",
+    "eslint-config-oclif": "^4.0.0",
+    "globby": "^10.0.2",
+    "mocha": "10.1.0",
+    "nyc": "^15.1.0",
+    "oclif": "^3.1.2",
+    "sinon": "^15.0.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.3"
+  },
+  "scripts": {
+    "build": "npm run clean && npm run compile",
+    "clean": "rm -rf ./lib ./node_modules tsconfig.build.tsbuildinfo",
+    "compile": "tsc -b tsconfig.json",
+    "postpack": "rm -f oclif.manifest.json",
+    "prepack": "pnpm compile && oclif manifest && oclif readme",
+    "version": "oclif readme && git add README.md",
+    "test:report": "tsc -p test && nyc --reporter=lcov --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+    "pretest": "tsc -p test",
+    "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+    "posttest": "npm run lint",
+    "lint": "eslint src/**/*.ts",
+    "format": "eslint src/**/*.ts --fix",
+    "test:integration": "mocha --forbid-only \"test/integration/*.test.ts\"",
+    "test:unit": "mocha --forbid-only \"test/unit/**/*.test.ts\"",
+    "test:unit:report": "nyc --extension .ts mocha --forbid-only \"test/unit/**/*.test.ts\""
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "files": [
+    "/lib",
+    "/messages",
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/contentstack/cli",
+  "keywords": [
+    "contentstack",
+    "cli",
+    "plugin"
+  ],
+  "license": "MIT",
+  "main": "./lib/commands/cm/stacks/export.js",
+  "types": "./types/index.d.ts",
+  "oclif": {
+    "commands": "./lib/commands",
+    "bin": "csdx",
+    "repositoryPrefix": "<%- repo %>/blob/main/packages/contentstack-export/<%- commandPath %>"
+  },
+  "csdxConfig": {},
+  "repository": "https://github.com/contentstack/cli"
+}