@provartesting/provardx-cli 0.0.1 → 0.0.3
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 +16 -16
- package/messages/sf.provar.config.generate.md +33 -33
- package/messages/sf.provar.config.get.md +17 -17
- package/messages/sf.provar.config.load.md +29 -29
- package/messages/sf.provar.config.set.md +17 -17
- package/messages/sf.provar.config.validate.md +21 -21
- package/oclif.manifest.json +1 -1
- package/package.json +3 -9
package/README.md
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
Run In dev provardx plugin on your local
|
|
2
|
-
# Prerequisite:
|
|
3
|
-
Node, npm , nvm, yarn, Latest sf cli.
|
|
4
|
-
# Steps to run on local:
|
|
5
|
-
1. git clone the Repo from the feature branch: https://github.com/ProvarTesting/provardx-cli/
|
|
6
|
-
2. Install the dependencies on your local from package.json: npm i
|
|
7
|
-
3. Build the project using the command: yarn prepack
|
|
8
|
-
4. Need to copy the bin/dev folder to run the commands locally in Dev. Plugin.
|
|
9
|
-
5. To run the command manually: bin/dev ${command} (example: bin/dev sf provar config generate)
|
|
10
|
-
6. To run NUTS on your local: yarn run test:nuts
|
|
11
|
-
|
|
12
|
-
# Naming conventions used in provardx-cli development
|
|
13
|
-
1. camelCase for fileNames/methodNames/Variables
|
|
14
|
-
2. PascalCase for classNames.
|
|
15
|
-
|
|
16
|
-
Also, we are adding the Copyright/licensing text over every ts file
|
|
1
|
+
Run In dev provardx plugin on your local
|
|
2
|
+
# Prerequisite:
|
|
3
|
+
Node, npm , nvm, yarn, Latest sf cli.
|
|
4
|
+
# Steps to run on local:
|
|
5
|
+
1. git clone the Repo from the feature branch: https://github.com/ProvarTesting/provardx-cli/
|
|
6
|
+
2. Install the dependencies on your local from package.json: npm i
|
|
7
|
+
3. Build the project using the command: yarn prepack
|
|
8
|
+
4. Need to copy the bin/dev folder to run the commands locally in Dev. Plugin.
|
|
9
|
+
5. To run the command manually: bin/dev ${command} (example: bin/dev sf provar config generate)
|
|
10
|
+
6. To run NUTS on your local: yarn run test:nuts
|
|
11
|
+
|
|
12
|
+
# Naming conventions used in provardx-cli development
|
|
13
|
+
1. camelCase for fileNames/methodNames/Variables
|
|
14
|
+
2. PascalCase for classNames.
|
|
15
|
+
|
|
16
|
+
Also, we are adding the Copyright/licensing text over every ts file
|
|
@@ -1,33 +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
|
|
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
|
|
@@ -1,17 +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
|
|
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
|
|
@@ -1,29 +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.
|
|
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.
|
|
@@ -1,17 +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
|
|
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
|
|
@@ -1,21 +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
|
|
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
|
package/oclif.manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@provartesting/provardx-cli",
|
|
3
3
|
"description": "A plugin for the Salesforce CLI to orchestrate testing activities and report quality metrics to Provar Manager",
|
|
4
|
-
"version": "0.0.
|
|
4
|
+
"version": "0.0.3",
|
|
5
|
+
"license": "BSD-3-Clause",
|
|
5
6
|
"dependencies": {
|
|
6
7
|
"@oclif/core": "^2.11.8",
|
|
7
8
|
"@salesforce/core": "^5.2.10",
|
|
@@ -60,7 +61,6 @@
|
|
|
60
61
|
"sf-plugin",
|
|
61
62
|
"sf"
|
|
62
63
|
],
|
|
63
|
-
"license": "BSD-3-Clause",
|
|
64
64
|
"main": "lib/index.js",
|
|
65
65
|
"oclif": {
|
|
66
66
|
"commands": "./lib/commands",
|
|
@@ -94,7 +94,6 @@
|
|
|
94
94
|
"docs": "sf-docs",
|
|
95
95
|
"format": "wireit",
|
|
96
96
|
"lint": "wireit",
|
|
97
|
-
"postinstall": "yarn husky install",
|
|
98
97
|
"postpack": "shx rm -f oclif.manifest.json",
|
|
99
98
|
"prepack": "sf-prepack",
|
|
100
99
|
"test": "wireit",
|
|
@@ -205,10 +204,5 @@
|
|
|
205
204
|
],
|
|
206
205
|
"output": []
|
|
207
206
|
}
|
|
208
|
-
},
|
|
209
|
-
"author": "Palak Bansal",
|
|
210
|
-
"directories": {
|
|
211
|
-
"lib": "lib",
|
|
212
|
-
"test": "test"
|
|
213
207
|
}
|
|
214
|
-
}
|
|
208
|
+
}
|