@jayree/sfdx-plugin-manifest 2.7.4 → 2.8.0

package/messages/{gitdiffbeta.md → gitdiff.md}

@@ -38,6 +38,13 @@ You can use all ways to spell <commit> which are valid for 'git diff' (See https
 
   <%= config.bin %> <%= command.id %> --source-dir force-app -- <commit> <commit>
 
+# args.ref1.description
+
+Base commit or branch.
+
+# args.ref2.description
+
+Commit or branch to compare to the base commit.
 
 # flags.output-dir.summary
 

package/messages/manifestcleanup.md

@@ -0,0 +1,21 @@
+# summary
+
+Removes those tags from a manifest file that are present in a second manifest file.
+
+# description
+
+Use this command to remove components or metadata types from a manifes file.
+
+If the 'cleanup' manifest file (--file) doesn't exist, a template file is created, which can then be modified.
+
+# examples
+
+<%= config.bin %> <%= command.id %> --manifest=package.xml --file=packageignore.xml
+
+# flags.manifest.summary
+
+Path to the manifest file.
+
+# flags.file.summary
+
+Path to the second 'cleanup' manifest file.

package/messages/manifestgenerate.md

@@ -0,0 +1,43 @@
+# summary
+
+Generate a complete manifest file form the specified org.
+
+# description
+
+Use this command to generate a manifest file based on an existing org.
+
+# examples
+
+<%= config.bin %> <%= command.id %> --targetusername myOrg@example.com
+
+<?xml version='1.0' encoding='UTF-8'?>
+
+<Package xmlns='http://soap.sforce.com/2006/04/metadata'>...</Package>
+
+# flags.quick-filter.summary
+
+Metadata type, member or file path to filter on.
+
+# flags.match-case.summary
+
+Enable 'match case' for the quickfilter.
+
+# flags.match-whole-word.summary
+
+Enable 'match whole word' for the quickfilter.
+
+# flags.file.summary
+
+Write to 'file' instead of stdout.
+
+# flags.exclude-managed.summary
+
+Exclude managed packages from output.
+
+# flags.exclude-all.summary
+
+Exclude all packages from output.
+
+# flags.include-flow-versions.summary
+
+Include flow versions as with api version 43.0.

package/oclif.manifest.json

@@ -1,377 +1,235 @@
 {
-  "version": "2.7.4",
+  "version": "2.8.0",
   "commands": {
     "jayree:manifest:cleanup": {
       "id": "jayree:manifest:cleanup",
-      "description": "removes those tags from a manifest file that are present in a second manifest file\nUse this command to remove components or metadata types from a manifes file.\nIf the 'cleanup' manifest file (--file) doesn't exist, a template file is created, which can then be modified.",
+      "summary": "Removes those tags from a manifest file that are present in a second manifest file.",
+      "description": "Use this command to remove components or metadata types from a manifes file.\n\nIf the 'cleanup' manifest file (--file) doesn't exist, a template file is created, which can then be modified.",
       "strict": true,
-      "usage": "<%= command.id %> [-x <filepath>] [-f <filepath>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
       "pluginName": "@jayree/sfdx-plugin-manifest",
       "pluginAlias": "@jayree/sfdx-plugin-manifest",
       "pluginType": "core",
       "aliases": [],
       "examples": [
-        "$ sfdx jayree:manifest:cleanup --manifest=package.xml --file=packageignore.xml"
+        "<%= config.bin %> <%= command.id %> --manifest=package.xml --file=packageignore.xml"
       ],
       "flags": {
         "json": {
           "name": "json",
           "type": "boolean",
-          "description": "format output as json",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
           "allowNo": false
         },
-        "loglevel": {
-          "name": "loglevel",
-          "type": "option",
-          "description": "logging level for this command invocation",
-          "required": false,
-          "helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
-          "multiple": false,
-          "options": [
-            "trace",
-            "debug",
-            "info",
-            "warn",
-            "error",
-            "fatal",
-            "TRACE",
-            "DEBUG",
-            "INFO",
-            "WARN",
-            "ERROR",
-            "FATAL"
-          ],
-          "default": "warn"
-        },
         "manifest": {
           "name": "manifest",
           "type": "option",
           "char": "x",
-          "description": "path to the manifest file",
+          "summary": "Path to the manifest file.",
           "multiple": false
         },
         "file": {
           "name": "file",
           "type": "option",
           "char": "f",
-          "description": "path to the second 'cleanup' manifest file",
+          "summary": "Path to the second 'cleanup' manifest file.",
+          "required": true,
           "multiple": false
         }
       },
       "args": {},
-      "flagsConfig": {
-        "manifest": {
-          "kind": "filepath",
-          "char": "x",
-          "description": "path to the manifest file",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "file": {
-          "kind": "filepath",
-          "char": "f",
-          "description": "path to the second 'cleanup' manifest file",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        }
-      },
-      "requiresUsername": false,
-      "supportsDevhubUsername": false,
       "requiresProject": true
     },
     "jayree:manifest:generate": {
       "id": "jayree:manifest:generate",
-      "description": "generate a complete manifest file form the specified org\nUse this command to generate a manifest file based on an existing org.",
+      "summary": "Generate a complete manifest file form the specified org.",
+      "description": "Use this command to generate a manifest file based on an existing org.",
       "strict": true,
-      "usage": "<%= command.id %> [-q <array>] [-c] [-w] [--includeflowversions] [-f <string>] [-x | -a] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
       "pluginName": "@jayree/sfdx-plugin-manifest",
       "pluginAlias": "@jayree/sfdx-plugin-manifest",
       "pluginType": "core",
       "aliases": [],
       "examples": [
-        "$ sfdx jayree:manifest:generate --targetusername myOrg@example.com",
-        "<?xml version='1.0' encoding='UTF-8'?>",
-        "<Package xmlns='http://soap.sforce.com/2006/04/metadata'>...</Package>"
+        "<%= config.bin %> <%= command.id %> --targetusername myOrg@example.com\n\n<?xml version='1.0' encoding='UTF-8'?>\n\n<Package xmlns='http://soap.sforce.com/2006/04/metadata'>...</Package>"
       ],
       "flags": {
         "json": {
           "name": "json",
           "type": "boolean",
-          "description": "format output as json",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
           "allowNo": false
         },
-        "loglevel": {
-          "name": "loglevel",
+        "target-org": {
+          "name": "target-org",
           "type": "option",
-          "description": "logging level for this command invocation",
-          "required": false,
-          "helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
+          "char": "o",
+          "summary": "Username or alias of the target org.",
+          "required": true,
           "multiple": false,
-          "options": [
-            "trace",
-            "debug",
-            "info",
-            "warn",
-            "error",
-            "fatal",
-            "TRACE",
-            "DEBUG",
-            "INFO",
-            "WARN",
-            "ERROR",
-            "FATAL"
-          ],
-          "default": "warn"
-        },
-        "targetusername": {
-          "name": "targetusername",
-          "type": "option",
-          "char": "u",
-          "description": "username or alias for the target org; overrides default target org",
-          "multiple": false
+          "aliases": [
+            "targetusername",
+            "u"
+          ]
         },
-        "apiversion": {
-          "name": "apiversion",
+        "api-version": {
+          "name": "api-version",
           "type": "option",
-          "description": "override the api version used for api requests made by this command",
-          "multiple": false
+          "description": "Override the api version used for api requests made by this command",
+          "multiple": false,
+          "aliases": [
+            "apiversion"
+          ]
         },
-        "quickfilter": {
-          "name": "quickfilter",
+        "quick-filter": {
+          "name": "quick-filter",
           "type": "option",
           "char": "q",
-          "description": "csv separated list of metadata type, member or file names to filter on",
-          "multiple": false
+          "description": "Metadata type, member or file path to filter on.",
+          "multiple": true,
+          "aliases": [
+            "quickfilter"
+          ],
+          "delimiter": ","
         },
-        "matchcase": {
-          "name": "matchcase",
+        "match-case": {
+          "name": "match-case",
           "type": "boolean",
           "char": "c",
-          "description": "enable 'match case' for the quickfilter",
-          "allowNo": false
+          "summary": "Enable 'match case' for the quickfilter.",
+          "allowNo": false,
+          "aliases": [
+            "matchcase"
+          ]
         },
-        "matchwholeword": {
-          "name": "matchwholeword",
+        "match-whole-word": {
+          "name": "match-whole-word",
           "type": "boolean",
           "char": "w",
-          "description": "enable 'match whole word' for the quickfilter",
-          "allowNo": false
+          "summary": "Enable 'match whole word' for the quickfilter.",
+          "allowNo": false,
+          "aliases": [
+            "matchwholeword"
+          ]
         },
-        "includeflowversions": {
-          "name": "includeflowversions",
+        "include-flow-versions": {
+          "name": "include-flow-versions",
           "type": "boolean",
-          "description": "include flow versions as with api version 43.0",
-          "allowNo": false
+          "summary": "Include flow versions as with api version 43.0.",
+          "allowNo": false,
+          "aliases": [
+            "includeflowversions"
+          ]
         },
         "file": {
           "name": "file",
           "type": "option",
           "char": "f",
-          "description": "write to 'file' instead of stdout",
+          "summary": "Write to 'file' instead of stdout.",
           "multiple": false
         },
-        "excludemanaged": {
-          "name": "excludemanaged",
+        "exclude-managed": {
+          "name": "exclude-managed",
           "type": "boolean",
-          "char": "x",
-          "description": "exclude managed packages from output",
+          "summary": "Exclude managed packages from output.",
           "allowNo": false,
           "exclusive": [
-            "excludeall"
+            "exclude-all"
+          ],
+          "aliases": [
+            "excludemanaged",
+            "x"
           ]
         },
-        "excludeall": {
-          "name": "excludeall",
+        "exclude-all": {
+          "name": "exclude-all",
           "type": "boolean",
-          "char": "a",
-          "description": "exclude all packages from output",
+          "summary": "Exclude all packages from output.",
           "allowNo": false,
           "exclusive": [
-            "excludemanaged"
+            "exclude-managed"
+          ],
+          "aliases": [
+            "excludeall",
+            "a"
           ]
         }
       },
       "args": {},
-      "flagsConfig": {
-        "quickfilter": {
-          "kind": "array",
-          "char": "q",
-          "description": "csv separated list of metadata type, member or file names to filter on",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "matchcase": {
-          "kind": "boolean",
-          "char": "c",
-          "description": "enable 'match case' for the quickfilter",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "matchwholeword": {
-          "kind": "boolean",
-          "char": "w",
-          "description": "enable 'match whole word' for the quickfilter",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "includeflowversions": {
-          "kind": "boolean",
-          "description": "include flow versions as with api version 43.0",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "file": {
-          "kind": "string",
-          "char": "f",
-          "description": "write to 'file' instead of stdout",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "excludemanaged": {
-          "kind": "boolean",
-          "char": "x",
-          "description": "exclude managed packages from output",
-          "exclusive": [
-            "excludeall"
-          ],
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "excludeall": {
-          "kind": "boolean",
-          "char": "a",
-          "description": "exclude all packages from output",
-          "exclusive": [
-            "excludemanaged"
-          ],
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "requiresUsername": true,
-      "supportsDevhubUsername": false,
-      "requiresProject": false
+      "hasDynamicHelp": true
     },
     "jayree:manifest:git:diff": {
       "id": "jayree:manifest:git:diff",
-      "description": "create a manifest and destructiveChanges manifest using 'git diff' data\nUse this command to create a manifest and destructiveChanges manifest file based on the difference (git diff) of two git refs.\n\nYou can use all ways to spell <commit> which are valid for 'git diff'.\n(See https://git-scm.com/docs/git-diff)",
+      "summary": "Create a project manifest and destructiveChanges manifest that lists the metadata components you want to deploy or delete based on changes in your git history.",
+      "description": "Use this command to create a manifest and destructiveChanges manifest file based on the difference (git diff) of two git refs.\n\nYou can use all ways to spell <commit> which are valid for 'git diff' (See https://git-scm.com/docs/git-diff).",
       "strict": true,
-      "usage": "<%= command.id %> [-p <array>] [-o <string>] [-d] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
       "pluginName": "@jayree/sfdx-plugin-manifest",
       "pluginAlias": "@jayree/sfdx-plugin-manifest",
       "pluginType": "core",
       "aliases": [],
       "examples": [
-        "$ sfdx jayree:manifest:git:diff <commit> <commit>",
-        "$ sfdx jayree:manifest:git:diff <commit>..<commit>",
-        "uses the changes between two arbitrary <commit>",
-        "$ sfdx jayree:manifest:git:diff <commit>...<commit>",
-        "uses the changes on the branch containing and up to the second <commit>, starting at a common ancestor of both <commit>.",
-        "$ sfdx jayree:manifest:git:diff branchA..branchB",
-        "uses the diff of what is unique in branchB (REF2) and unique in branchA (REF1)",
-        "$ sfdx jayree:manifest:git:diff branchA...branchB",
-        "uses the diff of what is unique in branchB (REF2)"
+        "Uses the changes between two arbitrary <commit>.\n<%= config.bin %> <%= command.id %> <commit> <commit>\n<%= config.bin %> <%= command.id %> <commit>..<commit>",
+        "Uses the changes on the branch containing and up to the second <commit>, starting at a common ancestor of both <commit>.\n<%= config.bin %> <%= command.id %> <commit>...<commit>",
+        "Uses the diff of what is unique in branchB (REF2) and unique in branchA (REF1).\n<%= config.bin %> <%= command.id %> branchA..branchB",
+        "Uses the diff of what is unique in branchB (REF2).\n<%= config.bin %> <%= command.id %> branchA...branchB",
+        "Specify the flags before or after the REF args\n<%= config.bin %> <%= command.id %> --output-dir package <commit> <commit>\n<%= config.bin %> <%= command.id %> <commit> <commit> --output-dir package",
+        "If you specify the 'source-dir' flag before the REF args, use '--' to separate the args from the 'source-dir' values.\n<%= config.bin %> <%= command.id %> --source-dir force-app -- <commit> <commit>"
       ],
       "flags": {
         "json": {
           "name": "json",
           "type": "boolean",
-          "description": "format output as json",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
           "allowNo": false
         },
-        "loglevel": {
-          "name": "loglevel",
+        "source-dir": {
+          "name": "source-dir",
           "type": "option",
-          "description": "logging level for this command invocation",
-          "required": false,
-          "helpValue": "(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)",
-          "multiple": false,
-          "options": [
-            "trace",
-            "debug",
-            "info",
-            "warn",
-            "error",
-            "fatal",
-            "TRACE",
-            "DEBUG",
-            "INFO",
-            "WARN",
-            "ERROR",
-            "FATAL"
+          "char": "d",
+          "summary": "Path to the local source files to include in the manifest.",
+          "description": "The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its subdirectories).\n\nYou can specify this flag more than once.",
+          "multiple": true,
+          "aliases": [
+            "sourcepath",
+            "p"
           ],
-          "default": "warn"
-        },
-        "sourcepath": {
-          "name": "sourcepath",
-          "type": "option",
-          "char": "p",
-          "description": "comma-separated list of source file paths to limit the diff",
-          "multiple": false
+          "delimiter": ","
         },
-        "outputdir": {
-          "name": "outputdir",
+        "output-dir": {
+          "name": "output-dir",
           "type": "option",
-          "char": "o",
-          "description": "directory to save the created manifest files",
+          "summary": "Directory to save the created manifest files.",
+          "description": "The location can be an absolute path or relative to the current working directory.",
           "multiple": false,
-          "default": ""
+          "default": "",
+          "aliases": [
+            "outputdir",
+            "o"
+          ]
         },
-        "destructivechangesonly": {
-          "name": "destructivechangesonly",
+        "destructive-changes-only": {
+          "name": "destructive-changes-only",
           "type": "boolean",
-          "char": "d",
-          "description": "create a destructiveChanges manifest only (package.xml will be empty)",
-          "allowNo": false
+          "summary": "Create a destructiveChanges manifest only.",
+          "description": "Use this flag to create a 'destructiveChanges.xml' and a blank 'package.xml'.",
+          "allowNo": false,
+          "aliases": [
+            "destructivechangesonly"
+          ]
         }
       },
       "args": {
         "ref1": {
           "name": "ref1",
-          "description": "base commit or branch",
-          "required": true,
-          "hidden": false
+          "description": "Base commit or branch.",
+          "required": true
         },
         "ref2": {
           "name": "ref2",
-          "description": "commit or branch to compare to the base commit",
-          "required": false,
-          "hidden": false
+          "description": "Commit or branch to compare to the base commit."
         }
       },
-      "flagsConfig": {
-        "sourcepath": {
-          "kind": "array",
-          "char": "p",
-          "description": "comma-separated list of source file paths to limit the diff",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "outputdir": {
-          "kind": "string",
-          "char": "o",
-          "description": "directory to save the created manifest files",
-          "default": "",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "destructivechangesonly": {
-          "kind": "boolean",
-          "char": "d",
-          "description": "create a destructiveChanges manifest only (package.xml will be empty)",
-          "default": false,
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "requiresUsername": false,
-      "supportsDevhubUsername": false,
       "requiresProject": true
     },
     "jayree:manifest:beta:git:diff": {
@@ -418,7 +276,8 @@
           "aliases": [
             "sourcepath",
             "p"
-          ]
+          ],
+          "delimiter": ","
         },
         "output-dir": {
           "name": "output-dir",
@@ -446,12 +305,12 @@
       "args": {
         "ref1": {
           "name": "ref1",
-          "description": "base commit or branch",
+          "description": "Base commit or branch.",
           "required": true
         },
         "ref2": {
           "name": "ref2",
-          "description": "commit or branch to compare to the base commit"
+          "description": "Commit or branch to compare to the base commit."
         }
       },
       "requiresProject": true