From 8f680ab456e63c900ac7e8275a5a05b6c8be4e23 Mon Sep 17 00:00:00 2001 From: mshanemc Date: Tue, 26 Jan 2021 15:34:17 -0600 Subject: [PATCH 1/3] docs: list output matches original; regen readme --- README.md | 23 +++++++++++------------ messages/list.json | 12 ++++++------ 2 files changed, 17 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 557d54a3..03d8206f 100644 --- a/README.md +++ b/README.md @@ -124,11 +124,11 @@ EXAMPLES sfdx force:org:display -u TestOrg1 --json > tmp/MyOrgDesc.json ``` -_See code: [src/commands/force/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/v1.1.1/src/commands/force/org/display.ts)_ +_See code: [src/commands/force/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/v1.1.0/src/commands/force/org/display.ts)_ ## `sfdx force:org:list [--all] [-p --clean] [--skipconnectionstatus] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` -list all orgs that the Salesforce CLI has created or authenticated to +list all orgs you’ve created or authenticated to ``` USAGE @@ -136,27 +136,26 @@ USAGE trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS - -p, --noprompt Do not prompt for confirmation. + -p, --noprompt do not prompt for confirmation - --all Lists all authenticated orgs, - including expired, deleted, and - unknown-status scratch orgs. + --all include expired, deleted, and + unknown-status scratch orgs - --clean Remove all local org authorizations - for deleted or expired orgs. + --clean remove all local org authorizations + for non-active orgs --json format output as json --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation - --skipconnectionstatus Skips retrieving the connection + --skipconnectionstatus skips retrieving the connection status of non-scratch orgs - --verbose Lists more information about each - org. + --verbose list more information about each + org' ``` -_See code: [src/commands/force/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/v1.1.1/src/commands/force/org/list.ts)_ +_See code: [src/commands/force/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/v1.1.0/src/commands/force/org/list.ts)_ diff --git a/messages/list.json b/messages/list.json index 4adf9621..1e8e8d6a 100644 --- a/messages/list.json +++ b/messages/list.json @@ -1,16 +1,16 @@ { - "description": "list all orgs that the Salesforce CLI has created or authenticated to", + "description": "list all orgs you’ve created or authenticated to", "examples": [ "sfdx force:org:list", "sfdx force:org:list --verbose --json", "sfdx force:org:list --verbose --json > tmp/MyOrgList.json" ], - "verbose": "Lists more information about each org.", - "all": "Lists all authenticated orgs, including expired, deleted, and unknown-status scratch orgs.", - "clean": "Remove all local org authorizations for deleted or expired orgs.", - "noPrompt": "Do not prompt for confirmation.", - "skipConnectionStatus": "Skips retrieving the connection status of non-scratch orgs", + "verbose": "list more information about each org'", + "all": "include expired, deleted, and unknown-status scratch orgs", + "clean": "remove all local org authorizations for non-active orgs", + "noPrompt": "do not prompt for confirmation", + "skipConnectionStatus": "skips retrieving the connection status of non-scratch orgs", "prompt": "Found (%s) org configurations to delete. Are you sure (yes/no)?", "noActiveScratchOrgs": "No active scratch orgs found. Specify --all to see all scratch orgs", From b8fc9da2e3dd32e08a8f08c2c9445de11fa8dc83 Mon Sep 17 00:00:00 2001 From: mshanemc Date: Wed, 27 Jan 2021 09:19:55 -0600 Subject: [PATCH 2/3] style: doc styling --- messages/display.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/messages/display.json b/messages/display.json index a302c22b..9e1b5ed2 100644 --- a/messages/display.json +++ b/messages/display.json @@ -1,5 +1,5 @@ { - "description": "get the description for the current or target org.\nOutput includes your access token, client Id, connected status, org ID, instance URL, username, and alias, if applicable.\nUse --verbose to include the SFDX auth URL.\nIncluding --verbose displays the sfdxAuthUrl property only if you authenticated to the org using auth:web:login (not auth:jwt:grant)", + "description": "get the description for the current or target org\nOutput includes your access token, client Id, connected status, org ID, instance URL, username, and alias, if applicable.\nUse --verbose to include the SFDX auth URL.\nIncluding --verbose displays the sfdxAuthUrl property only if you authenticated to the org using auth:web:login (not auth:jwt:grant)", "examples": [ "sfdx force:org:display", "sfdx force:org:display -u me@my.org", From d2b99262ceb50799d92e73b48bc3de23883cae9b Mon Sep 17 00:00:00 2001 From: mshanemc Date: Wed, 27 Jan 2021 09:21:21 -0600 Subject: [PATCH 3/3] docs: regenerate readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 03d8206f..c58491c1 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,7 @@ sfdx plugins ## `sfdx force:org:display [-v ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` -get the description for the current or target org. +get the description for the current or target org ``` USAGE