@terafina/tffa-sfdx-plugin 19.0.1 → 20.0.0-rc.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -13
- package/lib/commands/tffa/apexdoc.js.map +1 -1
- package/lib/commands/tffa/data/export.js.map +1 -1
- package/lib/commands/tffa/data/import.js.map +1 -1
- package/lib/commands/tffa/lint.js.map +1 -1
- package/lib/commands/tffa/meta.js.map +1 -1
- package/lib/commands/tffa/source/apiset.js.map +1 -1
- package/lib/commands/tffa/source/createfield.js.map +1 -1
- package/lib/services/apexdoc/common/array-utils.js.map +1 -1
- package/lib/services/apexdoc/common/line-reader.js.map +1 -1
- package/lib/services/apexdoc/common/models/apex-model.js.map +1 -1
- package/lib/services/apexdoc/common/models/class-group.js.map +1 -1
- package/lib/services/apexdoc/common/models/class-model.js.map +1 -1
- package/lib/services/apexdoc/common/models/engine-config.js.map +1 -1
- package/lib/services/apexdoc/common/models/enum-model.js.map +1 -1
- package/lib/services/apexdoc/common/models/method-model.js.map +1 -1
- package/lib/services/apexdoc/common/models/property-model.js.map +1 -1
- package/lib/services/apexdoc/common/settings.js.map +1 -1
- package/lib/services/apexdoc/common/tags.js +3 -3
- package/lib/services/apexdoc/common/tags.js.map +1 -1
- package/lib/services/apexdoc/common/utils.js.map +1 -1
- package/lib/services/apexdoc/common/validator-engine.js.map +1 -1
- package/lib/services/apexdoc/common/validator.js.map +1 -1
- package/lib/services/apexdoc/engine/file-manager.js.map +1 -1
- package/lib/services/apexdoc/engine/generators/generator-utils.js.map +1 -1
- package/lib/services/apexdoc/engine/generators/menu-generator.js.map +1 -1
- package/lib/services/apexdoc/engine/generators/models/child-enum-markup-generator.js.map +1 -1
- package/lib/services/apexdoc/engine/generators/models/class-markup-generator.js.map +1 -1
- package/lib/services/apexdoc/engine/generators/models/markup-generator.js.map +1 -1
- package/lib/services/apexdoc/engine/generators/models/method-markup-generator.js.map +1 -1
- package/lib/services/apexdoc/engine/generators/models/property-markup-generator.js.map +1 -1
- package/lib/services/apexdoc/engine/generators/models/source-markup-generator.js.map +1 -1
- package/lib/services/apexdoc/engine/generators/models/top-level-markup-generator.js.map +1 -1
- package/lib/services/apexdoc/engine/generators/see-link-generator.js.map +1 -1
- package/lib/services/lint/apex-class-scan.js.map +1 -1
- package/lib/services/lint/apex-pmd.js.map +1 -1
- package/lib/services/lint/eslint-scan.js.map +1 -1
- package/lib/services/lint/metadata-scan.js.map +1 -1
- package/lib/services/lint/stylelint-scan.js.map +1 -1
- package/lib/services/meta/field-scan.js.map +1 -1
- package/lib/utils/constants.js +1 -1
- package/lib/utils/ignored-files.js.map +1 -1
- package/lib/utils/jreSetupManager.js.map +1 -1
- package/oclif.manifest.json +316 -194
- package/package.json +40 -40
package/oclif.manifest.json
CHANGED
|
@@ -1,287 +1,354 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "19.0.1",
|
|
3
2
|
"commands": {
|
|
4
3
|
"tffa:apexdoc": {
|
|
5
|
-
"id": "tffa:apexdoc",
|
|
6
|
-
"description": "Command to generate apex documentation similar to javadoc based on the comments in apex classes.\nPlease read more at [Documenting Apex Classes](development-guidelines/documentation).\nOnce generated you can use vscode plugin [Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) and select index.html from generated folder and run Open with LiveServer to render the html",
|
|
7
|
-
"strict": true,
|
|
8
|
-
"pluginName": "@terafina/tffa-sfdx-plugin",
|
|
9
|
-
"pluginAlias": "@terafina/tffa-sfdx-plugin",
|
|
10
|
-
"pluginType": "core",
|
|
11
4
|
"aliases": [],
|
|
5
|
+
"args": {},
|
|
6
|
+
"description": "Command to generate apex documentation similar to javadoc based on the comments in apex classes.\nPlease read more at [Documenting Apex Classes](development-guidelines/documentation).\nOnce generated you can use vscode plugin [Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) and select index.html from generated folder and run Open with LiveServer to render the html",
|
|
12
7
|
"examples": [
|
|
13
8
|
"$ sf tffa:apexdoc"
|
|
14
9
|
],
|
|
15
10
|
"flags": {
|
|
16
11
|
"json": {
|
|
17
|
-
"name": "json",
|
|
18
|
-
"type": "boolean",
|
|
19
12
|
"description": "Format output as json.",
|
|
20
13
|
"helpGroup": "GLOBAL",
|
|
21
|
-
"
|
|
14
|
+
"name": "json",
|
|
15
|
+
"allowNo": false,
|
|
16
|
+
"type": "boolean"
|
|
22
17
|
},
|
|
23
18
|
"sourcefolder": {
|
|
24
|
-
"name": "sourcefolder",
|
|
25
|
-
"type": "option",
|
|
26
19
|
"char": "s",
|
|
27
20
|
"description": "directory containing sfdx project",
|
|
21
|
+
"name": "sourcefolder",
|
|
22
|
+
"default": ".",
|
|
23
|
+
"hasDynamicHelp": false,
|
|
28
24
|
"multiple": false,
|
|
29
|
-
"
|
|
25
|
+
"type": "option"
|
|
30
26
|
},
|
|
31
27
|
"destfolder": {
|
|
32
|
-
"name": "destfolder",
|
|
33
|
-
"type": "option",
|
|
34
28
|
"char": "d",
|
|
35
29
|
"description": "directory to generate the api docs",
|
|
36
|
-
"
|
|
30
|
+
"name": "destfolder",
|
|
31
|
+
"hasDynamicHelp": false,
|
|
32
|
+
"multiple": false,
|
|
33
|
+
"type": "option"
|
|
37
34
|
}
|
|
38
35
|
},
|
|
39
|
-
"
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
"id": "tffa:lint",
|
|
43
|
-
"description": "Scans a sfdx project and provide a violations report based on defined standards.\nPerforms static analysis of source code with a command-line interface and report output.\nThe command creates \"Rule Violations\" when the it identifies issues. Developers use this information as feedback to fix their code.\n\nThe rules used in the lint command are:\n\n- [Apex PMD](https://pmd.github.io/latest/pmd_rules_apex.html) to statically analyse Apex Code to find design, performance and security vulnerabilities. It allowes us to have a better quality and avoid maintenance, performance and bug problems in our Apex code. for Salesforce apex classes are scans during build and development process.\n- Custom rules\n - Custom Objects should have a description\n - Custom Fields should have a description'\n - Custom fields should not contain underscores.\n - Custom fields in managed object should start with CZ.\n - Custom objects should start with CZ.\n - Using Metadata API Version and Project source api version should be the latest supported.\n - Files violating naming conventions\n - Do not use isCreateable, isAccessible, isUpdateable, CRUD/FLS Checks are checked by tffa.AbstractRepository\n - Do not call methods directly of an abstract class. Call methods from Repository classes extending tffa.AbstractRepository\n - Do not call methods directly of an abstract class. Call methods from Controllers classes extending tffa.AbstractController',\n - Do not call methods directly of an abstract class. Call methods from RESTService classes extending tffa.AbstractRESTService\n - Any SOQL should be encapsulated into Repository classes extending tffa.AbstractRepository. Use doQuery method\n - Do not supress PMD warnings using @SupressWarnings\n\nThe lint command is integrated into the jenkins build to report violations and fail builds\n",
|
|
44
|
-
"strict": true,
|
|
45
|
-
"pluginName": "@terafina/tffa-sfdx-plugin",
|
|
36
|
+
"hasDynamicHelp": false,
|
|
37
|
+
"hiddenAliases": [],
|
|
38
|
+
"id": "tffa:apexdoc",
|
|
46
39
|
"pluginAlias": "@terafina/tffa-sfdx-plugin",
|
|
40
|
+
"pluginName": "@terafina/tffa-sfdx-plugin",
|
|
47
41
|
"pluginType": "core",
|
|
42
|
+
"strict": true,
|
|
43
|
+
"enableJsonFlag": true,
|
|
44
|
+
"SF_ENV": "SF_ENV",
|
|
45
|
+
"isESM": false,
|
|
46
|
+
"relativePath": [
|
|
47
|
+
"lib",
|
|
48
|
+
"commands",
|
|
49
|
+
"tffa",
|
|
50
|
+
"apexdoc.js"
|
|
51
|
+
]
|
|
52
|
+
},
|
|
53
|
+
"tffa:lint": {
|
|
48
54
|
"aliases": [],
|
|
55
|
+
"args": {},
|
|
56
|
+
"description": "Scans a sfdx project and provide a violations report based on defined standards.\nPerforms static analysis of source code with a command-line interface and report output.\nThe command creates \"Rule Violations\" when the it identifies issues. Developers use this information as feedback to fix their code.\n\nThe rules used in the lint command are:\n\n- [Apex PMD](https://pmd.github.io/latest/pmd_rules_apex.html) to statically analyse Apex Code to find design, performance and security vulnerabilities. It allowes us to have a better quality and avoid maintenance, performance and bug problems in our Apex code. for Salesforce apex classes are scans during build and development process.\n- Custom rules\n - Custom Objects should have a description\n - Custom Fields should have a description'\n - Custom fields should not contain underscores.\n - Custom fields in managed object should start with CZ.\n - Custom objects should start with CZ.\n - Using Metadata API Version and Project source api version should be the latest supported.\n - Files violating naming conventions\n - Do not use isCreateable, isAccessible, isUpdateable, CRUD/FLS Checks are checked by tffa.AbstractRepository\n - Do not call methods directly of an abstract class. Call methods from Repository classes extending tffa.AbstractRepository\n - Do not call methods directly of an abstract class. Call methods from Controllers classes extending tffa.AbstractController',\n - Do not call methods directly of an abstract class. Call methods from RESTService classes extending tffa.AbstractRESTService\n - Any SOQL should be encapsulated into Repository classes extending tffa.AbstractRepository. Use doQuery method\n - Do not supress PMD warnings using @SupressWarnings\n\nThe lint command is integrated into the jenkins build to report violations and fail builds\n",
|
|
49
57
|
"examples": [
|
|
50
58
|
"$ sf tffa:lint"
|
|
51
59
|
],
|
|
52
60
|
"flags": {
|
|
53
61
|
"json": {
|
|
54
|
-
"name": "json",
|
|
55
|
-
"type": "boolean",
|
|
56
62
|
"char": "j",
|
|
57
63
|
"description": "generate json output",
|
|
58
|
-
"
|
|
64
|
+
"name": "json",
|
|
65
|
+
"allowNo": false,
|
|
66
|
+
"type": "boolean"
|
|
59
67
|
},
|
|
60
68
|
"sourcefolder": {
|
|
61
|
-
"name": "sourcefolder",
|
|
62
|
-
"type": "option",
|
|
63
69
|
"char": "s",
|
|
64
70
|
"description": "directory containing sfdx project",
|
|
71
|
+
"name": "sourcefolder",
|
|
72
|
+
"default": ".",
|
|
73
|
+
"hasDynamicHelp": false,
|
|
65
74
|
"multiple": false,
|
|
66
|
-
"
|
|
75
|
+
"type": "option"
|
|
67
76
|
},
|
|
68
77
|
"minapi": {
|
|
69
|
-
"name": "minapi",
|
|
70
|
-
"type": "option",
|
|
71
78
|
"char": "m",
|
|
72
79
|
"description": "minimum api version to use during quality checks",
|
|
80
|
+
"name": "minapi",
|
|
81
|
+
"default": 59,
|
|
82
|
+
"hasDynamicHelp": false,
|
|
73
83
|
"multiple": false,
|
|
74
|
-
"
|
|
84
|
+
"type": "option"
|
|
75
85
|
},
|
|
76
86
|
"rulesetpath": {
|
|
77
|
-
"name": "rulesetpath",
|
|
78
|
-
"type": "option",
|
|
79
87
|
"char": "r",
|
|
80
88
|
"description": "path to pmd ruleset",
|
|
81
|
-
"
|
|
89
|
+
"name": "rulesetpath",
|
|
90
|
+
"hasDynamicHelp": false,
|
|
91
|
+
"multiple": false,
|
|
92
|
+
"type": "option"
|
|
82
93
|
},
|
|
83
94
|
"eject": {
|
|
84
|
-
"name": "eject",
|
|
85
|
-
"type": "boolean",
|
|
86
95
|
"char": "e",
|
|
87
96
|
"description": "update local pmd ruleset",
|
|
88
|
-
"
|
|
97
|
+
"name": "eject",
|
|
98
|
+
"allowNo": false,
|
|
99
|
+
"type": "boolean"
|
|
89
100
|
},
|
|
90
101
|
"level": {
|
|
91
|
-
"name": "level",
|
|
92
|
-
"type": "boolean",
|
|
93
102
|
"char": "f",
|
|
94
103
|
"description": "emit fatal violations only",
|
|
95
|
-
"
|
|
104
|
+
"name": "level",
|
|
105
|
+
"allowNo": false,
|
|
106
|
+
"type": "boolean"
|
|
96
107
|
}
|
|
97
108
|
},
|
|
98
|
-
"
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
"id": "tffa:meta",
|
|
102
|
-
"description": "Scan a sfdx project for generating metadata summary information",
|
|
103
|
-
"strict": true,
|
|
104
|
-
"pluginName": "@terafina/tffa-sfdx-plugin",
|
|
109
|
+
"hasDynamicHelp": false,
|
|
110
|
+
"hiddenAliases": [],
|
|
111
|
+
"id": "tffa:lint",
|
|
105
112
|
"pluginAlias": "@terafina/tffa-sfdx-plugin",
|
|
113
|
+
"pluginName": "@terafina/tffa-sfdx-plugin",
|
|
106
114
|
"pluginType": "core",
|
|
115
|
+
"strict": true,
|
|
116
|
+
"enableJsonFlag": true,
|
|
117
|
+
"SF_ENV": "SF_ENV",
|
|
118
|
+
"isESM": false,
|
|
119
|
+
"relativePath": [
|
|
120
|
+
"lib",
|
|
121
|
+
"commands",
|
|
122
|
+
"tffa",
|
|
123
|
+
"lint.js"
|
|
124
|
+
]
|
|
125
|
+
},
|
|
126
|
+
"tffa:meta": {
|
|
107
127
|
"aliases": [],
|
|
128
|
+
"args": {},
|
|
129
|
+
"description": "Scan a sfdx project for generating metadata summary information",
|
|
108
130
|
"examples": [
|
|
109
131
|
"$ sf tffa:meta"
|
|
110
132
|
],
|
|
111
133
|
"flags": {
|
|
112
134
|
"json": {
|
|
113
|
-
"name": "json",
|
|
114
|
-
"type": "boolean",
|
|
115
135
|
"description": "Format output as json.",
|
|
116
136
|
"helpGroup": "GLOBAL",
|
|
117
|
-
"
|
|
137
|
+
"name": "json",
|
|
138
|
+
"allowNo": false,
|
|
139
|
+
"type": "boolean"
|
|
118
140
|
},
|
|
119
141
|
"sourcefolder": {
|
|
120
|
-
"name": "sourcefolder",
|
|
121
|
-
"type": "option",
|
|
122
142
|
"char": "s",
|
|
123
143
|
"description": "directory containing sfdx project",
|
|
144
|
+
"name": "sourcefolder",
|
|
145
|
+
"default": ".",
|
|
146
|
+
"hasDynamicHelp": false,
|
|
124
147
|
"multiple": false,
|
|
125
|
-
"
|
|
148
|
+
"type": "option"
|
|
126
149
|
},
|
|
127
150
|
"destpath": {
|
|
128
|
-
"name": "destpath",
|
|
129
|
-
"type": "option",
|
|
130
151
|
"char": "d",
|
|
131
152
|
"description": "full path output file",
|
|
153
|
+
"name": "destpath",
|
|
154
|
+
"default": ".",
|
|
155
|
+
"hasDynamicHelp": false,
|
|
132
156
|
"multiple": false,
|
|
133
|
-
"
|
|
157
|
+
"type": "option"
|
|
134
158
|
},
|
|
135
159
|
"clientname": {
|
|
136
|
-
"name": "clientname",
|
|
137
|
-
"type": "option",
|
|
138
160
|
"char": "c",
|
|
139
161
|
"description": "name of the client",
|
|
162
|
+
"name": "clientname",
|
|
163
|
+
"default": ".",
|
|
164
|
+
"hasDynamicHelp": false,
|
|
140
165
|
"multiple": false,
|
|
141
|
-
"
|
|
166
|
+
"type": "option"
|
|
142
167
|
},
|
|
143
168
|
"output": {
|
|
144
|
-
"name": "output",
|
|
145
|
-
"type": "option",
|
|
146
169
|
"char": "o",
|
|
147
170
|
"description": "output format json csv human",
|
|
171
|
+
"name": "output",
|
|
172
|
+
"hasDynamicHelp": false,
|
|
148
173
|
"multiple": false,
|
|
149
174
|
"options": [
|
|
150
175
|
"json",
|
|
151
176
|
"csv",
|
|
152
177
|
"human"
|
|
153
|
-
]
|
|
178
|
+
],
|
|
179
|
+
"type": "option"
|
|
154
180
|
},
|
|
155
181
|
"fields": {
|
|
156
|
-
"name": "fields",
|
|
157
|
-
"type": "boolean",
|
|
158
182
|
"char": "f",
|
|
159
183
|
"description": "generate field output",
|
|
160
|
-
"
|
|
184
|
+
"name": "fields",
|
|
185
|
+
"allowNo": false,
|
|
186
|
+
"type": "boolean"
|
|
161
187
|
}
|
|
162
188
|
},
|
|
163
|
-
"
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
"id": "tffa:ping",
|
|
167
|
-
"description": "Ping and test the plugin",
|
|
168
|
-
"strict": true,
|
|
169
|
-
"pluginName": "@terafina/tffa-sfdx-plugin",
|
|
189
|
+
"hasDynamicHelp": false,
|
|
190
|
+
"hiddenAliases": [],
|
|
191
|
+
"id": "tffa:meta",
|
|
170
192
|
"pluginAlias": "@terafina/tffa-sfdx-plugin",
|
|
193
|
+
"pluginName": "@terafina/tffa-sfdx-plugin",
|
|
171
194
|
"pluginType": "core",
|
|
195
|
+
"strict": true,
|
|
196
|
+
"enableJsonFlag": true,
|
|
197
|
+
"SF_ENV": "SF_ENV",
|
|
198
|
+
"isESM": false,
|
|
199
|
+
"relativePath": [
|
|
200
|
+
"lib",
|
|
201
|
+
"commands",
|
|
202
|
+
"tffa",
|
|
203
|
+
"meta.js"
|
|
204
|
+
]
|
|
205
|
+
},
|
|
206
|
+
"tffa:ping": {
|
|
172
207
|
"aliases": [],
|
|
208
|
+
"args": {},
|
|
209
|
+
"description": "Ping and test the plugin",
|
|
173
210
|
"examples": [
|
|
174
211
|
"$ sf tffa:ping "
|
|
175
212
|
],
|
|
176
213
|
"flags": {
|
|
177
214
|
"json": {
|
|
178
|
-
"name": "json",
|
|
179
|
-
"type": "boolean",
|
|
180
215
|
"description": "Format output as json.",
|
|
181
216
|
"helpGroup": "GLOBAL",
|
|
182
|
-
"
|
|
217
|
+
"name": "json",
|
|
218
|
+
"allowNo": false,
|
|
219
|
+
"type": "boolean"
|
|
183
220
|
}
|
|
184
221
|
},
|
|
185
|
-
"
|
|
186
|
-
"
|
|
187
|
-
|
|
188
|
-
"tffa:data:export": {
|
|
189
|
-
"id": "tffa:data:export",
|
|
190
|
-
"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.",
|
|
191
|
-
"strict": true,
|
|
192
|
-
"pluginName": "@terafina/tffa-sfdx-plugin",
|
|
222
|
+
"hasDynamicHelp": false,
|
|
223
|
+
"hiddenAliases": [],
|
|
224
|
+
"id": "tffa:ping",
|
|
193
225
|
"pluginAlias": "@terafina/tffa-sfdx-plugin",
|
|
226
|
+
"pluginName": "@terafina/tffa-sfdx-plugin",
|
|
194
227
|
"pluginType": "core",
|
|
228
|
+
"strict": true,
|
|
229
|
+
"enableJsonFlag": true,
|
|
230
|
+
"SF_ENV": "SF_ENV",
|
|
231
|
+
"flagsConfig": {},
|
|
232
|
+
"isESM": false,
|
|
233
|
+
"relativePath": [
|
|
234
|
+
"lib",
|
|
235
|
+
"commands",
|
|
236
|
+
"tffa",
|
|
237
|
+
"ping.js"
|
|
238
|
+
]
|
|
239
|
+
},
|
|
240
|
+
"tffa:data:export": {
|
|
195
241
|
"aliases": [],
|
|
242
|
+
"args": {},
|
|
243
|
+
"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.",
|
|
196
244
|
"examples": [
|
|
197
245
|
"$ sf 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 ",
|
|
198
246
|
"$ sf 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 "
|
|
199
247
|
],
|
|
200
248
|
"flags": {
|
|
201
249
|
"json": {
|
|
202
|
-
"name": "json",
|
|
203
|
-
"type": "boolean",
|
|
204
250
|
"description": "Format output as json.",
|
|
205
251
|
"helpGroup": "GLOBAL",
|
|
206
|
-
"
|
|
252
|
+
"name": "json",
|
|
253
|
+
"allowNo": false,
|
|
254
|
+
"type": "boolean"
|
|
207
255
|
},
|
|
208
256
|
"sobjecttypes": {
|
|
209
|
-
"name": "sobjecttypes",
|
|
210
|
-
"type": "option",
|
|
211
257
|
"char": "s",
|
|
212
258
|
"description": "sobject types of records to be exported",
|
|
259
|
+
"name": "sobjecttypes",
|
|
213
260
|
"required": true,
|
|
261
|
+
"delimiter": ",",
|
|
262
|
+
"hasDynamicHelp": false,
|
|
214
263
|
"multiple": true,
|
|
215
|
-
"
|
|
264
|
+
"type": "option"
|
|
216
265
|
},
|
|
217
266
|
"outputdir": {
|
|
218
|
-
"name": "outputdir",
|
|
219
|
-
"type": "option",
|
|
220
267
|
"char": "d",
|
|
221
268
|
"description": "output directory where the JSON files of exported records will be placed",
|
|
269
|
+
"name": "outputdir",
|
|
270
|
+
"default": "./data/configuration",
|
|
271
|
+
"hasDynamicHelp": false,
|
|
222
272
|
"multiple": false,
|
|
223
|
-
"
|
|
273
|
+
"type": "option"
|
|
224
274
|
},
|
|
225
275
|
"groupby": {
|
|
226
|
-
"name": "groupby",
|
|
227
|
-
"type": "option",
|
|
228
276
|
"char": "g",
|
|
229
277
|
"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)",
|
|
278
|
+
"name": "groupby",
|
|
230
279
|
"required": false,
|
|
231
|
-
"
|
|
280
|
+
"hasDynamicHelp": false,
|
|
281
|
+
"multiple": false,
|
|
282
|
+
"type": "option"
|
|
232
283
|
},
|
|
233
284
|
"orderby": {
|
|
234
|
-
"name": "orderby",
|
|
235
|
-
"type": "option",
|
|
236
285
|
"char": "o",
|
|
237
286
|
"description": "the fields to be used for sorting the exported records",
|
|
287
|
+
"name": "orderby",
|
|
238
288
|
"required": false,
|
|
289
|
+
"delimiter": ",",
|
|
290
|
+
"hasDynamicHelp": false,
|
|
239
291
|
"multiple": true,
|
|
240
|
-
"
|
|
292
|
+
"type": "option"
|
|
241
293
|
},
|
|
242
294
|
"children": {
|
|
243
|
-
"name": "children",
|
|
244
|
-
"type": "option",
|
|
245
295
|
"char": "c",
|
|
246
296
|
"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",
|
|
297
|
+
"name": "children",
|
|
247
298
|
"required": false,
|
|
299
|
+
"delimiter": ",",
|
|
300
|
+
"hasDynamicHelp": false,
|
|
248
301
|
"multiple": true,
|
|
249
|
-
"
|
|
302
|
+
"type": "option"
|
|
250
303
|
},
|
|
251
304
|
"skipconfigplan": {
|
|
252
|
-
"name": "skipconfigplan",
|
|
253
|
-
"type": "boolean",
|
|
254
305
|
"char": "i",
|
|
255
306
|
"description": "skip import of exported record JSON files into configuration plan",
|
|
307
|
+
"name": "skipconfigplan",
|
|
256
308
|
"required": false,
|
|
257
|
-
"allowNo": false
|
|
309
|
+
"allowNo": false,
|
|
310
|
+
"type": "boolean"
|
|
258
311
|
},
|
|
259
312
|
"target-org": {
|
|
260
|
-
"name": "target-org",
|
|
261
|
-
"type": "option",
|
|
262
313
|
"char": "u",
|
|
263
|
-
"
|
|
314
|
+
"name": "target-org",
|
|
315
|
+
"noCacheDefault": true,
|
|
316
|
+
"hasDynamicHelp": true,
|
|
317
|
+
"multiple": false,
|
|
318
|
+
"type": "option"
|
|
264
319
|
},
|
|
265
320
|
"api-version": {
|
|
266
|
-
"name": "api-version",
|
|
267
|
-
"type": "option",
|
|
268
321
|
"char": "a",
|
|
269
322
|
"description": "Override the api version used for api requests made by this command",
|
|
270
|
-
"
|
|
323
|
+
"name": "api-version",
|
|
324
|
+
"hasDynamicHelp": false,
|
|
325
|
+
"multiple": false,
|
|
326
|
+
"type": "option"
|
|
271
327
|
}
|
|
272
328
|
},
|
|
273
|
-
"
|
|
329
|
+
"hasDynamicHelp": true,
|
|
330
|
+
"hiddenAliases": [],
|
|
331
|
+
"id": "tffa:data:export",
|
|
332
|
+
"pluginAlias": "@terafina/tffa-sfdx-plugin",
|
|
333
|
+
"pluginName": "@terafina/tffa-sfdx-plugin",
|
|
334
|
+
"pluginType": "core",
|
|
335
|
+
"strict": true,
|
|
336
|
+
"enableJsonFlag": true,
|
|
337
|
+
"SF_ENV": "SF_ENV",
|
|
274
338
|
"requiresUsername": true,
|
|
275
|
-
"
|
|
339
|
+
"isESM": false,
|
|
340
|
+
"relativePath": [
|
|
341
|
+
"lib",
|
|
342
|
+
"commands",
|
|
343
|
+
"tffa",
|
|
344
|
+
"data",
|
|
345
|
+
"export.js"
|
|
346
|
+
]
|
|
276
347
|
},
|
|
277
348
|
"tffa:data:import": {
|
|
278
|
-
"id": "tffa:data:import",
|
|
279
|
-
"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 \"sf 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.",
|
|
280
|
-
"strict": true,
|
|
281
|
-
"pluginName": "@terafina/tffa-sfdx-plugin",
|
|
282
|
-
"pluginAlias": "@terafina/tffa-sfdx-plugin",
|
|
283
|
-
"pluginType": "core",
|
|
284
349
|
"aliases": [],
|
|
350
|
+
"args": {},
|
|
351
|
+
"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 \"sf 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.",
|
|
285
352
|
"examples": [
|
|
286
353
|
"$ sf tffa:data:import\n (Imports all records from default plan - data/configuration/config-data-plan.json\n - Updated 101 record(s) of tffa__Product__c\n - Updated 532 record(s) of tffa__ProductFeature__c\n - Updated 143 record(s) of tffa__ProductTerm__c\n Importing record(s) and relationships of tffa__Product__c... done\n \n - Updated 5 record(s) of tffa__DependentProductEligibility__c\n Importing record(s) and relationships of tffa__DependentProductEligibility__c... done",
|
|
287
354
|
"$ sf tffa:data:import -p data/configuration/config-data-plan.json\n (Imports all records from default plan - data/configuration/config-data-plan.json\n - Updated 101 record(s) of tffa__Product__c\n - Updated 532 record(s) of tffa__ProductFeature__c\n - Updated 143 record(s) of tffa__ProductTerm__c\n Importing record(s) and relationships of tffa__Product__c... done\n ... \n ",
|
|
@@ -290,111 +357,142 @@
|
|
|
290
357
|
],
|
|
291
358
|
"flags": {
|
|
292
359
|
"json": {
|
|
293
|
-
"name": "json",
|
|
294
|
-
"type": "boolean",
|
|
295
360
|
"description": "Format output as json.",
|
|
296
361
|
"helpGroup": "GLOBAL",
|
|
297
|
-
"
|
|
362
|
+
"name": "json",
|
|
363
|
+
"allowNo": false,
|
|
364
|
+
"type": "boolean"
|
|
298
365
|
},
|
|
299
366
|
"sobjectfiles": {
|
|
300
|
-
"name": "sobjectfiles",
|
|
301
|
-
"type": "option",
|
|
302
367
|
"char": "f",
|
|
303
368
|
"description": "comma-delimited, ordered paths of json files containing collection of record trees to upsert",
|
|
369
|
+
"name": "sobjectfiles",
|
|
304
370
|
"required": false,
|
|
371
|
+
"delimiter": ",",
|
|
372
|
+
"hasDynamicHelp": false,
|
|
305
373
|
"multiple": true,
|
|
306
|
-
"
|
|
374
|
+
"type": "option"
|
|
307
375
|
},
|
|
308
376
|
"plan": {
|
|
309
|
-
"name": "plan",
|
|
310
|
-
"type": "option",
|
|
311
377
|
"char": "p",
|
|
312
378
|
"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",
|
|
379
|
+
"name": "plan",
|
|
380
|
+
"default": "data/configuration/config-data-plan.json",
|
|
381
|
+
"hasDynamicHelp": false,
|
|
313
382
|
"multiple": false,
|
|
314
|
-
"
|
|
383
|
+
"type": "option"
|
|
315
384
|
},
|
|
316
385
|
"sobjecttypes": {
|
|
317
|
-
"name": "sobjecttypes",
|
|
318
|
-
"type": "option",
|
|
319
386
|
"char": "s",
|
|
320
387
|
"description": "comma-delimited, list of sobject types to be imported when using a plan",
|
|
388
|
+
"name": "sobjecttypes",
|
|
321
389
|
"required": false,
|
|
390
|
+
"delimiter": ",",
|
|
391
|
+
"hasDynamicHelp": false,
|
|
322
392
|
"multiple": true,
|
|
323
|
-
"
|
|
393
|
+
"type": "option"
|
|
324
394
|
},
|
|
325
395
|
"forceimport": {
|
|
326
|
-
"name": "forceimport",
|
|
327
|
-
"type": "boolean",
|
|
328
396
|
"char": "i",
|
|
329
397
|
"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",
|
|
398
|
+
"name": "forceimport",
|
|
330
399
|
"required": false,
|
|
331
|
-
"allowNo": false
|
|
400
|
+
"allowNo": false,
|
|
401
|
+
"type": "boolean"
|
|
332
402
|
},
|
|
333
403
|
"target-org": {
|
|
334
|
-
"name": "target-org",
|
|
335
|
-
"type": "option",
|
|
336
404
|
"char": "u",
|
|
337
|
-
"
|
|
405
|
+
"name": "target-org",
|
|
406
|
+
"noCacheDefault": true,
|
|
407
|
+
"hasDynamicHelp": true,
|
|
408
|
+
"multiple": false,
|
|
409
|
+
"type": "option"
|
|
338
410
|
},
|
|
339
411
|
"api-version": {
|
|
340
|
-
"name": "api-version",
|
|
341
|
-
"type": "option",
|
|
342
412
|
"char": "a",
|
|
343
413
|
"description": "Override the api version used for api requests made by this command",
|
|
344
|
-
"
|
|
414
|
+
"name": "api-version",
|
|
415
|
+
"hasDynamicHelp": false,
|
|
416
|
+
"multiple": false,
|
|
417
|
+
"type": "option"
|
|
345
418
|
}
|
|
346
419
|
},
|
|
347
|
-
"
|
|
420
|
+
"hasDynamicHelp": true,
|
|
421
|
+
"hiddenAliases": [],
|
|
422
|
+
"id": "tffa:data:import",
|
|
423
|
+
"pluginAlias": "@terafina/tffa-sfdx-plugin",
|
|
424
|
+
"pluginName": "@terafina/tffa-sfdx-plugin",
|
|
425
|
+
"pluginType": "core",
|
|
426
|
+
"strict": true,
|
|
427
|
+
"enableJsonFlag": true,
|
|
428
|
+
"SF_ENV": "SF_ENV",
|
|
348
429
|
"requiresUsername": true,
|
|
349
430
|
"requiresProject": true,
|
|
350
|
-
"
|
|
431
|
+
"isESM": false,
|
|
432
|
+
"relativePath": [
|
|
433
|
+
"lib",
|
|
434
|
+
"commands",
|
|
435
|
+
"tffa",
|
|
436
|
+
"data",
|
|
437
|
+
"import.js"
|
|
438
|
+
]
|
|
351
439
|
},
|
|
352
440
|
"tffa:source:apiset": {
|
|
353
|
-
"id": "tffa:source:apiset",
|
|
354
|
-
"description": "Upgrades the current project and all metadata to the latest API version",
|
|
355
|
-
"strict": true,
|
|
356
|
-
"pluginName": "@terafina/tffa-sfdx-plugin",
|
|
357
|
-
"pluginAlias": "@terafina/tffa-sfdx-plugin",
|
|
358
|
-
"pluginType": "core",
|
|
359
441
|
"aliases": [],
|
|
442
|
+
"args": {},
|
|
443
|
+
"description": "Upgrades the current project and all metadata to the latest API version",
|
|
360
444
|
"examples": [
|
|
361
445
|
"$ sf tffa:source:apiset "
|
|
362
446
|
],
|
|
363
447
|
"flags": {
|
|
364
448
|
"json": {
|
|
365
|
-
"name": "json",
|
|
366
|
-
"type": "boolean",
|
|
367
449
|
"description": "Format output as json.",
|
|
368
450
|
"helpGroup": "GLOBAL",
|
|
369
|
-
"
|
|
451
|
+
"name": "json",
|
|
452
|
+
"allowNo": false,
|
|
453
|
+
"type": "boolean"
|
|
370
454
|
},
|
|
371
455
|
"sourcefolder": {
|
|
372
|
-
"name": "sourcefolder",
|
|
373
|
-
"type": "option",
|
|
374
456
|
"char": "s",
|
|
375
457
|
"description": "directory containing sfdx project",
|
|
458
|
+
"name": "sourcefolder",
|
|
459
|
+
"default": ".",
|
|
460
|
+
"hasDynamicHelp": false,
|
|
376
461
|
"multiple": false,
|
|
377
|
-
"
|
|
462
|
+
"type": "option"
|
|
378
463
|
},
|
|
379
464
|
"api": {
|
|
380
|
-
"name": "api",
|
|
381
|
-
"type": "option",
|
|
382
465
|
"char": "a",
|
|
383
466
|
"description": "specify the API version ",
|
|
467
|
+
"name": "api",
|
|
468
|
+
"default": 59,
|
|
469
|
+
"hasDynamicHelp": false,
|
|
384
470
|
"multiple": false,
|
|
385
|
-
"
|
|
471
|
+
"type": "option"
|
|
386
472
|
}
|
|
387
473
|
},
|
|
388
|
-
"
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
"id": "tffa:source:createfield",
|
|
392
|
-
"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 ",
|
|
393
|
-
"strict": true,
|
|
394
|
-
"pluginName": "@terafina/tffa-sfdx-plugin",
|
|
474
|
+
"hasDynamicHelp": false,
|
|
475
|
+
"hiddenAliases": [],
|
|
476
|
+
"id": "tffa:source:apiset",
|
|
395
477
|
"pluginAlias": "@terafina/tffa-sfdx-plugin",
|
|
478
|
+
"pluginName": "@terafina/tffa-sfdx-plugin",
|
|
396
479
|
"pluginType": "core",
|
|
480
|
+
"strict": true,
|
|
481
|
+
"enableJsonFlag": true,
|
|
482
|
+
"SF_ENV": "SF_ENV",
|
|
483
|
+
"isESM": false,
|
|
484
|
+
"relativePath": [
|
|
485
|
+
"lib",
|
|
486
|
+
"commands",
|
|
487
|
+
"tffa",
|
|
488
|
+
"source",
|
|
489
|
+
"apiset.js"
|
|
490
|
+
]
|
|
491
|
+
},
|
|
492
|
+
"tffa:source:createfield": {
|
|
397
493
|
"aliases": [],
|
|
494
|
+
"args": {},
|
|
495
|
+
"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 ",
|
|
398
496
|
"examples": [
|
|
399
497
|
"sf fa:source:createfield -s Product__c -n TextField -t text -d \"Test Text Field\"\n Creates a text field",
|
|
400
498
|
"sf tffa:source:createfield -s Product__c -n TextField -t text -d \"Test Text Field\" --required\n Creates a required text field; does not add update permission sets as field is required",
|
|
@@ -407,34 +505,37 @@
|
|
|
407
505
|
],
|
|
408
506
|
"flags": {
|
|
409
507
|
"json": {
|
|
410
|
-
"name": "json",
|
|
411
|
-
"type": "boolean",
|
|
412
508
|
"description": "Format output as json.",
|
|
413
509
|
"helpGroup": "GLOBAL",
|
|
414
|
-
"
|
|
510
|
+
"name": "json",
|
|
511
|
+
"allowNo": false,
|
|
512
|
+
"type": "boolean"
|
|
415
513
|
},
|
|
416
514
|
"sobjecttype": {
|
|
417
|
-
"name": "sobjecttype",
|
|
418
|
-
"type": "option",
|
|
419
515
|
"char": "s",
|
|
420
516
|
"description": "the API name of the object for which the field needs to be created",
|
|
517
|
+
"name": "sobjecttype",
|
|
421
518
|
"required": true,
|
|
422
|
-
"
|
|
519
|
+
"hasDynamicHelp": false,
|
|
520
|
+
"multiple": false,
|
|
521
|
+
"type": "option"
|
|
423
522
|
},
|
|
424
523
|
"name": {
|
|
425
|
-
"name": "name",
|
|
426
|
-
"type": "option",
|
|
427
524
|
"char": "n",
|
|
428
525
|
"description": "the API name of the field",
|
|
526
|
+
"name": "name",
|
|
429
527
|
"required": true,
|
|
430
|
-
"
|
|
528
|
+
"hasDynamicHelp": false,
|
|
529
|
+
"multiple": false,
|
|
530
|
+
"type": "option"
|
|
431
531
|
},
|
|
432
532
|
"type": {
|
|
433
|
-
"name": "type",
|
|
434
|
-
"type": "option",
|
|
435
533
|
"char": "t",
|
|
436
534
|
"description": "type of the field",
|
|
535
|
+
"name": "type",
|
|
437
536
|
"required": true,
|
|
537
|
+
"default": "text",
|
|
538
|
+
"hasDynamicHelp": false,
|
|
438
539
|
"multiple": false,
|
|
439
540
|
"options": [
|
|
440
541
|
"checkbox",
|
|
@@ -452,53 +553,74 @@
|
|
|
452
553
|
"textarea-long",
|
|
453
554
|
"textarea-rich"
|
|
454
555
|
],
|
|
455
|
-
"
|
|
556
|
+
"type": "option"
|
|
456
557
|
},
|
|
457
558
|
"required": {
|
|
458
|
-
"name": "required",
|
|
459
|
-
"type": "boolean",
|
|
460
559
|
"char": "r",
|
|
461
560
|
"description": "whether field is required; skips addition to permission sets",
|
|
561
|
+
"name": "required",
|
|
462
562
|
"required": false,
|
|
463
|
-
"allowNo": false
|
|
563
|
+
"allowNo": false,
|
|
564
|
+
"type": "boolean"
|
|
464
565
|
},
|
|
465
566
|
"length": {
|
|
466
|
-
"name": "length",
|
|
467
|
-
"type": "option",
|
|
468
567
|
"char": "l",
|
|
469
568
|
"description": "length of text field or textarea (long|rich) field; defaults to 255 for text field and 1024 for textarea field",
|
|
569
|
+
"name": "length",
|
|
470
570
|
"required": false,
|
|
471
|
-
"
|
|
571
|
+
"hasDynamicHelp": false,
|
|
572
|
+
"multiple": false,
|
|
573
|
+
"type": "option"
|
|
472
574
|
},
|
|
473
575
|
"description": {
|
|
474
|
-
"name": "description",
|
|
475
|
-
"type": "option",
|
|
476
576
|
"char": "d",
|
|
477
577
|
"description": "description of the field",
|
|
578
|
+
"name": "description",
|
|
478
579
|
"required": false,
|
|
479
|
-
"
|
|
580
|
+
"hasDynamicHelp": false,
|
|
581
|
+
"multiple": false,
|
|
582
|
+
"type": "option"
|
|
480
583
|
},
|
|
481
584
|
"permissionsets": {
|
|
482
|
-
"name": "permissionsets",
|
|
483
|
-
"type": "option",
|
|
484
585
|
"char": "p",
|
|
485
586
|
"description": "comma-separated list of permission sets to which the field needs to be added; defaults to all permission sets in the project",
|
|
587
|
+
"name": "permissionsets",
|
|
486
588
|
"required": false,
|
|
589
|
+
"delimiter": ",",
|
|
590
|
+
"hasDynamicHelp": false,
|
|
487
591
|
"multiple": true,
|
|
488
|
-
"
|
|
592
|
+
"type": "option"
|
|
489
593
|
},
|
|
490
594
|
"valuesetname": {
|
|
491
|
-
"name": "valuesetname",
|
|
492
|
-
"type": "option",
|
|
493
595
|
"char": "v",
|
|
494
596
|
"description": "name of the global value set if the field is a picklist or multi-select picklist type",
|
|
597
|
+
"name": "valuesetname",
|
|
495
598
|
"required": false,
|
|
496
|
-
"
|
|
599
|
+
"hasDynamicHelp": false,
|
|
600
|
+
"multiple": false,
|
|
601
|
+
"type": "option"
|
|
497
602
|
}
|
|
498
603
|
},
|
|
499
|
-
"
|
|
604
|
+
"hasDynamicHelp": false,
|
|
605
|
+
"hiddenAliases": [],
|
|
606
|
+
"id": "tffa:source:createfield",
|
|
607
|
+
"pluginAlias": "@terafina/tffa-sfdx-plugin",
|
|
608
|
+
"pluginName": "@terafina/tffa-sfdx-plugin",
|
|
609
|
+
"pluginType": "core",
|
|
610
|
+
"strict": true,
|
|
611
|
+
"enableJsonFlag": true,
|
|
612
|
+
"SF_ENV": "SF_ENV",
|
|
500
613
|
"requiresUsername": true,
|
|
501
|
-
"requiresProject": true
|
|
614
|
+
"requiresProject": true,
|
|
615
|
+
"isESM": false,
|
|
616
|
+
"relativePath": [
|
|
617
|
+
"lib",
|
|
618
|
+
"commands",
|
|
619
|
+
"tffa",
|
|
620
|
+
"source",
|
|
621
|
+
"createfield.js"
|
|
622
|
+
]
|
|
502
623
|
}
|
|
503
|
-
}
|
|
624
|
+
},
|
|
625
|
+
"version": "20.0.0-rc.5"
|
|
504
626
|
}
|