Merge pull request #398 from salesforcecli/wr/replaceSfdx

docs: replace sfdx with sf
salesforcecli · Aug 24, 2023 · cf5e01a · cf5e01a
2 parents 3766a4b + 9dd92ac
commit cf5e01a
Show file tree

Hide file tree

Showing 11 changed files with 2,092 additions and 557 deletions.
diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md
@@ -34,6 +34,6 @@ _Feel free to attach a screenshot_.
 
 **VS Code Version**:
 
-**SFDX CLI Version**:
+**SF CLI Version**:
 
 **OS and version**:
diff --git a/DEVELOPING.md b/DEVELOPING.md
@@ -69,12 +69,12 @@ To run your modified plugin commands locally, use `./bin/dev` or `./bin/dev.cmd`
 There should be no differences when running via the Salesforce CLI or using the local scripts. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
 
 ```bash
-# Link your plugin to the sfdx cli
-sfdx plugins:link .
+# Link your plugin to the sf cli
+sf plugins:link .
 # To verify
-sfdx plugins
+sf plugins
 # To run
-sfdx force:package:create --help
+sf force package create --help
 ```
 
 ## Useful yarn commands

diff --git a/README.md b/README.md
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/plugin-packaging",
-  "description": "SFDX plugin that support Salesforce Packaging Platform",
+  "description": "SF plugin that support Salesforce Packaging Platform",
   "version": "1.22.2",
   "main": "lib/index.js",
   "author": "Salesforce",
@@ -65,13 +65,15 @@
     "force",
     "salesforce",
     "sfdx",
+    "sf",
     "salesforcedx",
-    "sfdx-plugin"
+    "sfdx-plugin",
+    "sf-plugin"
   ],
   "license": "BSD-3-Clause",
   "oclif": {
     "commands": "./lib/commands",
-    "bin": "sfdx",
+    "bin": "sf",
     "additionalVersionFlags": [
       "-v"
     ],

diff --git a/test/commands/package/install.test.ts b/test/commands/package/install.test.ts
@@ -172,7 +172,7 @@ describe('package:install', () => {
       const result = await cmd.run();
 
       expect(uxLogStub.calledOnce).to.be.true;
-      const msg = `PackageInstallRequest is currently InProgress. You can continue to query the status using${EOL}sfdx package:install:report -i 0Hf1h0000006sh2CAA -o ${testOrg.username}`;
+      const msg = `PackageInstallRequest is currently InProgress. You can continue to query the status using${EOL}sf package:install:report -i 0Hf1h0000006sh2CAA -o ${testOrg.username}`;
       expect(uxLogStub.args[0][0]).to.deep.equal(msg);
       expect(result).to.deep.equal(pkgInstallRequest);
       expect(installStub.args[0][0]).to.deep.equal(pkgInstallCreateRequest);
@@ -187,7 +187,7 @@ describe('package:install', () => {
       stubSpinner(cmd);
       const result = await cmd.run();
       expect(uxLogStub.callCount).to.equal(1);
-      const msg = `PackageInstallRequest is currently InProgress. You can continue to query the status using${EOL}sfdx package:install:report -i 0Hf1h0000006sh2CAA -o ${testOrg.username}`;
+      const msg = `PackageInstallRequest is currently InProgress. You can continue to query the status using${EOL}sf package:install:report -i 0Hf1h0000006sh2CAA -o ${testOrg.username}`;
       expect(uxLogStub.args[0][0]).to.equal(msg);
       expect(uxWarnStub.firstCall.args[0]).to.include(
         'The "-u" flag has been deprecated. Use "--target-org | -o" instead.'
@@ -370,7 +370,7 @@ describe('package:install', () => {
 
       expect(uxLogStub.callCount).to.equal(1);
       expect(uxWarnStub.args[0][0]).to.equal(warningMsg);
-      const msg = `PackageInstallRequest is currently InProgress. You can continue to query the status using${EOL}sfdx package:install:report -i 0Hf1h0000006sh2CAA -o ${testOrg.username}`;
+      const msg = `PackageInstallRequest is currently InProgress. You can continue to query the status using${EOL}sf package:install:report -i 0Hf1h0000006sh2CAA -o ${testOrg.username}`;
       expect(uxLogStub.args[0][0]).to.equal(msg);
       expect(result).to.deep.equal(pkgInstallRequest);
     });

diff --git a/test/commands/package/installReport.test.ts b/test/commands/package/installReport.test.ts
@@ -95,7 +95,7 @@ describe('package:install:report', () => {
     const result = await new Report(['-i', pkgInstallRequest.Id, '--target-org', testOrg.username], config).run();
     expect(result).to.deep.equal(pkgInstallRequest);
     expect(uxLogStub.calledOnce).to.be.true;
-    const msg = `PackageInstallRequest is currently InProgress. You can continue to query the status using${EOL}sfdx package:install:report -i 0Hf1h0000006sh2CAA -o ${testOrg.username}`;
+    const msg = `PackageInstallRequest is currently InProgress. You can continue to query the status using${EOL}sf package:install:report -i 0Hf1h0000006sh2CAA -o ${testOrg.username}`;
     expect(uxLogStub.args[0][0]).to.equal(msg);
   });
 

diff --git a/test/commands/package/packageUninstall.test.ts b/test/commands/package/packageUninstall.test.ts
@@ -72,7 +72,7 @@ describe('package:uninstall', () => {
     expect(result.Status).to.equal('InProgress');
     expect(logStub.callCount).to.equal(1);
     expect(logStub.firstCall.args[0]).to.deep.equal(
-      `PackageUninstallRequest is currently InProgress.${os.EOL}You can continue to query the status using sfdx package uninstall report -i 06y23000000002MXXX -o ${testOrg.username}`
+      `PackageUninstallRequest is currently InProgress.${os.EOL}You can continue to query the status using sf package uninstall report -i 06y23000000002MXXX -o ${testOrg.username}`
     );
   });
 

diff --git a/test/commands/package/packageVersionCreate.test.ts b/test/commands/package/packageVersionCreate.test.ts
@@ -95,7 +95,7 @@ describe('package:version:create - tests', () => {
       });
       expect(logStub.callCount).to.equal(1);
       expect(logStub.args[0]).to.deep.equal([
-        `Successfully created the package version [08c3i000000fylgAAA]. Subscriber Package Version Id: 04t3i000002eya2AAA${os.EOL}Package Installation URL: https://login.salesforce.com/packaging/installPackage.apexp?p0=04t3i000002eya2AAA${os.EOL}As an alternative, you can use the "sfdx package:install" command.`,
+        `Successfully created the package version [08c3i000000fylgAAA]. Subscriber Package Version Id: 04t3i000002eya2AAA${os.EOL}Package Installation URL: https://login.salesforce.com/packaging/installPackage.apexp?p0=04t3i000002eya2AAA${os.EOL}As an alternative, you can use the "sf package:install" command.`,
       ]);
     });
 

diff --git a/test/commands/package/packageVersionCreateReport.test.ts b/test/commands/package/packageVersionCreateReport.test.ts
@@ -161,7 +161,7 @@ describe('package:version:create:report - tests', () => {
         '(11) SampleDataController: Invalid type: Schema.Property__c\n(12) SampleDataController: Invalid type: Schema.Broker__c'
       );
       expect(warnStub.secondCall.args[0]).to.deep.equal(
-        `...${os.EOL}${os.EOL}To see all errors, run: sfdx data:soql:query -t -q "SELECT Message FROM Package2VersionCreateRequestError WHERE ParentRequest.Id='08c3i000000fyoVAAQ'" -o test@hub.org`
+        `...${os.EOL}${os.EOL}To see all errors, run: sf data:soql:query -t -q "SELECT Message FROM Package2VersionCreateRequestError WHERE ParentRequest.Id='08c3i000000fyoVAAQ'" -o test@hub.org`
       );
     });
   });

diff --git a/test/commands/package1/versionCreate.test.ts b/test/commands/package1/versionCreate.test.ts
@@ -86,7 +86,7 @@ describe('package1:version:create', () => {
     expect(result.Status).to.equal('QUEUED');
     expect(uxLogStub.callCount).to.equal(1);
     expect(uxLogStub.firstCall.args[0]).to.equal(
-      `PackageUploadRequest has been enqueued. You can query the status using${os.EOL}sfdx package1:version:create:get -i 0HD4p000000blUvGXX -o ${testOrg.username}`
+      `PackageUploadRequest has been enqueued. You can query the status using${os.EOL}sf package1:version:create:get -i 0HD4p000000blUvGXX -o ${testOrg.username}`
     );
   });
 

diff --git a/test/commands/package1/versionCreateGet.test.ts b/test/commands/package1/versionCreateGet.test.ts
@@ -83,9 +83,9 @@ describe('package1:version:create:get', () => {
     expect(result.Status).to.equal('IN_PROGRESS');
     expect(uxStub.callCount).to.equal(1);
     // PackageUploadRequest is still InProgress. You can query the status using
-    // sfdx package1:version:create:get -i 0HD4p000000blUvGXX -o admin_9aabdcd7250f980c5a96bf96fb9a9711@gb.org
+    // sf package1:version:create:get -i 0HD4p000000blUvGXX -o admin_9aabdcd7250f980c5a96bf96fb9a9711@gb.org
     expect(uxStub.args[0][0]).to.match(
-      /PackageUploadRequest is still InProgress\. You can query the status using\s+sfdx package1:version:create:get -i 0HD4p000000blUvGXX -o admin_.*@.*\.org/
+      /PackageUploadRequest is still InProgress\. You can query the status using\s+sf package1:version:create:get -i 0HD4p000000blUvGXX -o admin_.*@.*\.org/
     );
   });
 
@@ -99,9 +99,9 @@ describe('package1:version:create:get', () => {
     expect(result.Status).to.equal('QUEUED');
     expect(uxStub.callCount).to.equal(1);
     // "PackageUploadRequest has been enqueued. You can query the status using
-    // sfdx package1:version:create:get -i 0HD4p000000blUvGXX -o admin_59d2d480323a011b8887b00138d2e9bb@gb.org"
+    // sf package1:version:create:get -i 0HD4p000000blUvGXX -o admin_59d2d480323a011b8887b00138d2e9bb@gb.org"
     expect(uxStub.args[0][0]).to.match(
-      /PackageUploadRequest has been enqueued\. You can query the status using\s+sfdx package1:version:create:get -i 0HD4p000000blUvGXX -o admin_.*@.*\.org/
+      /PackageUploadRequest has been enqueued\. You can query the status using\s+sf package1:version:create:get -i 0HD4p000000blUvGXX -o admin_.*@.*\.org/
     );
   });