@provartesting/provardx-cli 0.0.1

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.
Files changed (57) hide show
  1. package/README.md +16 -0
  2. package/lib/Utility/errorCode.d.ts +1 -0
  3. package/lib/Utility/errorCode.js +9 -0
  4. package/lib/Utility/errorCode.js.map +1 -0
  5. package/lib/Utility/errorHandler.d.ts +15 -0
  6. package/lib/Utility/errorHandler.js +27 -0
  7. package/lib/Utility/errorHandler.js.map +1 -0
  8. package/lib/Utility/fileSupport.d.ts +6 -0
  9. package/lib/Utility/fileSupport.js +51 -0
  10. package/lib/Utility/fileSupport.js.map +1 -0
  11. package/lib/Utility/jsonSupport.d.ts +8 -0
  12. package/lib/Utility/jsonSupport.js +55 -0
  13. package/lib/Utility/jsonSupport.js.map +1 -0
  14. package/lib/Utility/propertyFileValidator.d.ts +13 -0
  15. package/lib/Utility/propertyFileValidator.js +103 -0
  16. package/lib/Utility/propertyFileValidator.js.map +1 -0
  17. package/lib/Utility/provarConfig.d.ts +11 -0
  18. package/lib/Utility/provarConfig.js +42 -0
  19. package/lib/Utility/provarConfig.js.map +1 -0
  20. package/lib/Utility/sfProvarCommandResult.d.ts +12 -0
  21. package/lib/Utility/sfProvarCommandResult.js +34 -0
  22. package/lib/Utility/sfProvarCommandResult.js.map +1 -0
  23. package/lib/Utility/stringSupport.d.ts +6 -0
  24. package/lib/Utility/stringSupport.js +32 -0
  25. package/lib/Utility/stringSupport.js.map +1 -0
  26. package/lib/commands/sf/provar/config/generate.d.ts +14 -0
  27. package/lib/commands/sf/provar/config/generate.js +102 -0
  28. package/lib/commands/sf/provar/config/generate.js.map +1 -0
  29. package/lib/commands/sf/provar/config/get.d.ts +10 -0
  30. package/lib/commands/sf/provar/config/get.js +106 -0
  31. package/lib/commands/sf/provar/config/get.js.map +1 -0
  32. package/lib/commands/sf/provar/config/load.d.ts +12 -0
  33. package/lib/commands/sf/provar/config/load.js +87 -0
  34. package/lib/commands/sf/provar/config/load.js.map +1 -0
  35. package/lib/commands/sf/provar/config/set.d.ts +10 -0
  36. package/lib/commands/sf/provar/config/set.js +117 -0
  37. package/lib/commands/sf/provar/config/set.js.map +1 -0
  38. package/lib/commands/sf/provar/config/validate.d.ts +9 -0
  39. package/lib/commands/sf/provar/config/validate.js +40 -0
  40. package/lib/commands/sf/provar/config/validate.js.map +1 -0
  41. package/lib/constants/commandConstants.d.ts +7 -0
  42. package/lib/constants/commandConstants.js +12 -0
  43. package/lib/constants/commandConstants.js.map +1 -0
  44. package/lib/constants/errorMessages.d.ts +13 -0
  45. package/lib/constants/errorMessages.js +24 -0
  46. package/lib/constants/errorMessages.js.map +1 -0
  47. package/lib/constants/propertyFileContent.json +24 -0
  48. package/lib/constants/propertyFileSchema.d.ts +247 -0
  49. package/lib/constants/propertyFileSchema.js +243 -0
  50. package/lib/constants/propertyFileSchema.js.map +1 -0
  51. package/messages/sf.provar.config.generate.md +33 -0
  52. package/messages/sf.provar.config.get.md +17 -0
  53. package/messages/sf.provar.config.load.md +29 -0
  54. package/messages/sf.provar.config.set.md +17 -0
  55. package/messages/sf.provar.config.validate.md +21 -0
  56. package/oclif.manifest.json +143 -0
  57. package/package.json +214 -0
@@ -0,0 +1,247 @@
1
+ export declare const propertyFileSchema: {
2
+ $schema: string;
3
+ $id: string;
4
+ title: string;
5
+ description: string;
6
+ type: string;
7
+ required: string[];
8
+ dependentRequired: {
9
+ attachmentProperties: string;
10
+ };
11
+ properties: {
12
+ provarHome: {
13
+ description: string;
14
+ type: string;
15
+ };
16
+ projectPath: {
17
+ description: string;
18
+ type: string;
19
+ };
20
+ smtpPath: {
21
+ description: string;
22
+ type: string;
23
+ };
24
+ resultsPath: {
25
+ description: string;
26
+ type: string;
27
+ };
28
+ resultsPathDisposition: {
29
+ description: string;
30
+ type: string;
31
+ enum: string[];
32
+ };
33
+ testOutputLevel: {
34
+ description: string;
35
+ type: string;
36
+ enum: string[];
37
+ };
38
+ pluginOutputlevel: {
39
+ description: string;
40
+ type: string;
41
+ enum: string[];
42
+ };
43
+ excludeCallable: {
44
+ description: string;
45
+ type: string;
46
+ };
47
+ stopOnError: {
48
+ description: string;
49
+ type: string;
50
+ };
51
+ connectionRefreshType: {
52
+ description: string;
53
+ type: string;
54
+ };
55
+ lightningMode: {
56
+ description: string;
57
+ type: string;
58
+ };
59
+ metadata: {
60
+ description: string;
61
+ type: string;
62
+ properties: {
63
+ metadataLevel: {
64
+ description: string;
65
+ type: string;
66
+ enum: string[];
67
+ };
68
+ cachePath: {
69
+ description: string;
70
+ type: string;
71
+ };
72
+ };
73
+ required: string[];
74
+ };
75
+ environment: {
76
+ description: string;
77
+ type: string;
78
+ properties: {
79
+ testEnvironment: {
80
+ description: string;
81
+ type: string;
82
+ };
83
+ webBrowser: {
84
+ description: string;
85
+ type: string;
86
+ enum: string[];
87
+ };
88
+ webBrowserConfig: {
89
+ description: string;
90
+ type: string;
91
+ };
92
+ webBrowserProviderName: {
93
+ description: string;
94
+ type: string;
95
+ };
96
+ webBrowserDeviceName: {
97
+ description: string;
98
+ type: string;
99
+ };
100
+ };
101
+ required: string[];
102
+ };
103
+ testprojectSecrets: {
104
+ description: string;
105
+ type: string;
106
+ };
107
+ environmentsSecrets: {
108
+ description: string;
109
+ type: string;
110
+ items: {
111
+ type: string;
112
+ properties: {
113
+ name: {
114
+ type: string;
115
+ };
116
+ secretsPassword: {
117
+ type: string;
118
+ };
119
+ };
120
+ };
121
+ };
122
+ testplanFeatures: {
123
+ description: string;
124
+ type: string;
125
+ items: {
126
+ type: string;
127
+ properties: {
128
+ name: {
129
+ type: string;
130
+ };
131
+ type: {
132
+ type: string;
133
+ };
134
+ enabled: {
135
+ type: string;
136
+ };
137
+ };
138
+ };
139
+ };
140
+ emailProperties: {
141
+ description: string;
142
+ type: string;
143
+ properties: {
144
+ sendEmail: {
145
+ description: string;
146
+ type: string;
147
+ };
148
+ primaryRecipients: {
149
+ description: string;
150
+ type: string;
151
+ };
152
+ ccRecipients: {
153
+ description: string;
154
+ type: string;
155
+ };
156
+ bccRecipients: {
157
+ description: string;
158
+ type: string;
159
+ };
160
+ };
161
+ required: string[];
162
+ };
163
+ testPlan: {
164
+ description: string;
165
+ type: string;
166
+ items: {
167
+ type: string;
168
+ };
169
+ };
170
+ attachmentProperties: {
171
+ description: string;
172
+ type: string;
173
+ properties: {
174
+ includeAllFailuresInSummary: {
175
+ description: string;
176
+ type: string;
177
+ };
178
+ includeBdd: {
179
+ description: string;
180
+ type: string;
181
+ };
182
+ includeTestCaseShowSummary: {
183
+ description: string;
184
+ type: string;
185
+ };
186
+ includeScreenshotThumbnail: {
187
+ description: string;
188
+ type: string;
189
+ };
190
+ includeBasicLogs: {
191
+ description: string;
192
+ type: string;
193
+ };
194
+ includeDetailLogs: {
195
+ description: string;
196
+ type: string;
197
+ };
198
+ includeTestStepTime: {
199
+ description: string;
200
+ type: string;
201
+ };
202
+ includeFullScreenShot: {
203
+ description: string;
204
+ type: string;
205
+ };
206
+ includeNoScreenshot: {
207
+ description: string;
208
+ type: string;
209
+ };
210
+ includeDiagnosticTrace: {
211
+ description: string;
212
+ type: string;
213
+ };
214
+ includeTestCasePathHierarchy: {
215
+ description: string;
216
+ type: string;
217
+ };
218
+ includeSkipped: {
219
+ description: string;
220
+ type: string;
221
+ };
222
+ };
223
+ };
224
+ testCase: {
225
+ description: string;
226
+ type: string;
227
+ items: {
228
+ type: string;
229
+ };
230
+ };
231
+ connectionOverride: {
232
+ description: string;
233
+ type: string;
234
+ items: {
235
+ type: string;
236
+ properties: {
237
+ connection: {
238
+ type: string;
239
+ };
240
+ username: {
241
+ type: string;
242
+ };
243
+ };
244
+ };
245
+ };
246
+ };
247
+ };
@@ -0,0 +1,243 @@
1
+ "use strict";
2
+ /*
3
+ * Copyright (c) 2024 Provar Limited.
4
+ * All rights reserved.
5
+ * Licensed under the BSD 3-Clause license.
6
+ * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause
7
+ */
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ exports.propertyFileSchema = void 0;
10
+ exports.propertyFileSchema = {
11
+ $schema: 'http://json-schema.org/draft-07/schema#',
12
+ $id: 'http://provartesting.com/provardx-props.schema.json',
13
+ title: 'ProvarDX-Properties',
14
+ description: 'A ProvarDX Property File',
15
+ type: 'object',
16
+ required: ['provarHome', 'projectPath', 'resultsPath', 'metadata', 'environment'],
17
+ dependentRequired: {
18
+ attachmentProperties: 'emailProperties',
19
+ },
20
+ properties: {
21
+ provarHome: {
22
+ description: 'Contains the location that the Provar installation was unzipped. ​This attribute is not required if there is a full Provar installation in the default location, or if PROVAR_HOME Environment Variable is set',
23
+ type: 'string',
24
+ },
25
+ projectPath: {
26
+ description: 'The fully qualified path of the Test Project containing the tests to be run. This is the folder that contains the .testproject file',
27
+ type: 'string',
28
+ },
29
+ smtpPath: {
30
+ description: 'The fully qualified path of the .smtp folder to which Provar will use to send emails',
31
+ type: 'string',
32
+ },
33
+ resultsPath: {
34
+ description: 'The fully qualified path of the folder to which Provar will write the test results',
35
+ type: 'string',
36
+ },
37
+ resultsPathDisposition: {
38
+ description: 'Controls the result folder disposition.',
39
+ type: 'string',
40
+ enum: ['Increment', 'Replace', 'Fail'],
41
+ },
42
+ testOutputLevel: {
43
+ description: 'Controls the amount of test output logged to the DX test log.',
44
+ type: 'string',
45
+ enum: ['BASIC', 'DETAILED', 'DIAGNOSTIC'],
46
+ },
47
+ pluginOutputlevel: {
48
+ description: 'Controls the amount of plugin output logged to the DX test log.',
49
+ type: 'string',
50
+ enum: ['SEVERE', 'WARNING', 'INFO', 'FINE', 'FINER', 'FINEST'],
51
+ },
52
+ excludeCallable: {
53
+ description: 'Indicates whether Callable Test Cases should be omitted from execution (true) or included in execution (false)',
54
+ type: 'boolean',
55
+ },
56
+ stopOnError: {
57
+ description: 'Indicates whether the Test Run should abort automatically if any test failure is encountered',
58
+ type: 'boolean',
59
+ },
60
+ connectionRefreshType: {
61
+ description: 'Controls the Metadata at Connection level',
62
+ type: 'string',
63
+ },
64
+ lightningMode: {
65
+ description: 'Indicates org is lightning or not',
66
+ type: 'boolean',
67
+ },
68
+ metadata: {
69
+ description: 'Controls the Salesforce Metadata usage.',
70
+ type: 'object',
71
+ properties: {
72
+ metadataLevel: {
73
+ description: 'Controls the Salesforce Metadata usage',
74
+ type: 'string',
75
+ enum: ['Reuse', 'Reload', 'Refresh'],
76
+ },
77
+ cachePath: {
78
+ description: 'The fully qualified path of the folder that will be used for storing the metadata cache',
79
+ type: 'string',
80
+ },
81
+ },
82
+ required: ['metadataLevel', 'cachePath'],
83
+ },
84
+ environment: {
85
+ description: '',
86
+ type: 'object',
87
+ properties: {
88
+ testEnvironment: {
89
+ description: 'The name of the Test Environment that the test run should be executed against. Test Environments are defined in Test Settings',
90
+ type: 'string',
91
+ },
92
+ webBrowser: {
93
+ description: 'The web browser to be used for UI testing',
94
+ type: 'string',
95
+ enum: ['Chrome', 'Safari', 'Edge', 'Edge_Legacy', 'Firefox', 'IE', 'Chrome_Headless'],
96
+ },
97
+ webBrowserConfig: {
98
+ description: 'The web browser window size. Browser configurations are defined in Test Settings',
99
+ type: 'string',
100
+ },
101
+ webBrowserProviderName: {
102
+ description: 'Web browser provider name.',
103
+ type: 'string',
104
+ },
105
+ webBrowserDeviceName: {
106
+ description: 'Web browser device name',
107
+ type: 'string',
108
+ },
109
+ },
110
+ required: ['webBrowser', 'webBrowserConfig', 'webBrowserProviderName', 'webBrowserDeviceName'],
111
+ },
112
+ testprojectSecrets: {
113
+ description: 'Test project secret encryption password.',
114
+ type: 'string',
115
+ },
116
+ environmentsSecrets: {
117
+ description: 'Test environment secret encryption password.',
118
+ type: 'array',
119
+ items: {
120
+ type: 'object',
121
+ properties: {
122
+ name: { type: 'string' },
123
+ secretsPassword: { type: 'string' },
124
+ },
125
+ },
126
+ },
127
+ testplanFeatures: {
128
+ description: 'Test plan features.',
129
+ type: 'array',
130
+ items: {
131
+ type: 'object',
132
+ properties: {
133
+ name: { type: 'string' },
134
+ type: { type: 'string' },
135
+ enabled: { type: 'string' },
136
+ },
137
+ },
138
+ },
139
+ emailProperties: {
140
+ description: 'One or more email recipients defining settings for sending email upon test execution completion',
141
+ type: 'object',
142
+ properties: {
143
+ sendEmail: {
144
+ description: 'Indicates whether an email should be sent after test run execution',
145
+ type: 'string',
146
+ },
147
+ primaryRecipients: {
148
+ description: 'The primary email addresses which should receive the email',
149
+ type: 'string',
150
+ },
151
+ ccRecipients: {
152
+ description: 'he email addresses which should be CC’d in the email',
153
+ type: 'string',
154
+ },
155
+ bccRecipients: {
156
+ description: 'The email addresses which should be BCC’d in the email',
157
+ type: 'string',
158
+ },
159
+ },
160
+ required: ['sendEmail', 'primaryRecipients'],
161
+ },
162
+ testPlan: {
163
+ description: 'List of test plan names to be executed, wildcards are permitted',
164
+ type: 'array',
165
+ items: {
166
+ type: 'string',
167
+ },
168
+ },
169
+ attachmentProperties: {
170
+ description: 'Attributes defining what to include in PDF while attaching PDF report under email upon test execution completion',
171
+ type: 'object',
172
+ properties: {
173
+ includeAllFailuresInSummary: {
174
+ description: 'Property to include every test step failure in PDF summary',
175
+ type: 'string',
176
+ },
177
+ includeBdd: {
178
+ description: 'Property to include testCase summary for bdd/design steps',
179
+ type: 'string',
180
+ },
181
+ includeTestCaseShowSummary: {
182
+ description: 'Property to include summaryBlockInfo in PDF report',
183
+ type: 'string',
184
+ },
185
+ includeScreenshotThumbnail: {
186
+ description: 'Property to include Screenshot thumbnail (small image representation) for steps screenshots are there',
187
+ type: 'string',
188
+ },
189
+ includeBasicLogs: {
190
+ description: 'Property to include basic logging only in PDF report',
191
+ type: 'string',
192
+ },
193
+ includeDetailLogs: {
194
+ description: 'Property to include detailed logging only in PDF report',
195
+ type: 'string',
196
+ },
197
+ includeTestStepTime: {
198
+ description: 'Property to include time for every test step execution in PDF report',
199
+ type: 'string',
200
+ },
201
+ includeFullScreenShot: {
202
+ description: 'Property to include full screenshot for every step in PDF report',
203
+ type: 'string',
204
+ },
205
+ includeNoScreenshot: {
206
+ description: 'Property to include no screenshot in PDF report',
207
+ type: 'string',
208
+ },
209
+ includeDiagnosticTrace: {
210
+ description: 'Property to include Diagnostic level logging in PDF report',
211
+ type: 'string',
212
+ },
213
+ includeTestCasePathHierarchy: {
214
+ description: 'Property to include testcase path hierachy of testcase execution in PDF report',
215
+ type: 'string',
216
+ },
217
+ includeSkipped: {
218
+ description: 'Property to include details of skipped test steps while testcase execution in PDF report',
219
+ type: 'string',
220
+ },
221
+ },
222
+ },
223
+ testCase: {
224
+ description: 'One or more fileset elements defining the .testcase files to be run. You can specify individual Test Case files, folders containing Test Case files or a combination of both',
225
+ type: 'array',
226
+ items: {
227
+ type: 'string',
228
+ },
229
+ },
230
+ connectionOverride: {
231
+ description: 'name:value pairs where the first entry is the provar Connection name and the second is a SFDX username/user-alias to substitute',
232
+ type: 'array',
233
+ items: {
234
+ type: 'object',
235
+ properties: {
236
+ connection: { type: 'string' },
237
+ username: { type: 'string' },
238
+ },
239
+ },
240
+ },
241
+ },
242
+ };
243
+ //# sourceMappingURL=propertyFileSchema.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"propertyFileSchema.js","sourceRoot":"","sources":["../../src/constants/propertyFileSchema.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,kBAAkB,GAAG;IAChC,OAAO,EAAE,yCAAyC;IAClD,GAAG,EAAE,qDAAqD;IAC1D,KAAK,EAAE,qBAAqB;IAC5B,WAAW,EAAE,0BAA0B;IACvC,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,CAAC;IACjF,iBAAiB,EAAE;QACjB,oBAAoB,EAAE,iBAAiB;KACxC;IACD,UAAU,EAAE;QACV,UAAU,EAAE;YACV,WAAW,EACT,gNAAgN;YAClN,IAAI,EAAE,QAAQ;SACf;QACD,WAAW,EAAE;YACX,WAAW,EACT,sIAAsI;YACxI,IAAI,EAAE,QAAQ;SACf;QACD,QAAQ,EAAE;YACR,WAAW,EAAE,sFAAsF;YACnG,IAAI,EAAE,QAAQ;SACf;QACD,WAAW,EAAE;YACX,WAAW,EAAE,oFAAoF;YACjG,IAAI,EAAE,QAAQ;SACf;QACD,sBAAsB,EAAE;YACtB,WAAW,EAAE,yCAAyC;YACtD,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC;SACvC;QACD,eAAe,EAAE;YACf,WAAW,EAAE,+DAA+D;YAC5E,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC;SAC1C;QACD,iBAAiB,EAAE;YACjB,WAAW,EAAE,iEAAiE;YAC9E,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC;SAC/D;QACD,eAAe,EAAE;YACf,WAAW,EACT,gHAAgH;YAClH,IAAI,EAAE,SAAS;SAChB;QACD,WAAW,EAAE;YACX,WAAW,EAAE,8FAA8F;YAC3G,IAAI,EAAE,SAAS;SAChB;QACD,qBAAqB,EAAE;YACrB,WAAW,EAAE,2CAA2C;YACxD,IAAI,EAAE,QAAQ;SACf;QACD,aAAa,EAAE;YACb,WAAW,EAAE,mCAAmC;YAChD,IAAI,EAAE,SAAS;SAChB;QACD,QAAQ,EAAE;YACR,WAAW,EAAE,yCAAyC;YACtD,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,aAAa,EAAE;oBACb,WAAW,EAAE,wCAAwC;oBACrD,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC;iBACrC;gBACD,SAAS,EAAE;oBACT,WAAW,EAAE,yFAAyF;oBACtG,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,QAAQ,EAAE,CAAC,eAAe,EAAE,WAAW,CAAC;SACzC;QACD,WAAW,EAAE;YACX,WAAW,EAAE,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,eAAe,EAAE;oBACf,WAAW,EACT,+HAA+H;oBACjI,IAAI,EAAE,QAAQ;iBACf;gBACD,UAAU,EAAE;oBACV,WAAW,EAAE,2CAA2C;oBACxD,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,IAAI,EAAE,iBAAiB,CAAC;iBACtF;gBACD,gBAAgB,EAAE;oBAChB,WAAW,EAAE,kFAAkF;oBAC/F,IAAI,EAAE,QAAQ;iBACf;gBACD,sBAAsB,EAAE;oBACtB,WAAW,EAAE,4BAA4B;oBACzC,IAAI,EAAE,QAAQ;iBACf;gBACD,oBAAoB,EAAE;oBACpB,WAAW,EAAE,yBAAyB;oBACtC,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,QAAQ,EAAE,CAAC,YAAY,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,sBAAsB,CAAC;SAC/F;QACD,kBAAkB,EAAE;YAClB,WAAW,EAAE,0CAA0C;YACvD,IAAI,EAAE,QAAQ;SACf;QACD,mBAAmB,EAAE;YACnB,WAAW,EAAE,8CAA8C;YAC3D,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACxB,eAAe,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBACpC;aACF;SACF;QACD,gBAAgB,EAAE;YAChB,WAAW,EAAE,qBAAqB;YAClC,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACxB,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACxB,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBAC5B;aACF;SACF;QACD,eAAe,EAAE;YACf,WAAW,EAAE,iGAAiG;YAC9G,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,SAAS,EAAE;oBACT,WAAW,EAAE,oEAAoE;oBACjF,IAAI,EAAE,QAAQ;iBACf;gBACD,iBAAiB,EAAE;oBACjB,WAAW,EAAE,4DAA4D;oBACzE,IAAI,EAAE,QAAQ;iBACf;gBACD,YAAY,EAAE;oBACZ,WAAW,EAAE,sDAAsD;oBACnE,IAAI,EAAE,QAAQ;iBACf;gBACD,aAAa,EAAE;oBACb,WAAW,EAAE,wDAAwD;oBACrE,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,QAAQ,EAAE,CAAC,WAAW,EAAE,mBAAmB,CAAC;SAC7C;QACD,QAAQ,EAAE;YACR,WAAW,EAAE,iEAAiE;YAC9E,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;aACf;SACF;QACD,oBAAoB,EAAE;YACpB,WAAW,EACT,kHAAkH;YACpH,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,2BAA2B,EAAE;oBAC3B,WAAW,EAAE,4DAA4D;oBACzE,IAAI,EAAE,QAAQ;iBACf;gBACD,UAAU,EAAE;oBACV,WAAW,EAAE,2DAA2D;oBACxE,IAAI,EAAE,QAAQ;iBACf;gBACD,0BAA0B,EAAE;oBAC1B,WAAW,EAAE,oDAAoD;oBACjE,IAAI,EAAE,QAAQ;iBACf;gBACD,0BAA0B,EAAE;oBAC1B,WAAW,EACT,uGAAuG;oBACzG,IAAI,EAAE,QAAQ;iBACf;gBACD,gBAAgB,EAAE;oBAChB,WAAW,EAAE,sDAAsD;oBACnE,IAAI,EAAE,QAAQ;iBACf;gBACD,iBAAiB,EAAE;oBACjB,WAAW,EAAE,yDAAyD;oBACtE,IAAI,EAAE,QAAQ;iBACf;gBACD,mBAAmB,EAAE;oBACnB,WAAW,EAAE,sEAAsE;oBACnF,IAAI,EAAE,QAAQ;iBACf;gBACD,qBAAqB,EAAE;oBACrB,WAAW,EAAE,kEAAkE;oBAC/E,IAAI,EAAE,QAAQ;iBACf;gBACD,mBAAmB,EAAE;oBACnB,WAAW,EAAE,iDAAiD;oBAC9D,IAAI,EAAE,QAAQ;iBACf;gBACD,sBAAsB,EAAE;oBACtB,WAAW,EAAE,4DAA4D;oBACzE,IAAI,EAAE,QAAQ;iBACf;gBACD,4BAA4B,EAAE;oBAC5B,WAAW,EAAE,gFAAgF;oBAC7F,IAAI,EAAE,QAAQ;iBACf;gBACD,cAAc,EAAE;oBACd,WAAW,EAAE,0FAA0F;oBACvG,IAAI,EAAE,QAAQ;iBACf;aACF;SACF;QACD,QAAQ,EAAE;YACR,WAAW,EACT,+KAA+K;YACjL,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;aACf;SACF;QACD,kBAAkB,EAAE;YAClB,WAAW,EACT,iIAAiI;YACnI,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC9B,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBAC7B;aACF;SACF;KACF;CACF,CAAC"}
@@ -0,0 +1,33 @@
1
+ # summary
2
+
3
+ Summary of a command.
4
+
5
+ # description
6
+
7
+ Generate a boilerplate property file.
8
+
9
+ # examples
10
+
11
+ - Generates the boiler plate properties.json at the given path :
12
+
13
+ <%= config.bin %> <%= command.id %> --properties-file 'propertiesFile path'
14
+
15
+ # flags.properties-file.summary
16
+
17
+ Provardx-properties file path.
18
+
19
+ # flags.no-prompt.summary
20
+
21
+ Don't prompt to confirm overwriting of the properties file if it already exists and overwrite it by default.
22
+
23
+ # PropertiesFileOverwritePromptConfirm
24
+
25
+ FILE_ALREADY_EXISTS - A file with the same name already exists in that location. Do you want to overwrite it? Y/N
26
+
27
+ # success_message
28
+
29
+ The properties file was generated successfully.
30
+
31
+ # error.MULTIPLE_ERRORS
32
+
33
+ %s
@@ -0,0 +1,17 @@
1
+ # summary
2
+
3
+ getting values for different properties inside dx properties.json
4
+
5
+ # description
6
+
7
+ Getting values for different properties inside PROPERTIES_FILE_PATH loaded under .sf/config.json file
8
+
9
+ # examples
10
+
11
+ - gets the value for the provided property as a key from properties.json loaded inside config.json
12
+
13
+ <%= config.bin %> <%= command.id %> 'key'
14
+
15
+ # error.MULTIPLE_ERRORS
16
+
17
+ %s
@@ -0,0 +1,29 @@
1
+ # summary
2
+
3
+ Loading provardx-properties.json into system environment variables.
4
+
5
+ # description
6
+
7
+ Loading after internally validating the provardx-properties.json file generated via config generate command
8
+
9
+ # examples
10
+
11
+ - loads the properties.json at the given path
12
+
13
+ <%= config.bin %> <%= command.id %> --properties-file 'propertiesFile path'
14
+
15
+ # flags.properties-file.summary
16
+
17
+ Path of the properties file to be loaded.
18
+
19
+ # error.INVALID_PATH
20
+
21
+ [INVALID_PATH] The provided path does not exist or is invalid.
22
+
23
+ # error.MULTIPLE_ERRORS
24
+
25
+ %s
26
+
27
+ # success_message
28
+
29
+ The properties file was loaded successfully.
@@ -0,0 +1,17 @@
1
+ # summary
2
+
3
+ Setting different properties inside dx-properties.json
4
+
5
+ # description
6
+
7
+ Setting different properties inside dx-properties.json loaded under .sf/config.json file
8
+
9
+ # examples
10
+
11
+ - sets the provided properties with resp. values as key=value in properties.json
12
+
13
+ <%= config.bin %> <%= command.id %> 'key'='value'
14
+
15
+ # error.MULTIPLE_ERRORS
16
+
17
+ %s
@@ -0,0 +1,21 @@
1
+ # summary
2
+
3
+ Validate the loaded provardx-properties.json against schema.
4
+
5
+ # description
6
+
7
+ Validating provardx-properties.json against the schema for all the needed properties with their expected values.
8
+
9
+ # examples
10
+
11
+ - Validate the loaded provardx-properties.json loaded under environment variables :
12
+
13
+ <%= config.bin %> <%= command.id %>'
14
+
15
+ # success_message
16
+
17
+ The properties file was validated successfully.
18
+
19
+ # error.MULTIPLE_ERRORS
20
+
21
+ %s