Sm/sf command (#542)

* refactor: sfCommand (and all nuts pass)

* feat: use sfComand

* docs: message conversion

* test: ut conversion

* refactor: share sandboxRequest

* test: ut conversion for status

* test: ut all work

* fix: aliases and default markings

* chore: todo cleanup

* chore: consistent api-version and loglevel

* feat: deprecate 4 commands, remove beta

* feat: sf-ify 3 commands

* chore: bump linter

* docs: don't put versions for deprecations

* chore: bump plugins-ore

* chore: snapshots and schemas

* chore: org topic

* chore: bump dep

* chore: linter updates

* test: temporarily remove deprecation for UT reasons

* docs: sf-ify messages

* feat: add commands from plugin-env as is for comparison

* feat: refactor commands

* test: refactor tests

* chore: schema

* chore: snapshot

* test: original org nuts pass because aliases.  + new schemas

* test: all NUTs passing

* refactor: reduce eslint pragma

* chore: snapshot

* feat: faster org:list via parallelization

* chore: sfCommand subscribes lifecycleEvents automatically

* refactor: non-case-sensitive alias sorting

* refactor: simplify default markers

* docs: extract message, use new command format

* test: windows paths without ./

* test: powershell command-ref

* test: comspec absolute path

* test: another comspec attempt

* test: try yarn config to set shell for windows

* docs: todo reminder

* test: try compspec env

* test: escape and quote for windoze

* test: quote the full path

* fix: (windows) handle undefined username

* chore: bump dev-scripts

* test: test all the things

* test: wireit windows cache wth longer nut timeout

* chore: test-compile not a dependency

* chore: bump dev-scripts, fix pjson

* test: organize tests

* chore: bump wireit/pjson

* test: [sb-nuts]

* chore: reorganize NUTs

* test: parallelize NUTs more

* test: fix import paths

* test: wireit on ghw/main

* test: all sbox nuts pass locally

* test: sandbox-nuts as on-demand workflow

* test: correct nuts path

* chore: get script name right

* docs: readme comment about sbnuts [no-ci]

* test: keep sbox status nut from using nuts from other sbox nuts

* chore: longer waits on org create to prevent nut re-runs

* test: use default waits

* test: sbox doesn't catch mocha assert errors [skip-ci]

* test: tracing windows NUT failure [no ci]

* test: no single quotes in windows [no ci]

* chore: bump dev-scripts

* test: nut imports messages it depends on

* chore: bump core for type change on Snapshot

* fix: message was wrong when it came over from plugin-env

* fix: clean up the messages

* fix: set version of command-ref plugin that ignores missing descriptions

* fix: new yarn.lock

* chore: deprecation message for force:org:create

* docs: resolve comments and sf env references

* fix: message placeholder checks

* chore: remove oclif/test

* docs: remove bin references from commands

* chore: bump oclif core, bin into message placeholders

* chore: get action tokens right

* test: remove deprecation (pending oclif bug)

* chore: lockfile dedupe

* fix: stopSpinner to avoid oclif bug

* refactor: isObject instead of filtering out the undefined

---------

Co-authored-by: Juliet Shackell <[email protected]>

Author: mshanemc

.eslintrc.js

@@ -5,5 +5,5 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 module.exports = {
-  extends: ['eslint-config-salesforce-typescript', 'eslint-config-salesforce-license'],
+  extends: ['eslint-config-salesforce-typescript', 'eslint-config-salesforce-license', 'plugin:sf-plugin/recommended'],
 };

.github/workflows/test.yml

@@ -13,6 +13,7 @@ jobs:
     uses: salesforcecli/github-workflows/.github/workflows/unitTestsLinux.yml@main
   windows-unit-tests:
     needs: linux-unit-tests
+    # TODO: use main
     uses: salesforcecli/github-workflows/.github/workflows/unitTestsWindows.yml@main
   nuts:
     needs: linux-unit-tests
@@ -21,6 +22,8 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
+        command: ['yarn test:nuts', 'yarn test:nuts:legacy']
       fail-fast: false
     with:
       os: ${{ matrix.os }}
+      command: ${{ matrix.command}}

.gitignore

@@ -31,6 +31,9 @@ docs
 package.json.bak.
 
 # -- CLEAN ALL
+*.tsbuildinfo
+.eslintcache
+.wireit
 node_modules
 
 # --

CHANGELOG.md

@@ -1,4 +1,4 @@
-Copyright (c) 2022, Salesforce.com, Inc.
+Copyright (c) 2023, Salesforce.com, Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

LICENSE.txt

@@ -74,6 +74,10 @@ sfdx plugins:link .
 sfdx plugins
 ```
 
+### Sandbox NUTs
+
+Sandboxes are pretty slow, and there's a constraint to how many we can have. So if your changes might impact sandboxes, and you want to check those in the real world, run the [SandboxNuts](https://github.com/salesforcecli/plugin-org/actions/workflows/sandboxNuts.yml) Github Action.
+
 ## Commands
 
 <!-- commands -->

README.md

@@ -3,13 +3,13 @@
     "command": "force:org:clone",
     "plugin": "@salesforce/plugin-org",
     "flags": [
-      "apiversion",
+      "api-version",
       "definitionfile",
       "json",
       "loglevel",
       "setalias",
       "setdefaultusername",
-      "targetusername",
+      "target-org",
       "type",
       "wait"
     ],
@@ -19,7 +19,7 @@
     "command": "force:org:create",
     "plugin": "@salesforce/plugin-org",
     "flags": [
-      "apiversion",
+      "api-version",
       "clientid",
       "definitionfile",
       "durationdays",
@@ -30,50 +30,106 @@
       "retry",
       "setalias",
       "setdefaultusername",
-      "targetdevhubusername",
-      "targetusername",
+      "target-dev-hub",
+      "target-org",
       "type",
       "wait"
     ],
-    "alias": ["force:org:beta:create"]
-  },
-  {
-    "command": "force:org:delete",
-    "plugin": "@salesforce/plugin-org",
-    "flags": ["apiversion", "json", "loglevel", "noprompt", "targetdevhubusername", "targetusername"],
     "alias": []
   },
   {
-    "command": "force:org:display",
+    "command": "force:org:delete",
     "plugin": "@salesforce/plugin-org",
-    "flags": ["apiversion", "json", "loglevel", "targetusername", "verbose"],
+    "flags": ["api-version", "json", "loglevel", "no-prompt", "target-org"],
     "alias": []
   },
   {
-    "command": "force:org:list",
+    "command": "force:org:status",
     "plugin": "@salesforce/plugin-org",
-    "flags": ["all", "clean", "json", "loglevel", "noprompt", "skipconnectionstatus", "verbose"],
+    "flags": ["api-version", "json", "loglevel", "sandboxname", "setalias", "setdefaultusername", "target-org", "wait"],
     "alias": []
   },
   {
-    "command": "force:org:open",
+    "command": "org:create:sandbox",
     "plugin": "@salesforce/plugin-org",
-    "flags": ["apiversion", "browser", "json", "loglevel", "path", "targetusername", "urlonly"],
-    "alias": []
+    "flags": [
+      "alias",
+      "async",
+      "clone",
+      "definition-file",
+      "json",
+      "license-type",
+      "name",
+      "no-prompt",
+      "no-track-source",
+      "poll-interval",
+      "set-default",
+      "target-org",
+      "wait"
+    ],
+    "alias": ["env:create:sandbox"]
   },
   {
-    "command": "force:org:status",
+    "command": "org:create:scratch",
     "plugin": "@salesforce/plugin-org",
     "flags": [
-      "apiversion",
+      "alias",
+      "api-version",
+      "async",
+      "client-id",
+      "definition-file",
+      "duration-days",
+      "edition",
       "json",
-      "loglevel",
-      "sandboxname",
-      "setalias",
-      "setdefaultusername",
-      "targetusername",
+      "no-ancestors",
+      "no-namespace",
+      "set-default",
+      "target-dev-hub",
+      "track-source",
       "wait"
     ],
-    "alias": []
+    "alias": ["env:create:scratch"]
+  },
+  {
+    "command": "org:delete:sandbox",
+    "plugin": "@salesforce/plugin-org",
+    "flags": ["json", "no-prompt", "target-org"],
+    "alias": ["env:delete:sandbox"]
+  },
+  {
+    "command": "org:delete:scratch",
+    "plugin": "@salesforce/plugin-org",
+    "flags": ["json", "no-prompt", "target-org"],
+    "alias": ["env:delete:scratch"]
+  },
+  {
+    "command": "org:display",
+    "plugin": "@salesforce/plugin-org",
+    "flags": ["api-version", "json", "loglevel", "target-org", "verbose"],
+    "alias": ["force:org:display"]
+  },
+  {
+    "command": "org:list",
+    "plugin": "@salesforce/plugin-org",
+    "flags": ["all", "clean", "json", "loglevel", "no-prompt", "skip-connection-status", "verbose"],
+    "alias": ["force:org:list"]
+  },
+  {
+    "command": "org:open",
+    "plugin": "@salesforce/plugin-org",
+    "flags": ["api-version", "browser", "json", "loglevel", "path", "target-org", "url-only"],
+    "alias": ["force:org:open"]
+  },
+  {
+    "command": "org:resume:sandbox",
+    "plugin": "@salesforce/plugin-org",
+    "flags": ["job-id", "json", "name", "target-org", "use-most-recent", "wait"],
+    "alias": ["env:resume:sandbox"]
+  },
+  {
+    "command": "org:resume:scratch",
+    "plugin": "@salesforce/plugin-org",
+    "flags": ["job-id", "json", "use-most-recent"],
+    "alias": ["env:resume:scratch"]
   }
 ]

command-snapshot.json

@@ -0,0 +1,67 @@
+# summary
+
+Clone a sandbox org.
+
+# success
+
+The sandbox org cloning process %s is in progress. Run "sfdx force:org:status -n %s" to check for status. If the org is ready, checking the status also logs the requesting user in to the sandbox org and authorizes the org for use with Salesforce CLI.
+
+# description
+
+There are two ways to clone a sandbox: either specify a sandbox definition file or provide key=value pairs at the command line. Key-value pairs at the command-line override their equivalent sandbox definition file values. In either case, you must specify both the "SandboxName" and "SourceSandboxName" options to set the names of the new sandbox and the one being cloned, respectively.
+
+Set the --targetusername (-u) parameter to a production org with sandbox licenses. The --type (-t) parameter is required and must be set to "sandbox".
+
+# examples
+
+- $ <%= config.bin %> <%= command.id %> -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox
+
+- $ <%= config.bin %> <%= command.id %> -t sandbox SandboxName=NewClonedSandbox SourceSandboxName=ExistingSandbox -u prodOrg -a MyDevSandbox
+
+# flags.type
+
+Type of org to create.
+
+# flags.wait
+
+Number of minutes to wait while polling for status.
+
+# flags.setdefaultusername
+
+Set the cloned org as your default.
+
+# flags.setalias
+
+Alias for the cloned org.
+
+# flags.definitionfile
+
+Path to the sandbox definition file.
+
+# flagsLong.wait
+
+Sets the streaming client socket timeout, in minutes. If the streaming client socket has no contact from the server for a number of minutes, the client exits. Specify a longer wait time if timeouts occur frequently.
+
+# commandSuccess
+
+The sandbox org cloning process %s is in progress. Run "sfdx force:org:status -n %s" to check for status. If the org is ready, checking the status also logs the requesting user in to the sandbox org and authorizes the org for use with Salesforce CLI.
+
+# missingLicenseType
+
+The sandbox license type is required, but you didn't provide a value. Specify the license type in the sandbox definition file with the "licenseType" option, or specify the option as a name-value pair at the command-line. See https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm for more information.
+
+# commandOrganizationTypeNotSupport
+
+The only supported org type is: %s
+
+# commandOrganizationTypeNotSupportAction
+
+force:org:clone -t %s
+
+# missingSourceSandboxName
+
+Specify a value for %s in a definition file or on the command line.
+
+# missingSourceSandboxNameAction
+
+To indicate which sandbox org you want to clone, specify %s in a definition file or as a command line argument.