Skip to content

Commit

Permalink
fix: add help class to display additional cmd help (#52)
Browse files Browse the repository at this point in the history 
* feat: add help class to display additional cmd help

@W-9791511@ add custom help class

* chore: test orb change

* test

* chore: remove dev orb reference
  • Loading branch information
@peternhale
peternhale authored Sep 10, 2021
1 parent 745f6e2 commit ea7fe61
Show file tree
Hide file tree
Showing 5 changed files with 208 additions and 222 deletions.
347 changes: 125 additions & 222 deletions command-snapshot.json
View file
Original file line number Diff line number Diff line change
@@ -1,223 +1,126 @@
[
{
"command": "commandreference:generate",
"plugin": "@salesforce/plugin-command-reference",
"flags": [
"ditamap-suffix",
"erroronwarnings",
"hidden",
"json",
"outputdir",
"plugins"
]
},
{
"command": "config:get",
"plugin": "@salesforce/plugin-config",
"flags": [
"json",
"verbose"
]
},
{
"command": "config:list",
"plugin": "@salesforce/plugin-config",
"flags": [
"json"
]
},
{
"command": "config:set",
"plugin": "@salesforce/plugin-config",
"flags": [
"global",
"json"
]
},
{
"command": "config:unset",
"plugin": "@salesforce/plugin-config",
"flags": [
"global",
"json"
]
},
{
"command": "deploy",
"plugin": "@salesforce/plugin-deploy-retrieve",
"flags": [
"interactive"
]
},
{
"command": "deploy:metadata",
"plugin": "@salesforce/plugin-deploy-retrieve-metadata",
"flags": [
"json",
"manifest",
"metadata",
"source-dir",
"target-org",
"test-level",
"wait"
]
},
{
"command": "env:display",
"plugin": "@salesforce/plugin-env",
"flags": [
"json",
"target-env"
]
},
{
"command": "env:list",
"plugin": "@salesforce/plugin-env",
"flags": [
"all",
"columns",
"csv",
"filter",
"json",
"no-header",
"no-truncate",
"output",
"sort"
]
},
{
"command": "env:open",
"plugin": "@salesforce/plugin-env",
"flags": [
"browser",
"json",
"path",
"target-env",
"url-only"
]
},
{
"command": "help",
"plugin": "@oclif/plugin-help",
"flags": [
"all",
"json"
]
},
{
"command": "login",
"plugin": "@salesforce/plugin-login",
"flags": []
},
{
"command": "login:org",
"plugin": "@salesforce/plugin-login",
"flags": [
"alias",
"browser",
"clientid",
"instance-url",
"json",
"set-default",
"set-default-dev-hub"
]
},
{
"command": "login:org:jwt",
"plugin": "@salesforce/plugin-login",
"flags": [
"alias",
"clientid",
"instance-url",
"json",
"jwt-key-file",
"set-default",
"set-default-dev-hub",
"username"
]
},
{
"command": "logout",
"plugin": "@salesforce/plugin-login",
"flags": [
"json",
"no-prompt"
]
},
{
"command": "logout:org",
"plugin": "@salesforce/plugin-login",
"flags": [
"json",
"no-prompt",
"target-org"
]
},
{
"command": "plugins",
"plugin": "@oclif/plugin-plugins",
"flags": [
"core"
]
},
{
"command": "plugins:inspect",
"plugin": "@oclif/plugin-plugins",
"flags": [
"help",
"verbose"
]
},
{
"command": "plugins:install",
"plugin": "@oclif/plugin-plugins",
"flags": [
"force",
"help",
"verbose"
]
},
{
"command": "plugins:link",
"plugin": "@oclif/plugin-plugins",
"flags": [
"help",
"verbose"
]
},
{
"command": "plugins:uninstall",
"plugin": "@oclif/plugin-plugins",
"flags": [
"help",
"verbose"
]
},
{
"command": "plugins:update",
"plugin": "@oclif/plugin-plugins",
"flags": [
"help",
"verbose"
]
},
{
"command": "retrieve:metadata",
"plugin": "@salesforce/plugin-deploy-retrieve-metadata",
"flags": [
"api-version",
"json",
"manifest",
"metadata",
"package-name",
"source-dir",
"target-org",
"wait"
]
},
{
"command": "telemetry",
"plugin": "@salesforce/plugin-telemetry",
"flags": []
}
]
{
"command": "config:get",
"plugin": "@salesforce/plugin-config",
"flags": ["json", "verbose"]
},
{
"command": "config:list",
"plugin": "@salesforce/plugin-config",
"flags": ["json"]
},
{
"command": "config:set",
"plugin": "@salesforce/plugin-config",
"flags": ["global", "json"]
},
{
"command": "config:unset",
"plugin": "@salesforce/plugin-config",
"flags": ["global", "json"]
},
{
"command": "deploy",
"plugin": "@salesforce/plugin-deploy-retrieve",
"flags": ["interactive"]
},
{
"command": "deploy:metadata",
"plugin": "@salesforce/plugin-deploy-retrieve-metadata",
"flags": ["json", "manifest", "metadata", "source-dir", "target-org", "test-level", "wait"]
},
{
"command": "env:display",
"plugin": "@salesforce/plugin-env",
"flags": ["json", "target-env"]
},
{
"command": "env:list",
"plugin": "@salesforce/plugin-env",
"flags": ["all", "columns", "csv", "filter", "json", "no-header", "no-truncate", "output", "sort"]
},
{
"command": "env:open",
"plugin": "@salesforce/plugin-env",
"flags": ["browser", "json", "path", "target-env", "url-only"]
},
{
"command": "help",
"plugin": "@oclif/plugin-help",
"flags": ["all", "json"]
},
{
"command": "login",
"plugin": "@salesforce/plugin-login",
"flags": []
},
{
"command": "login:org",
"plugin": "@salesforce/plugin-login",
"flags": ["alias", "browser", "clientid", "instance-url", "json", "set-default", "set-default-dev-hub"]
},
{
"command": "login:org:jwt",
"plugin": "@salesforce/plugin-login",
"flags": [
"alias",
"clientid",
"instance-url",
"json",
"jwt-key-file",
"set-default",
"set-default-dev-hub",
"username"
]
},
{
"command": "logout",
"plugin": "@salesforce/plugin-login",
"flags": ["json", "no-prompt"]
},
{
"command": "logout:org",
"plugin": "@salesforce/plugin-login",
"flags": ["json", "no-prompt", "target-org"]
},
{
"command": "plugins",
"plugin": "@oclif/plugin-plugins",
"flags": ["core"]
},
{
"command": "plugins:inspect",
"plugin": "@oclif/plugin-plugins",
"flags": ["help", "verbose"]
},
{
"command": "plugins:install",
"plugin": "@oclif/plugin-plugins",
"flags": ["force", "help", "verbose"]
},
{
"command": "plugins:link",
"plugin": "@oclif/plugin-plugins",
"flags": ["help", "verbose"]
},
{
"command": "plugins:uninstall",
"plugin": "@oclif/plugin-plugins",
"flags": ["help", "verbose"]
},
{
"command": "plugins:update",
"plugin": "@oclif/plugin-plugins",
"flags": ["help", "verbose"]
},
{
"command": "retrieve:metadata",
"plugin": "@salesforce/plugin-deploy-retrieve-metadata",
"flags": ["api-version", "json", "manifest", "metadata", "package-name", "source-dir", "target-org", "wait"]
},
{
"command": "telemetry",
"plugin": "@salesforce/plugin-telemetry",
"flags": []
}
]
2 changes: 2 additions & 0 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
"state": "beta",
"topicSeparator": " ",
"commands": "./dist/commands",
"helpClass": "./dist/help/sfHelp.js",
"plugins": [
"@oclif/plugin-help",
"@oclif/plugin-not-found",
Expand Down Expand Up @@ -73,6 +74,7 @@
"@oclif/plugin-help": "^4.0.3",
"@oclif/plugin-not-found": "^2.1.3",
"@oclif/plugin-plugins": "^1.10.1",
"@salesforce/command": "^4.1.0",
"@salesforce/plugin-telemetry": "1.2.3",
"@sf/config": "npm:@salesforce/[email protected]",
"@sf/deploy-retrieve": "npm:@salesforce/[email protected]",
Expand Down
Loading

0 comments on commit ea7fe61

Please sign in to comment.