@salesforce/sf-plugins-core 1.19.3 → 1.21.0

package/lib/compatibility.d.ts

@@ -1,3 +1,4 @@
+import { OptionFlagProps } from '@oclif/core/lib/interfaces';
 /**
  * Adds an alias for the deprecated sfdx-style "apiversion" and provides a warning if it is used
  * See orgApiVersionFlag for full details
@@ -36,4 +37,8 @@ export declare const requiredOrgFlagWithDeprecations: import("@oclif/core/lib/in
  * @deprecated
  */
 export declare const requiredHubFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org | undefined>;
+/**
+ * @deprecated
+ */
+export declare const arrayWithDeprecation: (options: Partial<Omit<OptionFlagProps, 'multiple' | 'parse'>>) => import("@oclif/core/lib/interfaces").OptionFlag<string[] | undefined>;
 //# sourceMappingURL=compatibility.d.ts.map

package/lib/compatibility.js

@@ -6,7 +6,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.requiredHubFlagWithDeprecations = exports.requiredOrgFlagWithDeprecations = exports.optionalOrgFlagWithDeprecations = exports.loglevel = exports.orgApiVersionFlagWithDeprecations = void 0;
+exports.arrayWithDeprecation = exports.requiredHubFlagWithDeprecations = exports.requiredOrgFlagWithDeprecations = exports.optionalOrgFlagWithDeprecations = exports.loglevel = exports.orgApiVersionFlagWithDeprecations = void 0;
 const core_1 = require("@oclif/core");
 const core_2 = require("@salesforce/core");
 const orgApiVersion_1 = require("./flags/orgApiVersion");
@@ -70,4 +70,21 @@ exports.requiredHubFlagWithDeprecations = (0, orgFlags_1.requiredHubFlag)({
     aliases: ['targetdevhubusername'],
     deprecateAliases: true,
 });
+/**
+ * @deprecated
+ */
+const arrayWithDeprecation = (options) => core_1.Flags.string({
+    // populate passed options
+    ...options,
+    // overlay those options we own
+    multiple: true,
+    parse: async (input) => {
+        const inputParts = input.split(',').map((i) => i.trim());
+        if (inputParts.length > 1) {
+            await core_2.Lifecycle.getInstance().emitWarning(messages.getMessage('warning.arrayInputFormat'));
+        }
+        return inputParts;
+    },
+});
+exports.arrayWithDeprecation = arrayWithDeprecation;
 //# sourceMappingURL=compatibility.js.map

package/lib/ux/prompter.d.ts

@@ -14,9 +14,10 @@ export declare class Prompter {
      *
      * @param message text to display.  Do not include a question mark.
      * @param ms milliseconds to wait for user input.  Defaults to 10s.
+     * @param defaultAnswer default answer for the prompt.  Defaults to true.  Pass in `false` to require a positive response.
      * @return true if the user confirms, false if they do not.
      */
-    confirm(message: string, ms?: number): Promise<boolean>;
+    confirm(message: string, ms?: number, defaultAnswer?: boolean): Promise<boolean>;
 }
 export declare namespace Prompter {
     type Answers<T = Record<string, unknown>> = T & Record<string, unknown>;

package/lib/ux/prompter.js

@@ -46,14 +46,16 @@ class Prompter {
      *
      * @param message text to display.  Do not include a question mark.
      * @param ms milliseconds to wait for user input.  Defaults to 10s.
+     * @param defaultAnswer default answer for the prompt.  Defaults to true.  Pass in `false` to require a positive response.
      * @return true if the user confirms, false if they do not.
      */
-    async confirm(message, ms = 10000) {
+    async confirm(message, ms = 10000, defaultAnswer = true) {
         const { confirmed } = await this.timedPrompt([
             {
                 name: 'confirmed',
                 message,
                 type: 'confirm',
+                default: defaultAnswer,
             },
         ], ms);
         return confirmed;

package/messages/messages.md

@@ -94,3 +94,7 @@ Set varargs with this format: key=value or key="value with spaces".
 # error.DuplicateArgument
 
 Found duplicate argument %s.
+
+# warning.arrayInputFormat
+
+The input format for array arguments has changed. Use this format: --array-flag value1 --array-flag value2 --array-flag value3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "1.19.3",
+  "version": "1.21.0",
   "description": "Utils for writing deploy and retrieve plugins",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -32,7 +32,7 @@
     "/messages"
   ],
   "dependencies": {
-    "@oclif/core": "^1.20.4",
+    "@oclif/core": "^1.21.0",
     "@salesforce/core": "^3.32.6",
     "@salesforce/kit": "^1.7.1",
     "@salesforce/ts-types": "^1.7.1",