@salesforce/test-plugin117 1.1.0 → 1.7.0

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 (4) hide show
  1. package/LICENSE.txt +12 -0
  2. package/README.md +39 -33
  3. package/oclif.manifest.json +1 -1
  4. package/package.json +95 -78
package/LICENSE.txt ADDED
@@ -0,0 +1,12 @@
1
+ Copyright (c) 2022, Salesforce.com, Inc.
2
+ All rights reserved.
3
+
4
+ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
5
+
6
+ * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
7
+
8
+ * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
9
+
10
+ * Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
11
+
12
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package/README.md CHANGED
@@ -1,7 +1,4 @@
1
- testPlugin117
2
- =============
3
-
4
-
1
+ # testPlugin117
5
2
 
6
3
  [![Version](https://img.shields.io/npm/v/testPlugin117.svg)](https://npmjs.org/package/testPlugin117)
7
4
  [![CircleCI](https://circleci.com/gh/vmundra/testPlugin117/tree/master.svg?style=shield)](https://circleci.com/gh/vmundra/testPlugin117/tree/master)
@@ -12,24 +9,28 @@ testPlugin117
12
9
  [![License](https://img.shields.io/npm/l/testPlugin117.svg)](https://github.com/vmundra/testPlugin117/blob/master/package.json)
13
10
 
14
11
  <!-- toc -->
15
- * [Debugging your plugin](#debugging-your-plugin)
16
- <!-- tocstop -->
17
- <!-- install -->
18
- <!-- usage -->
12
+
13
+ - [Debugging your plugin](#debugging-your-plugin)
14
+ <!-- tocstop -->
15
+ <!-- install -->
16
+ <!-- usage -->
17
+
19
18
  ```sh-session
20
19
  $ npm install -g @salesforce/test-plugin117
21
20
  $ sfdx COMMAND
22
21
  running command...
23
- $ sfdx (-v|--version|version)
24
- @salesforce/test-plugin117/1.1.0 linux-x64 node-v16.16.0
22
+ $ sfdx (--version)
23
+ @salesforce/test-plugin117/1.5.3 darwin-x64 node-v16.13.2
25
24
  $ sfdx --help [COMMAND]
26
25
  USAGE
27
26
  $ sfdx COMMAND
28
27
  ...
29
28
  ```
29
+
30
30
  <!-- usagestop -->
31
31
  <!-- commands -->
32
- * [`sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-helloorg--n-string--f--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
32
+
33
+ - [`sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-helloorg--n-string--f--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
33
34
 
34
35
  ## `sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
35
36
 
@@ -37,47 +38,52 @@ print a greeting and your org IDs
37
38
 
38
39
  ```
39
40
  USAGE
40
- $ sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
41
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
41
+ $ sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
42
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
42
43
 
43
- OPTIONS
44
+ FLAGS
44
45
  -f, --force example boolean flag
45
- -n, --name=name name to print
46
-
47
- -u, --targetusername=targetusername username or alias for the target
46
+ -n, --name=<value> name to print
47
+ -u, --targetusername=<value> username or alias for the target
48
48
  org; overrides default target org
49
-
50
- -v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub
49
+ -v, --targetdevhubusername=<value> username or alias for the dev hub
51
50
  org; overrides default dev hub org
52
-
53
- --apiversion=apiversion override the api version used for
51
+ --apiversion=<value> override the api version used for
54
52
  api requests made by this command
55
-
56
53
  --json format output as json
57
-
58
54
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
59
55
  this command invocation
60
56
 
57
+ DESCRIPTION
58
+ print a greeting and your org IDs
59
+
61
60
  EXAMPLES
62
- sfdx hello:org --targetusername myOrg@example.com --targetdevhubusername devhub@org.com
63
- sfdx hello:org --name myname --targetusername myOrg@example.com
61
+ $ sfdx hello:org --targetusername myOrg@example.com --targetdevhubusername devhub@org.com
62
+
63
+ $ sfdx hello:org --name myname --targetusername myOrg@example.com
64
64
  ```
65
65
 
66
- _See code: [src/commands/hello/org.ts](https://github.com/vmundra/testPlugin117/blob/v1.1.0/src/commands/hello/org.ts)_
66
+ _See code: [src/commands/hello/org.ts](https://github.com/vmundra/testPlugin117/blob/v1.5.3/src/commands/hello/org.ts)_
67
+
67
68
  <!-- commandsstop -->
68
69
  <!-- debugging-your-plugin -->
70
+
69
71
  # Debugging your plugin
72
+
70
73
  We recommend using the Visual Studio Code (VS Code) IDE for your plugin development. Included in the `.vscode` directory of this plugin is a `launch.json` config file, which allows you to attach a debugger to the node process when running your commands.
71
74
 
72
- To debug the `hello:org` command:
75
+ To debug the `hello:org` command:
76
+
73
77
  1. Start the inspector
74
-
75
- If you linked your plugin to the sfdx cli, call your command with the `dev-suspend` switch:
78
+
79
+ If you linked your plugin to the sfdx cli, call your command with the `dev-suspend` switch:
80
+
76
81
  ```sh-session
77
82
  $ sfdx hello:org -u myOrg@example.com --dev-suspend
78
83
  ```
79
-
84
+
80
85
  Alternatively, to call your command using the `bin/run` script, set the `NODE_OPTIONS` environment variable to `--inspect-brk` when starting the debugger:
86
+
81
87
  ```sh-session
82
88
  $ NODE_OPTIONS=--inspect-brk bin/run hello:org -u myOrg@example.com
83
89
  ```
@@ -85,7 +91,7 @@ $ NODE_OPTIONS=--inspect-brk bin/run hello:org -u myOrg@example.com
85
91
  2. Set some breakpoints in your command code
86
92
  3. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
87
93
  4. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
88
- 5. Hit the green play button to the left of the "Attach to Remote" launch configuration window. The debugger should now be suspended on the first line of the program.
94
+ 5. Hit the green play button to the left of the "Attach to Remote" launch configuration window. The debugger should now be suspended on the first line of the program.
89
95
  6. Hit the green play button at the top middle of VS Code (this play button will be to the right of the play button that you clicked in step #5).
90
- <br><img src=".images/vscodeScreenshot.png" width="480" height="278"><br>
91
- Congrats, you are debugging!
96
+ <br><img src=".images/vscodeScreenshot.png" width="480" height="278"><br>
97
+ Congrats, you are debugging!
package/oclif.manifest.json CHANGED
@@ -1 +1 @@
1
- {"version":"1.1.0","commands":{"hello:org":{"id":"hello:org","description":"print a greeting and your org IDs","usage":"<%= command.id %> [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/test-plugin117","pluginType":"core","aliases":[],"examples":["sfdx hello:org --targetusername myOrg@example.com --targetdevhubusername devhub@org.com","sfdx hello:org --name myname --targetusername myOrg@example.com"],"flags":{"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)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"name":{"name":"name","type":"option","char":"n","description":"name to print"},"force":{"name":"force","type":"boolean","char":"f","description":"example boolean flag","allowNo":false}},"args":[{"name":"file"}]}}}
1
+ {"version":"1.7.0","commands":{"hello:org":{"id":"hello:org","description":"print a greeting and your org IDs","strict":true,"usage":"<%= command.id %> [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/test-plugin117","pluginAlias":"@salesforce/test-plugin117","pluginType":"core","aliases":[],"examples":["sfdx hello:org --targetusername myOrg@example.com --targetdevhubusername devhub@org.com","sfdx hello:org --name myname --targetusername myOrg@example.com"],"flags":{"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"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"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},"name":{"name":"name","type":"option","char":"n","description":"name to print","multiple":false},"force":{"name":"force","type":"boolean","char":"f","description":"example boolean flag","allowNo":false}},"args":[{"name":"file"}],"flagsConfig":{"name":{"kind":"string","char":"n","description":"name to print","input":[],"multiple":false,"type":"option"},"force":{"kind":"boolean","char":"f","description":"example boolean flag","allowNo":false,"type":"boolean"}},"requiresUsername":true,"supportsDevhubUsername":true,"requiresProject":false}}}
package/package.json CHANGED
@@ -1,80 +1,97 @@
1
1
  {
2
- "name": "@salesforce/test-plugin117",
3
- "version": "1.1.0",
4
- "author": "Vamsi-Mundra-Salesforce",
5
- "bugs": "https://github.com/vmundra/testPlugin117/issues",
6
- "dependencies": {
7
- "@oclif/core": "^1",
8
- "@salesforce/command": "^5.2.6",
9
- "@salesforce/core": "^3.26.2",
10
- "tslib": "^2"
11
- },
12
- "devDependencies": {
13
- "@salesforce/dev-config": "^2",
14
- "@salesforce/dev-scripts": "^3.1.0",
15
- "@salesforce/prettier-config": "^0",
16
- "@salesforce/ts-sinon": "^1",
17
- "@types/chai": "^4",
18
- "@types/mocha": "^8",
19
- "@typescript-eslint/eslint-plugin": "^4",
20
- "@typescript-eslint/parser": "^4",
21
- "chai": "^4",
22
- "eslint": "^7",
23
- "eslint-config-prettier": "^8",
24
- "eslint-config-salesforce": "^0",
25
- "eslint-config-salesforce-typescript": "^0",
26
- "eslint-plugin-header": "^3",
27
- "eslint-plugin-import": "^2",
28
- "eslint-plugin-jsdoc": "^35",
29
- "eslint-plugin-typescript": "^0",
30
- "globby": "^11",
31
- "husky": "^4",
32
- "mocha": "^8",
33
- "nyc": "^15",
34
- "oclif": "^2.7.0",
35
- "prettier": "^2",
36
- "pretty-quick": "^3",
37
- "sinon": "10.0.0",
38
- "ts-node": "^10",
39
- "typescript": "4"
40
- },
41
- "engines": {
42
- "node": ">=12.0.0"
43
- },
44
- "files": [
45
- "/lib",
46
- "/messages",
47
- "/npm-shrinkwrap.json",
48
- "/oclif.manifest.json"
49
- ],
50
- "homepage": "https://github.com/vmundra/testPlugin117",
51
- "keywords": [
52
- "sfdx-plugin"
53
- ],
54
- "license": "MIT",
55
- "oclif": {
56
- "commands": "./lib/commands",
57
- "bin": "sfdx",
58
- "topics": {
59
- "hello": {
60
- "description": "Commands to say hello."
61
- }
2
+ "name": "@salesforce/test-plugin117",
3
+ "version": "1.7.0",
4
+ "author": "Vamsi-Mundra-Salesforce",
5
+ "bugs": "https://github.com/vmundra/testPlugin117/issues",
6
+ "dependencies": {
7
+ "@oclif/core": "^1",
8
+ "@salesforce/command": "^5.2.6",
9
+ "@salesforce/core": "^3.26.2",
10
+ "tslib": "^2"
62
11
  },
63
- "devPlugins": [
64
- "@oclif/plugin-help"
65
- ]
66
- },
67
- "repository": "vmundra/testPlugin117",
68
- "scripts": {
69
- "build": "tsc -p .",
70
- "lint": "eslint src/**/*.ts test/**/*.ts",
71
- "postpack": "rm -f oclif.manifest.json",
72
- "posttest": "eslint src/**/*.ts test/**/*.ts",
73
- "prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
74
- "test": "nyc --extension .ts --require ts-node/register mocha --forbid-only \"test/**/*.test.ts\"",
75
- "version": "oclif-dev readme && git add README.md"
76
- },
77
- "publishConfig": {
78
- "access": "public"
79
- }
80
- }
12
+ "devDependencies": {
13
+ "@oclif/plugin-command-snapshot": "^3.1.3",
14
+ "@salesforce/dev-config": "^3.0.0",
15
+ "@salesforce/dev-scripts": "^3.1.0",
16
+ "@salesforce/plugin-command-reference": "^1.4.0",
17
+ "@salesforce/prettier-config": "^0.0.2",
18
+ "@salesforce/ts-sinon": "^1",
19
+ "@typescript-eslint/eslint-plugin": "^5.33.0",
20
+ "@typescript-eslint/parser": "^5.33.0",
21
+ "chai": "^4.2.0",
22
+ "eslint": "^8.21.0",
23
+ "eslint-config-prettier": "^8.5.0",
24
+ "eslint-config-salesforce": "^1.1.0",
25
+ "eslint-config-salesforce-license": "^0.1.6",
26
+ "eslint-config-salesforce-typescript": "^1.1.1",
27
+ "eslint-plugin-header": "^3.0.0",
28
+ "eslint-plugin-import": "^2.26.0",
29
+ "eslint-plugin-jsdoc": "^39.3.6",
30
+ "eslint-plugin-typescript": "^0",
31
+ "globby": "^11",
32
+ "husky": "^7.0.4",
33
+ "mocha": "^9.1.3",
34
+ "nyc": "^15.1.0",
35
+ "oclif": "^3.0.1",
36
+ "prettier": "^2.7.1",
37
+ "pretty-quick": "^3.1.0",
38
+ "sinon": "10.0.0",
39
+ "ts-node": "^10.0.0",
40
+ "typescript": "^4.1.3"
41
+ },
42
+ "engines": {
43
+ "node": ">=14.0.0"
44
+ },
45
+ "files": [
46
+ "/lib",
47
+ "/messages",
48
+ "/npm-shrinkwrap.json",
49
+ "/oclif.manifest.json"
50
+ ],
51
+ "homepage": "https://github.com/vmundra/testPlugin117",
52
+ "keywords": [
53
+ "sfdx-plugin"
54
+ ],
55
+ "license": "BSD-3-Clause",
56
+ "oclif": {
57
+ "commands": "./lib/commands",
58
+ "bin": "sfdx",
59
+ "topics": {
60
+ "hello": {
61
+ "description": "Commands to say hello."
62
+ }
63
+ },
64
+ "devPlugins": [
65
+ "@oclif/plugin-help",
66
+ "@oclif/plugin-command-snapshot",
67
+ "@salesforce/plugin-command-reference"
68
+ ]
69
+ },
70
+ "repository": "vmundra/testPlugin117",
71
+ "scripts": {
72
+ "build": "sf-build",
73
+ "clean": "sf-clean",
74
+ "clean-all": "sf-clean all",
75
+ "clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json",
76
+ "compile": "sf-compile",
77
+ "docs": "sf-docs",
78
+ "format": "sf-format",
79
+ "lint": "sf-lint",
80
+ "postpack": "shx rm -f oclif.manifest.json",
81
+ "posttest": "yarn lint && yarn test:deprecation-policy && yarn test:command-reference",
82
+ "prepack": "sf-prepack",
83
+ "prepare": "sf-install",
84
+ "pretest": "sf-compile-test",
85
+ "test": "sf-test",
86
+ "test:command-reference": "./bin/dev commandreference:generate --erroronwarnings",
87
+ "test:deprecation-policy": "./bin/dev snapshot:compare",
88
+ "version": "oclif readme"
89
+ },
90
+ "publishConfig": {
91
+ "access": "public"
92
+ },
93
+ "sfdx": {
94
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/test-plugin117/1.7.0.crt",
95
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/test-plugin117/1.7.0.sig"
96
+ }
97
+ }