@salesforce/sf-plugins-core 1.17.7 → 1.18.1

package/lib/compatibility.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Adds an alias for the deprecated sfdx-style "apiversion" and provides a warning if it is used
+ * See orgApiVersionFlag for full details
+ *
+ * @deprecated
+ * @example
+ * ```
+ * import { Flags } from '@salesforce/sf-plugins-core';
+ * public static flags = {
+ *    'api-version': Flags.orgApiVersion({
+ *       char: 'a',
+ *       description: 'api version for the org'
+ *    }),
+ * }
+ * ```
+ */
+export declare const orgApiVersionFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+/**
+ * Use only for commands that maintain sfdx compatibility.
+ * Flag will be hidden and will show a warning if used.
+ * Flag does *not* set the loglevel
+ *
+ * @deprecated
+ *
+ */
+export declare const loglevel: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+/**
+ * @deprecated
+ */
+export declare const optionalOrgFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org | undefined>;
+/**
+ * @deprecated
+ */
+export declare const requiredOrgFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org | undefined>;
+/**
+ * @deprecated
+ */
+export declare const requiredHubFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org | undefined>;
+//# sourceMappingURL=compatibility.d.ts.map

package/lib/compatibility.js

@@ -0,0 +1,73 @@
+"use strict";
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * 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;
+const core_1 = require("@oclif/core");
+const core_2 = require("@salesforce/core");
+const orgApiVersion_1 = require("./flags/orgApiVersion");
+const orgFlags_1 = require("./flags/orgFlags");
+/**
+ * Adds an alias for the deprecated sfdx-style "apiversion" and provides a warning if it is used
+ * See orgApiVersionFlag for full details
+ *
+ * @deprecated
+ * @example
+ * ```
+ * import { Flags } from '@salesforce/sf-plugins-core';
+ * public static flags = {
+ *    'api-version': Flags.orgApiVersion({
+ *       char: 'a',
+ *       description: 'api version for the org'
+ *    }),
+ * }
+ * ```
+ */
+exports.orgApiVersionFlagWithDeprecations = (0, orgApiVersion_1.orgApiVersionFlag)({
+    aliases: ['apiversion'],
+    deprecateAliases: true,
+});
+core_2.Messages.importMessagesDirectory(__dirname);
+const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'messages');
+/**
+ * Use only for commands that maintain sfdx compatibility.
+ * Flag will be hidden and will show a warning if used.
+ * Flag does *not* set the loglevel
+ *
+ * @deprecated
+ *
+ */
+exports.loglevel = core_1.Flags.string({
+    hidden: true,
+    deprecated: {
+        message: messages.getMessage('warning.loglevel'),
+    },
+});
+const deprecatedOrgAliases = {
+    aliases: ['targetusername', 'u'],
+    deprecateAliases: true,
+};
+/**
+ * @deprecated
+ */
+exports.optionalOrgFlagWithDeprecations = (0, orgFlags_1.optionalOrgFlag)({
+    ...deprecatedOrgAliases,
+});
+/**
+ * @deprecated
+ */
+exports.requiredOrgFlagWithDeprecations = (0, orgFlags_1.requiredOrgFlag)({
+    ...deprecatedOrgAliases,
+});
+/**
+ * @deprecated
+ */
+exports.requiredHubFlagWithDeprecations = (0, orgFlags_1.requiredHubFlag)({
+    aliases: ['targetdevhubusername'],
+    deprecateAliases: true,
+});
+//# sourceMappingURL=compatibility.js.map

package/lib/exported.d.ts

@@ -7,6 +7,7 @@ export { Progress, Prompter, generateTableChoices, Ux } from './ux';
 export { SfHook } from './hooks';
 export * from './types';
 export { SfCommand, SfCommandInterface, StandardColors } from './sfCommand';
+export * from './compatibility';
 export declare const Flags: {
     boolean: typeof OclifFlags.boolean;
     directory: import("@oclif/core/lib/interfaces").Definition<string, {

package/lib/exported.js

@@ -41,6 +41,7 @@ __exportStar(require("./types"), exports);
 var sfCommand_1 = require("./sfCommand");
 Object.defineProperty(exports, "SfCommand", { enumerable: true, get: function () { return sfCommand_1.SfCommand; } });
 Object.defineProperty(exports, "StandardColors", { enumerable: true, get: function () { return sfCommand_1.StandardColors; } });
+__exportStar(require("./compatibility"), exports);
 // custom flags
 const orgFlags_1 = require("./flags/orgFlags");
 const salesforceId_1 = require("./flags/salesforceId");

package/lib/flags/orgFlags.js

@@ -67,7 +67,7 @@ const getHubOrThrow = async (aliasOrUsername) => {
  * ```
  */
 exports.optionalOrgFlag = core_1.Flags.custom({
-    char: 'e',
+    char: 'o',
     parse: async (input) => maybeGetOrg(input),
     default: async () => maybeGetOrg(),
     defaultHelp: async () => (await maybeGetOrg())?.getUsername(),
@@ -95,7 +95,8 @@ exports.optionalOrgFlag = core_1.Flags.custom({
  * ```
  */
 exports.requiredOrgFlag = core_1.Flags.custom({
-    char: 'e',
+    char: 'o',
+    summary: messages.getMessage('flags.targetOrg.summary'),
     parse: async (input) => getOrgOrThrow(input),
     default: async () => getOrgOrThrow(),
     defaultHelp: async () => (await getOrgOrThrow())?.getUsername(),
@@ -124,6 +125,7 @@ exports.requiredOrgFlag = core_1.Flags.custom({
  */
 exports.requiredHubFlag = core_1.Flags.custom({
     char: 'v',
+    summary: messages.getMessage('flags.targetDevHubOrg.summary'),
     parse: async (input) => getHubOrThrow(input),
     default: async () => getHubOrThrow(),
     defaultHelp: async () => (await getHubOrThrow())?.getUsername(),

package/messages/messages.md

@@ -34,6 +34,14 @@ No default dev hub found. Use -v or --target-dev-hub to specify an environment.
 
 The specified org %s is not a Dev Hub.
 
+# flags.targetOrg.summary
+
+Username or alias of the target org.
+
+# flags.targetDevHubOrg.summary
+
+Username or alias of the Dev Hub org.
+
 # flags.apiVersion.description
 
 Override the api version used for api requests made by this command
@@ -66,6 +74,10 @@ The value must be between %s and %s (inclusive).
 
 Warning:
 
+# warning.loglevel
+
+The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.
+
 # actions.tryThis
 
 Try this:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "1.17.7",
+  "version": "1.18.1",
   "description": "Utils for writing deploy and retrieve plugins",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -33,7 +33,7 @@
   ],
   "dependencies": {
     "@oclif/core": "^1.20.4",
-    "@salesforce/core": "^3.31.19",
+    "@salesforce/core": "^3.32.1",
     "@salesforce/kit": "^1.7.1",
     "@salesforce/ts-types": "^1.7.1",
     "chalk": "^4",
@@ -46,7 +46,7 @@
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "^1.4.2",
     "@types/inquirer": "^8.2.3",
-    "@typescript-eslint/eslint-plugin": "^5.40.0",
+    "@typescript-eslint/eslint-plugin": "^5.42.1",
     "@typescript-eslint/parser": "^5.42.0",
     "chai": "^4.3.6",
     "eslint": "^8.26.0",