@salesforce/sf-plugins-core 1.10.0 → 1.11.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 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

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "1.10.0",
+  "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",