sf-decomposer 4.0.0

package/oclif.manifest.json

@@ -0,0 +1,166 @@
+{
+  "commands": {
+    "decomposer:decompose": {
+      "aliases": [],
+      "args": {},
+      "description": "This command will read all of the original metadata files and separate them into smaller files.\n\nThese smaller decomposed files can be XMLs, YAMLs, or JSONs.\n\nYou should use this to create files for version control after retrieving metadata from an org.",
+      "examples": [
+        "`sf decomposer decompose -m \"flow\" -f \"xml\" --prepurge --postpurge --debug`",
+        "`sf decomposer decompose -m \"flow\" -m \"labels\" -f \"xml\" --prepurge --postpurge --debug`"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "metadata-type": {
+          "char": "m",
+          "name": "metadata-type",
+          "required": true,
+          "summary": "The metadata suffix to process, such as 'flow', 'labels', etc. You can provide this flag multiple times to process multiple metadata types at once.",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "prepurge": {
+          "name": "prepurge",
+          "required": false,
+          "summary": "If provided, purge directories of pre-existing decomposed files.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "postpurge": {
+          "name": "postpurge",
+          "required": false,
+          "summary": "If provided, purge the original files after decomposing them.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "debug": {
+          "name": "debug",
+          "required": false,
+          "summary": "If provided, debug to log file.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "format": {
+          "char": "f",
+          "name": "format",
+          "required": true,
+          "summary": "File format for the decomposed files.",
+          "default": "xml",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "xml",
+            "json",
+            "yaml"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "decomposer:decompose",
+      "pluginAlias": "sf-decomposer",
+      "pluginName": "sf-decomposer",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Decomposes the metadata files created by retrievals.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "decomposer",
+        "decompose.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "decomposer:decompose",
+        "decompose:decomposer"
+      ]
+    },
+    "decomposer:recompose": {
+      "aliases": [],
+      "args": {},
+      "description": "This command will read all of the decomposed files and recreate deployment compatible metadata files in each package directory.\n\nYou should run this before you deploy the metadata to an org.",
+      "examples": [
+        "`sf decomposer recompose -m \"flow\" -f \"xml\" --postpurge --debug`",
+        "`sf decomposer recompose -m \"flow\" -m \"labels\" -f \"xml\" --postpurge --debug`"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "metadata-type": {
+          "char": "m",
+          "name": "metadata-type",
+          "required": true,
+          "summary": "The metadata suffix to process, such as 'flow', 'labels', etc. You can provide this flag multiple times to process multiple metadata types at once.",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "postpurge": {
+          "name": "postpurge",
+          "required": false,
+          "summary": "If provided, purge the decomposed files after recomposing them.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "debug": {
+          "name": "debug",
+          "required": false,
+          "summary": "If provided, debug to log file.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "format": {
+          "char": "f",
+          "name": "format",
+          "required": true,
+          "summary": "File format for the decomposed files.",
+          "default": "xml",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "xml",
+            "json",
+            "yaml"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "decomposer:recompose",
+      "pluginAlias": "sf-decomposer",
+      "pluginName": "sf-decomposer",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Recomposes the files created by the `decompose` command prior to deployments.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "decomposer",
+        "recompose.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "decomposer:recompose",
+        "recompose:decomposer"
+      ]
+    }
+  },
+  "version": "4.0.0"
+}

package/package.json

@@ -0,0 +1,202 @@
+{
+  "name": "sf-decomposer",
+  "description": "Decomposes Salesforce metadata into more manageable files.",
+  "version": "4.0.0",
+  "dependencies": {
+    "@oclif/core": "^3.26.0",
+    "@salesforce/core": "^6.5.3",
+    "@salesforce/sf-plugins-core": "^7.1.9",
+    "@salesforce/source-deploy-retrieve": "^10.7.1",
+    "fs-extra": "^11.2.0",
+    "simple-git": "^3.24.0",
+    "xml-disassembler": "^1.2.10",
+    "xml2json-disassembler": "^1.0.4",
+    "xml2yaml-disassembler": "^1.0.2"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^18.6.1",
+    "@commitlint/config-conventional": "^18.6.3",
+    "@oclif/plugin-command-snapshot": "^5.0.8",
+    "@salesforce/cli-plugins-testkit": "^5.1.13",
+    "@salesforce/dev-scripts": "^8.3.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^11.1.0",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^9.2.6",
+    "@semantic-release/npm": "^11.0.2",
+    "@semantic-release/release-notes-generator": "^12.1.0",
+    "@types/fs-extra": "^11.0.4",
+    "eslint-plugin-sf-plugin": "^1.17.5",
+    "husky": "^9.0.11",
+    "oclif": "^4.4.10",
+    "semantic-release": "^17.4.7",
+    "shx": "0.3.4",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.2"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "/lib",
+    "/messages",
+    "/oclif.manifest.json",
+    "/oclif.lock"
+  ],
+  "keywords": [
+    "force",
+    "salesforce",
+    "salesforcedx",
+    "sf",
+    "sf-plugin",
+    "sfdx",
+    "sfdx-plugin",
+    "git"
+  ],
+  "license": "MIT",
+  "oclif": {
+    "commands": "./lib/commands",
+    "bin": "sf",
+    "topicSeparator": " ",
+    "devPlugins": [
+      "@oclif/plugin-help"
+    ],
+    "hooks": {
+      "scopedPostRetrieve": "./lib/hooks/scopedPostRetrieve"
+    },
+    "flexibleTaxonomy": true
+  },
+  "scripts": {
+    "command-docs": "oclif readme",
+    "build": "tsc -b",
+    "clean": "sf-clean",
+    "clean-all": "sf-clean all",
+    "clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json oclif.lock",
+    "compile": "sf-compile",
+    "docs": "sf-docs",
+    "format": "sf-format",
+    "lint": "wireit",
+    "postpack": "shx rm -f oclif.manifest.json oclif.lock",
+    "prepack": "sf-prepack",
+    "prepare": "husky install",
+    "test": "wireit",
+    "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
+    "test:only": "wireit",
+    "version": "oclif readme"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "wireit": {
+    "build": {
+      "dependencies": [
+        "compile",
+        "lint"
+      ]
+    },
+    "compile": {
+      "command": "tsc -p . --pretty --incremental",
+      "files": [
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        "messages/**"
+      ],
+      "output": [
+        "lib/**",
+        "*.tsbuildinfo"
+      ],
+      "clean": "if-file-deleted"
+    },
+    "format": {
+      "command": "prettier --write \"+(src|test|schemas)/**/*.+(ts|js|json)|command-snapshot.json\"",
+      "files": [
+        "src/**/*.ts",
+        "test/**/*.ts",
+        "schemas/**/*.json",
+        "command-snapshot.json",
+        ".prettier*"
+      ],
+      "output": []
+    },
+    "lint": {
+      "command": "eslint src test --color --cache --cache-location .eslintcache",
+      "files": [
+        "src/**/*.ts",
+        "test/**/*.ts",
+        "messages/**",
+        "**/.eslint*",
+        "**/tsconfig.json"
+      ],
+      "output": []
+    },
+    "test:compile": {
+      "command": "tsc -p \"./test\" --pretty",
+      "files": [
+        "test/**/*.ts",
+        "**/tsconfig.json"
+      ],
+      "output": []
+    },
+    "test": {
+      "dependencies": [
+        "test:compile",
+        "test:only",
+        "lint"
+      ]
+    },
+    "test:only": {
+      "command": "nyc mocha \"test/**/*.test.ts\"",
+      "env": {
+        "FORCE_COLOR": "2"
+      },
+      "files": [
+        "test/**/*.ts",
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        ".mocha*",
+        "!*.nut.ts",
+        ".nycrc"
+      ],
+      "output": []
+    },
+    "test:command-reference": {
+      "command": "\"./bin/dev\" commandreference:generate --erroronwarnings",
+      "files": [
+        "src/**/*.ts",
+        "messages/**",
+        "package.json"
+      ],
+      "output": [
+        "tmp/root"
+      ]
+    },
+    "test:deprecation-policy": {
+      "command": "\"./bin/dev\" snapshot:compare",
+      "files": [
+        "src/**/*.ts"
+      ],
+      "output": [],
+      "dependencies": [
+        "compile"
+      ]
+    },
+    "test:json-schema": {
+      "command": "\"./bin/dev\" schema:compare",
+      "files": [
+        "src/**/*.ts",
+        "schemas"
+      ],
+      "output": []
+    }
+  },
+  "exports": "./lib/index.js",
+  "type": "module",
+  "author": "Matt Carvin",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mcarvin8/sf-decomposer.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mcarvin8/sf-decomposer/issues"
+  }
+}