@terafina/tffa-sfdx-plugin 17.0.0-rc.9 → 18.0.0-rc.1

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "17.0.0-rc.9",
+  "version": "18.0.0-rc.1",
   "commands": {
     "tffa:apexdoc": {
       "id": "tffa:apexdoc",
@@ -71,7 +71,7 @@
           "char": "m",
           "description": "minimum api version to use during quality checks",
           "multiple": false,
-          "default": 56
+          "default": 57
         },
         "rulesetpath": {
           "name": "rulesetpath",
@@ -101,7 +101,6 @@
       "id": "tffa:meta",
       "description": "Scan a sfdx project for generating metadata summary information",
       "strict": true,
-      "usage": "<%= command.id %> [-s <directory>] [-d <directory>] [-c <directory>] [-o json|csv|human] [-f] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
       "pluginName": "@terafina/tffa-sfdx-plugin",
       "pluginAlias": "@terafina/tffa-sfdx-plugin",
       "pluginType": "core",
@@ -113,32 +112,10 @@
         "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"
-        },
         "sourcefolder": {
           "name": "sourcefolder",
           "type": "option",
@@ -168,7 +145,6 @@
           "type": "option",
           "char": "o",
           "description": "output format json csv human",
-          "helpValue": "(json|csv|human)",
           "multiple": false,
           "options": [
             "json",
@@ -184,63 +160,12 @@
           "allowNo": false
         }
       },
-      "args": {},
-      "flagsConfig": {
-        "sourcefolder": {
-          "kind": "directory",
-          "char": "s",
-          "description": "directory containing sfdx project",
-          "default": ".",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "destpath": {
-          "kind": "directory",
-          "char": "d",
-          "description": "full path output file",
-          "default": ".",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "clientname": {
-          "kind": "directory",
-          "char": "c",
-          "description": "name of the client",
-          "default": ".",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "output": {
-          "kind": "enum",
-          "helpValue": "(json|csv|human)",
-          "char": "o",
-          "options": [
-            "json",
-            "csv",
-            "human"
-          ],
-          "description": "output format json csv human",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "fields": {
-          "kind": "boolean",
-          "char": "f",
-          "description": "generate field output",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      }
+      "args": {}
     },
     "tffa:ping": {
       "id": "tffa:ping",
       "description": "Ping and test the plugin",
       "strict": true,
-      "usage": "<%= command.id %> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
       "pluginName": "@terafina/tffa-sfdx-plugin",
       "pluginAlias": "@terafina/tffa-sfdx-plugin",
       "pluginType": "core",
@@ -252,103 +177,42 @@
         "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"
-        }
-      },
-      "args": {
-        "file": {
-          "name": "file"
         }
       },
+      "args": {},
       "flagsConfig": {}
     },
     "tffa:data:export": {
       "id": "tffa:data:export",
       "description": "Exports records of specified sobject types from target org into JSON file(s). Primarily used for exporting business configurations.\nThe export command requires a target org for exporting records. Run this command from within a sfdx project containing a default username or specify targetusername explicitly.",
       "strict": true,
-      "usage": "<%= command.id %> -s <array> [-d <string>] [-g <string>] [-o <array>] [-c <array>] [-s] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
       "pluginName": "@terafina/tffa-sfdx-plugin",
       "pluginAlias": "@terafina/tffa-sfdx-plugin",
       "pluginType": "core",
       "aliases": [],
       "examples": [
-        "$ sfdx tffa:data:export --sobjecttype tffa__Product__c\n    Fetched 101 records of tffa__Product__c\n    Writing 24 records to ./data/configuration/Product__c.json\n    Writing 30 records to ./data/configuration/Product__c1.json\n    Writing 20 records to ./data/configuration/Product__c2.json\n    Writing 27 records to ./data/configuration/Product__c3.json\n    ",
-        "$ sfdx tffa:data:export --sobjecttype tffa__DisclosureTemplate__c,tffa__DisclosureChecklist__c,tffa__DisclosureMatrix__c\n    Fetched 81 records of tffa__DisclosureTemplate__c\n    Writing 81 records to ./data/configuration/DisclosureTemplate__c.json\n    Fetched 57 records of tffa__DisclosureChecklist__c\n    Writing 57 records to ./data/configuration/DisclosureChecklist__c.json\n    Fetched 144 records of tffa__DisclosureMatrix__c\n    Writing 144 records to ./data/configuration/DisclosureMatrix__c.json\n    "
+        "$ sfdx tffa:data:export --sobjecttypes tffa__Product__c\n    Fetched 101 records of tffa__Product__c\n    Writing 24 records to ./data/configuration/Product__c.json\n    Writing 30 records to ./data/configuration/Product__c1.json\n    Writing 20 records to ./data/configuration/Product__c2.json\n    Writing 27 records to ./data/configuration/Product__c3.json\n    ",
+        "$ sfdx tffa:data:export --sobjecttypes tffa__DisclosureTemplate__c,tffa__DisclosureChecklist__c,tffa__DisclosureMatrix__c\n    Fetched 81 records of tffa__DisclosureTemplate__c\n    Writing 81 records to ./data/configuration/DisclosureTemplate__c.json\n    Fetched 57 records of tffa__DisclosureChecklist__c\n    Writing 57 records to ./data/configuration/DisclosureChecklist__c.json\n    Fetched 144 records of tffa__DisclosureMatrix__c\n    Writing 144 records to ./data/configuration/DisclosureMatrix__c.json\n    "
       ],
       "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"
-        },
-        "targetusername": {
-          "name": "targetusername",
-          "type": "option",
-          "char": "u",
-          "description": "username or alias for the target org; overrides default target org",
-          "multiple": false
-        },
-        "apiversion": {
-          "name": "apiversion",
-          "type": "option",
-          "description": "override the api version used for api requests made by this command",
-          "multiple": false
-        },
         "sobjecttypes": {
           "name": "sobjecttypes",
           "type": "option",
           "char": "s",
           "description": "sobject types of records to be exported",
           "required": true,
-          "multiple": false
+          "multiple": true,
+          "delimiter": ","
         },
         "outputdir": {
           "name": "outputdir",
@@ -372,7 +236,8 @@
           "char": "o",
           "description": "the fields to be used for sorting the exported records",
           "required": false,
-          "multiple": false
+          "multiple": true,
+          "delimiter": ","
         },
         "children": {
           "name": "children",
@@ -380,80 +245,39 @@
           "char": "c",
           "description": "the child relationships to be included in the exported records; this is not required for tffa package objects. e.g. tffa__Features__r,tffa__Terms__r child relationships are auto included when running export command for tffa__Product__c",
           "required": false,
-          "multiple": false
+          "multiple": true,
+          "delimiter": ","
         },
         "skipconfigplan": {
           "name": "skipconfigplan",
           "type": "boolean",
-          "char": "s",
+          "char": "i",
           "description": "skip import of exported record JSON files into configuration plan",
           "required": false,
           "allowNo": false
+        },
+        "target-org": {
+          "name": "target-org",
+          "type": "option",
+          "char": "u",
+          "multiple": false
+        },
+        "api-version": {
+          "name": "api-version",
+          "type": "option",
+          "char": "a",
+          "description": "Override the api version used for api requests made by this command",
+          "multiple": false
         }
       },
       "args": {},
       "requiresUsername": true,
-      "flagsConfig": {
-        "sobjecttypes": {
-          "kind": "array",
-          "char": "s",
-          "required": true,
-          "description": "sobject types of records to be exported",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "outputdir": {
-          "kind": "string",
-          "char": "d",
-          "description": "output directory where the JSON files of exported records will be placed",
-          "default": "./data/configuration",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "groupby": {
-          "kind": "string",
-          "char": "g",
-          "required": false,
-          "description": "the field to be used for grouping the exported records; records belonging to each group are placed in separate JSON files (filename suffixed by group name)",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "orderby": {
-          "kind": "array",
-          "char": "o",
-          "required": false,
-          "description": "the fields to be used for sorting the exported records",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "children": {
-          "kind": "array",
-          "char": "c",
-          "required": false,
-          "description": "the child relationships to be included in the exported records; this is not required for tffa package objects. e.g. tffa__Features__r,tffa__Terms__r child relationships are auto included when running export command for tffa__Product__c",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "skipconfigplan": {
-          "kind": "boolean",
-          "char": "s",
-          "required": false,
-          "description": "skip import of exported record JSON files into configuration plan",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      }
+      "hasDynamicHelp": true
     },
     "tffa:data:import": {
       "id": "tffa:data:import",
       "description": "Imports data into an org using the SObject Bulk Upsert API.  This data can include master-detail relationships. Primarily used for importing business configurations.\n  \n  To generate JSON files for use with tffa:data:import, run \"sfdx tffa:data:export\"\n  \n  In scratch orgs, by default, sobject files are tracked for changes. When doing full plan imports (without the sobjecttypes parameter), individual sobject files are tracked for changes and excluded from import if the file content remained unchanged since the last time it was imported. This behaviour can be suppressed by including the forceimport flag when doing full plan imports.",
       "strict": true,
-      "usage": "<%= command.id %> [-f <array>] [-p <string>] [-s <array>] [-i] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
       "pluginName": "@terafina/tffa-sfdx-plugin",
       "pluginAlias": "@terafina/tffa-sfdx-plugin",
       "pluginType": "core",
@@ -468,52 +292,18 @@
         "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"
-        },
-        "targetusername": {
-          "name": "targetusername",
-          "type": "option",
-          "char": "u",
-          "description": "username or alias for the target org; overrides default target org",
-          "multiple": false
-        },
-        "apiversion": {
-          "name": "apiversion",
-          "type": "option",
-          "description": "override the api version used for api requests made by this command",
-          "multiple": false
-        },
         "sobjectfiles": {
           "name": "sobjectfiles",
           "type": "option",
           "char": "f",
           "description": "comma-delimited, ordered paths of json files containing collection of record trees to upsert",
           "required": false,
-          "multiple": false
+          "multiple": true,
+          "delimiter": ","
         },
         "plan": {
           "name": "plan",
@@ -529,7 +319,8 @@
           "char": "s",
           "description": "comma-delimited, list of sobject types to be imported when using a plan",
           "required": false,
-          "multiple": false
+          "multiple": true,
+          "delimiter": ","
         },
         "forceimport": {
           "name": "forceimport",
@@ -538,54 +329,30 @@
           "description": "force import all sobject files in a plan ignoring any internal file change tracking; applicable to scratch orgs only; forceimport is automatically set if sobjecttypes parameter is specified",
           "required": false,
           "allowNo": false
+        },
+        "target-org": {
+          "name": "target-org",
+          "type": "option",
+          "char": "u",
+          "multiple": false
+        },
+        "api-version": {
+          "name": "api-version",
+          "type": "option",
+          "char": "a",
+          "description": "Override the api version used for api requests made by this command",
+          "multiple": false
         }
       },
       "args": {},
       "requiresUsername": true,
       "requiresProject": true,
-      "flagsConfig": {
-        "sobjectfiles": {
-          "kind": "array",
-          "char": "f",
-          "required": false,
-          "description": "comma-delimited, ordered paths of json files containing collection of record trees to upsert",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "plan": {
-          "kind": "string",
-          "char": "p",
-          "description": "path to plan to upsert multiple data files that have master-detail relationships; to restrict the sobject types imported using the plan, specify sobjecttypes along with plan",
-          "default": "data/configuration/config-data-plan.json",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "sobjecttypes": {
-          "kind": "array",
-          "char": "s",
-          "required": false,
-          "description": "comma-delimited, list of sobject types to be imported when using a plan",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "forceimport": {
-          "kind": "boolean",
-          "char": "i",
-          "required": false,
-          "description": "force import all sobject files in a plan ignoring any internal file change tracking; applicable to scratch orgs only; forceimport is automatically set if sobjecttypes parameter is specified",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      }
+      "hasDynamicHelp": true
     },
     "tffa:source:apiset": {
       "id": "tffa:source:apiset",
       "description": "Upgrades the current project and all metadata to the latest API version",
       "strict": true,
-      "usage": "<%= command.id %> [-h <help>] [-s <directory>] [-a <integer>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
       "pluginName": "@terafina/tffa-sfdx-plugin",
       "pluginAlias": "@terafina/tffa-sfdx-plugin",
       "pluginType": "core",
@@ -597,37 +364,8 @@
         "json": {
           "name": "json",
           "type": "boolean",
-          "description": "format output as json",
-          "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"
-        },
-        "help": {
-          "name": "help",
-          "type": "boolean",
-          "char": "h",
-          "description": "Show CLI help.",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
           "allowNo": false
         },
         "sourcefolder": {
@@ -644,43 +382,15 @@
           "char": "a",
           "description": "specify the API version ",
           "multiple": false,
-          "default": 56
+          "default": 57
         }
       },
-      "args": {},
-      "flagsConfig": {
-        "help": {
-          "kind": "help",
-          "description": "Show CLI help.",
-          "char": "h",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "sourcefolder": {
-          "kind": "directory",
-          "char": "s",
-          "description": "directory containing sfdx project",
-          "default": ".",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "api": {
-          "kind": "integer",
-          "char": "a",
-          "description": "specify the API version ",
-          "default": 56,
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        }
-      }
+      "args": {}
     },
     "tffa:source:createfield": {
       "id": "tffa:source:createfield",
       "description": "Creates an SObject field from the specified parameters.\n  By default, created fields (except required) are added to all permission sets in the project. Use the permissionsets parameter to explicitly specify the permission sets.\n  \n  NOTE: this command does not create the field in the org, it only creates the field meta xml file in the project. source push is required for the field to be created in the org.\n  ",
       "strict": true,
-      "usage": "<%= command.id %> -s <string> -n <string> -t checkbox|currency|date|datetime|email|number|percent|phone|picklist|picklist-multi|text|textarea|textarea-long|textarea-rich [-r] [-l <number>] [-d <string>] [-p <array>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]",
       "pluginName": "@terafina/tffa-sfdx-plugin",
       "pluginAlias": "@terafina/tffa-sfdx-plugin",
       "pluginType": "core",
@@ -699,45 +409,10 @@
         "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"
-        },
-        "targetusername": {
-          "name": "targetusername",
-          "type": "option",
-          "char": "u",
-          "description": "username or alias for the target org; overrides default target org",
-          "multiple": false
-        },
-        "apiversion": {
-          "name": "apiversion",
-          "type": "option",
-          "description": "override the api version used for api requests made by this command",
-          "multiple": false
-        },
         "sobjecttype": {
           "name": "sobjecttype",
           "type": "option",
@@ -760,7 +435,6 @@
           "char": "t",
           "description": "type of the field",
           "required": true,
-          "helpValue": "(checkbox|currency|date|datetime|email|number|percent|phone|picklist|picklist-multi|text|textarea|textarea-long|textarea-rich)",
           "multiple": false,
           "options": [
             "checkbox",
@@ -810,7 +484,8 @@
           "char": "p",
           "description": "comma-separated list of permission sets to which the field needs to be added; defaults to all permission sets in the project",
           "required": false,
-          "multiple": false
+          "multiple": true,
+          "delimiter": ","
         },
         "valuesetname": {
           "name": "valuesetname",
@@ -823,99 +498,7 @@
       },
       "args": {},
       "requiresUsername": true,
-      "requiresProject": true,
-      "flagsConfig": {
-        "sobjecttype": {
-          "kind": "string",
-          "char": "s",
-          "required": true,
-          "description": "the API name of the object for which the field needs to be created",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "name": {
-          "kind": "string",
-          "char": "n",
-          "required": true,
-          "description": "the API name of the field",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "type": {
-          "kind": "enum",
-          "helpValue": "(checkbox|currency|date|datetime|email|number|percent|phone|picklist|picklist-multi|text|textarea|textarea-long|textarea-rich)",
-          "char": "t",
-          "required": true,
-          "description": "type of the field",
-          "default": "text",
-          "options": [
-            "checkbox",
-            "currency",
-            "date",
-            "datetime",
-            "email",
-            "number",
-            "percent",
-            "phone",
-            "picklist",
-            "picklist-multi",
-            "text",
-            "textarea",
-            "textarea-long",
-            "textarea-rich"
-          ],
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "required": {
-          "kind": "boolean",
-          "char": "r",
-          "required": false,
-          "description": "whether field is required; skips addition to permission sets",
-          "default": false,
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "length": {
-          "kind": "number",
-          "char": "l",
-          "required": false,
-          "description": "length of text field or textarea (long|rich) field; defaults to 255 for text field and 1024 for textarea field",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "description": {
-          "kind": "string",
-          "char": "d",
-          "required": false,
-          "description": "description of the field",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "permissionsets": {
-          "kind": "array",
-          "char": "p",
-          "required": false,
-          "description": "comma-separated list of permission sets to which the field needs to be added; defaults to all permission sets in the project",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        },
-        "valuesetname": {
-          "kind": "string",
-          "char": "v",
-          "required": false,
-          "description": "name of the global value set if the field is a picklist or multi-select picklist type",
-          "input": [],
-          "multiple": false,
-          "type": "option"
-        }
-      }
+      "requiresProject": true
     }
   }
 }