@salesforce/sf-plugins-core 1.8.1 → 1.11.0

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.11.0](https://github.com/salesforcecli/sf-plugins-core/compare/v1.10.0...v1.11.0) (2022-03-31)
+
+### Features
+
+- support error codes help section ([4852a4f](https://github.com/salesforcecli/sf-plugins-core/commit/4852a4f75bcc744febf276293ed5bf45080436e6))
+
+## [1.10.0](https://github.com/salesforcecli/sf-plugins-core/compare/v1.9.0...v1.10.0) (2022-03-31)
+
+### Features
+
+- warn users when using a beta command ([2cf26f2](https://github.com/salesforcecli/sf-plugins-core/commit/2cf26f2d363a40b0739f082bfe4aedd62fd4531f))
+
+## [1.9.0](https://github.com/salesforcecli/sf-plugins-core/compare/v1.8.1...v1.9.0) (2022-03-24)
+
+### Features
+
+- explain what a valid api version looks like ([4c5669a](https://github.com/salesforcecli/sf-plugins-core/commit/4c5669a969ef79eae1d4aec76f6cb20df92aae5e))
+
 ### [1.8.1](https://github.com/salesforcecli/sf-plugins-core/compare/v1.8.0...v1.8.1) (2022-03-24)
 
 ### Bug Fixes

package/lib/sfCommand.js

@@ -140,6 +140,9 @@ class SfCommand extends core_1.Command {
         if (this.statics.requiresProject) {
             this.project = await this.assignProject();
         }
+        if (this.statics.state === 'beta') {
+            this.warn(messages.getMessage('warning.CommandInBeta'));
+        }
         this.lifecycle.onWarning(async (warning) => {
             this.warn(warning);
         });

package/lib/util.d.ts

@@ -15,5 +15,5 @@ export declare type HelpSection = {
  * @param header
  * @param vars
  */
-export declare function toHelpSection(header: string, ...vars: Array<OrgConfigProperties | SfdxPropertyKeys | EnvironmentVariable | string>): HelpSection;
+export declare function toHelpSection(header: string, ...vars: Array<OrgConfigProperties | SfdxPropertyKeys | EnvironmentVariable | string | Record<string, string>>): HelpSection;
 //# sourceMappingURL=util.d.ts.map

package/lib/util.js

@@ -19,23 +19,28 @@ const core_1 = require("@salesforce/core");
  */
 function toHelpSection(header, ...vars) {
     const body = vars
-        .map((v) => {
-        const orgConfig = core_1.ORG_CONFIG_ALLOWED_PROPERTIES.find(({ key }) => {
-            return key === v;
-        });
-        if (orgConfig) {
-            return { name: orgConfig.key, description: orgConfig.description };
+        .flatMap((v) => {
+        if (typeof v === 'string') {
+            const orgConfig = core_1.ORG_CONFIG_ALLOWED_PROPERTIES.find(({ key }) => {
+                return key === v;
+            });
+            if (orgConfig) {
+                return { name: orgConfig.key, description: orgConfig.description };
+            }
+            const sfdxProperty = core_1.SFDX_ALLOWED_PROPERTIES.find(({ key }) => key === v);
+            if (sfdxProperty) {
+                return { name: sfdxProperty.key.valueOf(), description: sfdxProperty.description };
+            }
+            const envVar = Object.entries(core_1.SUPPORTED_ENV_VARS).find(([k]) => k === v);
+            if (envVar) {
+                const [eKey, data] = envVar;
+                return { name: eKey, description: data.description };
+            }
+            return undefined;
         }
-        const sfdxProperty = core_1.SFDX_ALLOWED_PROPERTIES.find(({ key }) => key === v);
-        if (sfdxProperty) {
-            return { name: sfdxProperty.key.valueOf(), description: sfdxProperty.description };
+        else {
+            return Object.entries(v).map(([name, description]) => ({ name, description }));
         }
-        const envVar = Object.entries(core_1.SUPPORTED_ENV_VARS).find(([k]) => k === v);
-        if (envVar) {
-            const [eKey, data] = envVar;
-            return { name: eKey, description: data.description };
-        }
-        return undefined;
     })
         .filter((b) => b);
     return { header, body };

package/messages/messages.md

@@ -48,7 +48,7 @@ API versions up to %s are deprecated. See %s for more information.
 
 # errors.InvalidApiVersion
 
-%s is not a valid API version.
+%s is not a valid API version. It should end in '.0' like '54.0'.
 
 # errors.RetiredApiVersion
 
@@ -73,3 +73,7 @@ Info:
 # actions.tryThis
 
 Try this:
+
+# warning.CommandInBeta
+
+This command is currently in beta. Any aspect of this command can change without advanced notice. Don't use beta commands in your scripts.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "1.8.1",
+  "version": "1.11.0",
   "description": "Utils for writing deploy and retrieve plugins",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -32,8 +32,8 @@
     "/messages"
   ],
   "dependencies": {
-    "@oclif/core": "^1.6.0",
-    "@salesforce/core": "^3.7.9",
+    "@oclif/core": "^1.6.3",
+    "@salesforce/core": "^3.11.0",
     "@salesforce/kit": "^1.5.34",
     "@salesforce/ts-types": "^1.5.20",
     "chalk": "^2.4.2",