@salesforce/plugin-settings 1.3.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/config.d.ts CHANGED
@@ -8,14 +8,22 @@ export type Msg = {
8
8
  path?: string;
9
9
  message?: string;
10
10
  error?: Error;
11
+ successes?: Array<{
12
+ message?: string;
13
+ name: string;
14
+ }>;
15
+ failures?: Array<{
16
+ message?: string;
17
+ name: string;
18
+ }>;
19
+ key?: string;
20
+ deprecated?: boolean;
11
21
  };
12
22
  export type ConfigResponses = Msg[];
13
- export declare const CONFIG_HELP_SECTION: {
14
- header: string;
15
- body: string | [string, string][] | import("@oclif/core").HelpSectionKeyValueTable;
16
- };
23
+ export declare const CONFIG_HELP_SECTION: import("@oclif/core").HelpSection;
17
24
  export declare abstract class ConfigCommand<T> extends SfCommand<T> {
18
25
  protected responses: ConfigResponses;
26
+ calculateSuggestion(userEnteredConfig: string): string;
19
27
  protected pushSuccess(configInfo: ConfigInfo): void;
20
28
  protected pushFailure(name: string, err: string | Error, value?: string): void;
21
29
  protected output(title: string, verbose: boolean): void;
package/lib/config.js CHANGED
@@ -10,15 +10,28 @@ exports.ConfigCommand = exports.CONFIG_HELP_SECTION = void 0;
10
10
  const sf_plugins_core_1 = require("@salesforce/sf-plugins-core");
11
11
  const core_1 = require("@salesforce/core");
12
12
  const sf_plugins_core_2 = require("@salesforce/sf-plugins-core");
13
- exports.CONFIG_HELP_SECTION = (0, sf_plugins_core_2.toHelpSection)('CONFIGURATION VARIABLES', core_1.SfdxPropertyKeys.API_VERSION, core_1.SfdxPropertyKeys.DISABLE_TELEMETRY, core_1.SfdxPropertyKeys.INSTANCE_URL, core_1.SfdxPropertyKeys.MAX_QUERY_LIMIT, core_1.SfdxPropertyKeys.REST_DEPLOY, core_1.OrgConfigProperties.TARGET_ORG, core_1.OrgConfigProperties.TARGET_DEV_HUB);
13
+ const Levenshtein = require("fast-levenshtein");
14
+ exports.CONFIG_HELP_SECTION = (0, sf_plugins_core_2.toHelpSection)('CONFIGURATION VARIABLES', ...new Set(core_1.Config.getAllowedProperties().map((k) => k.newKey ?? k.key)));
14
15
  class ConfigCommand extends sf_plugins_core_1.SfCommand {
15
16
  constructor() {
16
17
  super(...arguments);
17
18
  this.responses = [];
18
19
  }
20
+ // eslint-disable-next-line class-methods-use-this
21
+ calculateSuggestion(userEnteredConfig) {
22
+ // we'll use this array to keep track of which key is the closest to the users entered value.
23
+ // keys closer to the index 0 will be a closer guess than keys indexed further from 0
24
+ // an entry at 0 would be a direct match, an entry at 1 would be a single character off, etc.
25
+ const index = [];
26
+ core_1.Config.getAllowedProperties()
27
+ .map((k) => k.newKey ?? k.key)
28
+ .map((k) => (index[Levenshtein.get(userEnteredConfig, k)] = k));
29
+ return index.find((item) => item !== undefined) ?? '';
30
+ }
19
31
  pushSuccess(configInfo) {
20
32
  this.responses.push({
21
33
  name: configInfo.key,
34
+ key: configInfo.key,
22
35
  value: configInfo.value,
23
36
  success: true,
24
37
  location: configInfo.location,
package/lib/config.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,iEAAwD;AAExD,2CAA8F;AAC9F,iEAA4D;AAc/C,QAAA,mBAAmB,GAAG,IAAA,+BAAa,EAC9C,yBAAyB,EACzB,uBAAgB,CAAC,WAAW,EAC5B,uBAAgB,CAAC,iBAAiB,EAClC,uBAAgB,CAAC,YAAY,EAC7B,uBAAgB,CAAC,eAAe,EAChC,uBAAgB,CAAC,WAAW,EAC5B,0BAAmB,CAAC,UAAU,EAC9B,0BAAmB,CAAC,cAAc,CACnC,CAAC;AAEF,MAAsB,aAAiB,SAAQ,2BAAY;IAA3D;;QACY,cAAS,GAAoB,EAAE,CAAC;IA6D5C,CAAC;IA3DW,WAAW,CAAC,UAAsB;QAC1C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAClB,IAAI,EAAE,UAAU,CAAC,GAAG;YACpB,KAAK,EAAE,UAAU,CAAC,KAA2B;YAC7C,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,UAAU,CAAC,QAAQ;SAC9B,CAAC,CAAC;IACL,CAAC;IAES,WAAW,CAAC,IAAY,EAAE,GAAmB,EAAE,KAAc;QACrE,MAAM,KAAK,GAAG,cAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAClB,IAAI;YACJ,OAAO,EAAE,KAAK;YACd,KAAK;YACL,KAAK;YACL,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SAC7C,CAAC,CAAC;QACH,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC;IAES,MAAM,CAAC,KAAa,EAAE,OAAgB;QAC9C,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;YAC/B,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;YAC7B,OAAO;SACR;QAED,MAAM,OAAO,GAAgC;YAC3C,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;SACzB,CAAC;QAEF,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC5B,OAAO,CAAC,KAAK,GAAG;gBACd,MAAM,EAAE,OAAO;gBACf,GAAG,EAAE,CAAC,GAAG,EAAU,EAAE,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;aACtC,CAAC;SACH;QAED,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YAC3B,OAAO,CAAC,OAAO,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;SACzC;QAED,IAAI,OAAO,EAAE;YACX,OAAO,CAAC,QAAQ,GAAG;gBACjB,MAAM,EAAE,UAAU;gBAClB,GAAG,EAAE,CAAC,GAAG,EAAU,EAAE,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE;aACzC,CAAC;SACH;QAED,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;YAC3C,OAAO,CAAC,OAAO,GAAG;gBAChB,MAAM,EAAE,SAAS;gBACjB,GAAG,EAAE,CAAC,GAAG,EAAU,EAAE,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE;aACxC,CAAC;YACF,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;SACjE;QAED,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IACjD,CAAC;CACF;AA9DD,sCA8DC"}
1
+ {"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,iEAAwD;AAExD,2CAA+D;AAC/D,iEAA4D;AAC5D,gDAAgD;AAmBnC,QAAA,mBAAmB,GAAG,IAAA,+BAAa,EAC9C,yBAAyB,EACzB,GAAG,IAAI,GAAG,CAAC,aAAM,CAAC,oBAAoB,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CACxE,CAAC;AAEF,MAAsB,aAAiB,SAAQ,2BAAY;IAA3D;;QACY,cAAS,GAAoB,EAAE,CAAC;IAwE5C,CAAC;IAvEC,kDAAkD;IAC3C,mBAAmB,CAAC,iBAAyB;QAClD,6FAA6F;QAC7F,qFAAqF;QACrF,6FAA6F;QAC7F,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,aAAM,CAAC,oBAAoB,EAAE;aAC1B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC;aAC7B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAClE,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;IACxD,CAAC;IACS,WAAW,CAAC,UAAsB;QAC1C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAClB,IAAI,EAAE,UAAU,CAAC,GAAG;YACpB,GAAG,EAAE,UAAU,CAAC,GAAG;YACnB,KAAK,EAAE,UAAU,CAAC,KAA2B;YAC7C,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,UAAU,CAAC,QAAQ;SAC9B,CAAC,CAAC;IACL,CAAC;IAES,WAAW,CAAC,IAAY,EAAE,GAAmB,EAAE,KAAc;QACrE,MAAM,KAAK,GAAG,cAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAClB,IAAI;YACJ,OAAO,EAAE,KAAK;YACd,KAAK;YACL,KAAK;YACL,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SAC7C,CAAC,CAAC;QACH,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC;IAES,MAAM,CAAC,KAAa,EAAE,OAAgB;QAC9C,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;YAC/B,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;YAC7B,OAAO;SACR;QAED,MAAM,OAAO,GAAgC;YAC3C,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;SACzB,CAAC;QAEF,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC5B,OAAO,CAAC,KAAK,GAAG;gBACd,MAAM,EAAE,OAAO;gBACf,GAAG,EAAE,CAAC,GAAG,EAAU,EAAE,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;aACtC,CAAC;SACH;QAED,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YAC3B,OAAO,CAAC,OAAO,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;SACzC;QAED,IAAI,OAAO,EAAE;YACX,OAAO,CAAC,QAAQ,GAAG;gBACjB,MAAM,EAAE,UAAU;gBAClB,GAAG,EAAE,CAAC,GAAG,EAAU,EAAE,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE;aACzC,CAAC;SACH;QAED,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;YAC3C,OAAO,CAAC,OAAO,GAAG;gBAChB,MAAM,EAAE,SAAS;gBACjB,GAAG,EAAE,CAAC,GAAG,EAAU,EAAE,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE;aACxC,CAAC;YACF,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;SACjE;QAED,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IACjD,CAAC;CACF;AAzED,sCAyEC"}
@@ -53,7 +53,7 @@ const hook = ({ config }) => {
53
53
  if (flattenedConfigMetas.length) {
54
54
  core_2.Config.addAllowedProperties(flattenedConfigMetas);
55
55
  }
56
- return;
56
+ return Promise.resolve();
57
57
  };
58
58
  exports.default = hook;
59
59
  //# sourceMappingURL=load_config_meta.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"load_config_meta.js","sourceRoot":"","sources":["../../../src/hooks/init/load_config_meta.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAGH,sCAAqC;AACrC,2CAAsE;AACtE,mDAAqD;AAErD,MAAM,GAAG,GAAG,aAAM,CAAC,aAAa,CAAC,kCAAkC,CAAC,CAAC;AACrE,MAAM,oBAAoB,GAAG,YAAY,CAAC;AAE1C,SAAS,cAAc,CAAC,MAAyB;IAC/C,IAAI,yBAA6C,CAAC;IAElD,IAAI;QACF,MAAM,cAAc,GAAG,IAAA,cAAG,EAAC,MAAM,EAAE,eAAe,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QAEhF,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE;YACtC,OAAO;SACR;QAED,MAAM,YAAY,GAAG,IAAA,aAAM,EAAC,MAAM,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAEzD,uDAAuD;QACvD,yBAAyB,GAAG,YAAY,IAAI,cAAc,CAAC;KAC5D;IAAC,MAAM;QACN,OAAO;KACR;IAED,IAAI,CAAC,yBAAyB,EAAE;QAC9B,OAAO;KACR;IAED,IAAI;QACF,uGAAuG;QACvG,MAAM,oBAAoB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;QAEhE,2GAA2G;QAC3G,OAAO,oBAAoB,EAAE,OAAO,IAAI,oBAAoB,CAAC;KAC9D;IAAC,MAAM;QACN,GAAG,CAAC,KAAK,CAAC,yCAAyC,yBAAyB,EAAE,CAAC,CAAC;QAChF,OAAO;KACR;AACH,CAAC;AAED,MAAM,IAAI,GAAiB,CAAC,EAAE,MAAM,EAAE,EAAiB,EAAE;IACvD,MAAM,oBAAoB,GAAG,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;SAChD,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QACd,MAAM,UAAU,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,CAAC,UAAU,EAAE;YACf,GAAG,CAAC,IAAI,CAAC,4BAA4B,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;SACrD;QAED,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;SACD,MAAM,CAAC,mBAAQ,CAAC;SAChB,IAAI,EAAE,CAAC;IAEV,IAAI,oBAAoB,CAAC,MAAM,EAAE;QAC/B,aAAM,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;KACnD;IACD,OAAO;AACT,CAAC,CAAC;AAEF,kBAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"load_config_meta.js","sourceRoot":"","sources":["../../../src/hooks/init/load_config_meta.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAGH,sCAAqC;AACrC,2CAAsE;AACtE,mDAAqD;AAErD,MAAM,GAAG,GAAG,aAAM,CAAC,aAAa,CAAC,kCAAkC,CAAC,CAAC;AACrE,MAAM,oBAAoB,GAAG,YAAY,CAAC;AAE1C,SAAS,cAAc,CAAC,MAAyB;IAC/C,IAAI,yBAA6C,CAAC;IAElD,IAAI;QACF,MAAM,cAAc,GAAG,IAAA,cAAG,EAAC,MAAM,EAAE,eAAe,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QAEhF,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE;YACtC,OAAO;SACR;QAED,MAAM,YAAY,GAAG,IAAA,aAAM,EAAC,MAAM,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAEzD,uDAAuD;QACvD,yBAAyB,GAAG,YAAY,IAAI,cAAc,CAAC;KAC5D;IAAC,MAAM;QACN,OAAO;KACR;IAED,IAAI,CAAC,yBAAyB,EAAE;QAC9B,OAAO;KACR;IAED,IAAI;QACF,uGAAuG;QACvG,MAAM,oBAAoB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;QAEhE,2GAA2G;QAC3G,OAAO,oBAAoB,EAAE,OAAO,IAAI,oBAAoB,CAAC;KAC9D;IAAC,MAAM;QACN,GAAG,CAAC,KAAK,CAAC,yCAAyC,yBAAyB,EAAE,CAAC,CAAC;QAChF,OAAO;KACR;AACH,CAAC;AAED,MAAM,IAAI,GAAiB,CAAC,EAAE,MAAM,EAAE,EAAiB,EAAE;IACvD,MAAM,oBAAoB,GAAG,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;SAChD,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QACd,MAAM,UAAU,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,CAAC,UAAU,EAAE;YACf,GAAG,CAAC,IAAI,CAAC,4BAA4B,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;SACrD;QAED,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;SACD,MAAM,CAAC,mBAAQ,CAAC;SAChB,IAAI,EAAE,CAAC;IAEV,IAAI,oBAAoB,CAAC,MAAM,EAAE;QAC/B,aAAM,CAAC,oBAAoB,CAAC,oBAA4C,CAAC,CAAC;KAC3E;IACD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;AAC3B,CAAC,CAAC;AAEF,kBAAe,IAAI,CAAC"}
@@ -23,3 +23,7 @@ Display whether the configuration variables are set locally or globally.
23
23
  # error.NoConfigKeysFound
24
24
 
25
25
  You must provide one or more configuration variables to get. Run "sf config list" to see the configuration variables you've previously set.
26
+
27
+ # didYouMean
28
+
29
+ Did you mean %s?
@@ -45,3 +45,7 @@ You must provide one or more configuration variables to set. Use the --help flag
45
45
  # error.ValueRequired
46
46
 
47
47
  You must provide a value when setting a config. Use `sf config unset the-config-name` to unset existing configs.
48
+
49
+ # didYouMean
50
+
51
+ Did you mean %s?
@@ -23,3 +23,7 @@ Unset the configuration variables globally, so they can no longer be used from a
23
23
  # error.NoConfigKeysFound
24
24
 
25
25
  You must provide one or more configuration variables to unset. Run "sf config list" to see the configuration variables you've previously set.
26
+
27
+ # didYouMean
28
+
29
+ Did you mean %s?
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.3.0",
2
+ "version": "1.4.0",
3
3
  "commands": {
4
4
  "alias:list": {
5
5
  "id": "alias:list",
@@ -9,18 +9,31 @@
9
9
  "pluginName": "@salesforce/plugin-settings",
10
10
  "pluginAlias": "@salesforce/plugin-settings",
11
11
  "pluginType": "core",
12
- "state": "beta",
13
- "aliases": [],
12
+ "aliases": [
13
+ "force:alias:list"
14
+ ],
14
15
  "examples": [
15
16
  "List all the aliases you've set:\n<%= config.bin %> <%= command.id %>"
16
17
  ],
18
+ "deprecateAliases": true,
17
19
  "flags": {
18
20
  "json": {
19
21
  "name": "json",
20
22
  "type": "boolean",
21
23
  "description": "Format output as json.",
22
24
  "helpGroup": "GLOBAL",
23
- "allowNo": false
25
+ "allowNo": false,
26
+ "deprecateAliases": true
27
+ },
28
+ "loglevel": {
29
+ "name": "loglevel",
30
+ "type": "option",
31
+ "hidden": true,
32
+ "multiple": false,
33
+ "deprecated": {
34
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
35
+ },
36
+ "deprecateAliases": true
24
37
  }
25
38
  },
26
39
  "args": {}
@@ -33,21 +46,34 @@
33
46
  "pluginName": "@salesforce/plugin-settings",
34
47
  "pluginAlias": "@salesforce/plugin-settings",
35
48
  "pluginType": "core",
36
- "state": "beta",
37
- "aliases": [],
49
+ "aliases": [
50
+ "force:alias:set"
51
+ ],
38
52
  "examples": [
39
53
  "Set an alias for a scratch org username:\n<%= config.bin %> <%= command.id %> my-scratch-org=test-sadbiytjsupn@example.com",
40
54
  "Set multiple aliases with a single command:\n<%= config.bin %> <%= command.id %> my-scratch-org=test-sadbiytjsupn@example.com my-other-scratch-org=test-ss0xut7txzxf@example.com",
41
55
  "Set an alias that contains spaces:\n<%= config.bin %> <%= command.id %> my-alias='alias with spaces'",
42
56
  "Set a single alias without using an equal sign:\n<%= config.bin %> <%= command.id %> my-scratch-org test-ss0xut7txzxf@example.com"
43
57
  ],
58
+ "deprecateAliases": true,
44
59
  "flags": {
45
60
  "json": {
46
61
  "name": "json",
47
62
  "type": "boolean",
48
63
  "description": "Format output as json.",
49
64
  "helpGroup": "GLOBAL",
50
- "allowNo": false
65
+ "allowNo": false,
66
+ "deprecateAliases": true
67
+ },
68
+ "loglevel": {
69
+ "name": "loglevel",
70
+ "type": "option",
71
+ "hidden": true,
72
+ "multiple": false,
73
+ "deprecated": {
74
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
75
+ },
76
+ "deprecateAliases": true
51
77
  }
52
78
  },
53
79
  "args": {}
@@ -60,34 +86,49 @@
60
86
  "pluginName": "@salesforce/plugin-settings",
61
87
  "pluginAlias": "@salesforce/plugin-settings",
62
88
  "pluginType": "core",
63
- "state": "beta",
64
- "aliases": [],
89
+ "aliases": [
90
+ "force:alias:unset"
91
+ ],
65
92
  "examples": [
66
93
  "Unset an alias:\n<%= config.bin %> <%= command.id %> my-alias",
67
94
  "Unset multiple aliases with a single command:\n<%= config.bin %> <%= command.id %> my-alias my-other-alias",
68
95
  "Unset all aliases:\n<%= config.bin %> <%= command.id %> --all [--no-prompt]"
69
96
  ],
97
+ "deprecateAliases": true,
70
98
  "flags": {
71
99
  "json": {
72
100
  "name": "json",
73
101
  "type": "boolean",
74
102
  "description": "Format output as json.",
75
103
  "helpGroup": "GLOBAL",
76
- "allowNo": false
104
+ "allowNo": false,
105
+ "deprecateAliases": true
106
+ },
107
+ "loglevel": {
108
+ "name": "loglevel",
109
+ "type": "option",
110
+ "hidden": true,
111
+ "multiple": false,
112
+ "deprecated": {
113
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
114
+ },
115
+ "deprecateAliases": true
77
116
  },
78
117
  "all": {
79
118
  "name": "all",
80
119
  "type": "boolean",
81
120
  "char": "a",
82
121
  "summary": "Unset all currently set aliases.",
83
- "allowNo": false
122
+ "allowNo": false,
123
+ "deprecateAliases": true
84
124
  },
85
125
  "no-prompt": {
86
126
  "name": "no-prompt",
87
127
  "type": "boolean",
88
128
  "char": "p",
89
129
  "summary": "Don't prompt the user for confirmation when unsetting all aliases.",
90
- "allowNo": false
130
+ "allowNo": false,
131
+ "deprecateAliases": true
91
132
  }
92
133
  },
93
134
  "args": {}
@@ -100,24 +141,39 @@
100
141
  "pluginName": "@salesforce/plugin-settings",
101
142
  "pluginAlias": "@salesforce/plugin-settings",
102
143
  "pluginType": "core",
103
- "aliases": [],
144
+ "aliases": [
145
+ "force:config:get"
146
+ ],
104
147
  "examples": [
105
148
  "Get the value of the \"target-org\" configuration variable.\n<%= config.bin %> <%= command.id %> target-org",
106
149
  "Get multiple configuration variables and display whether they're set locally or globally:\n<%= config.bin %> <%= command.id %> target-org api-version --verbose"
107
150
  ],
151
+ "deprecateAliases": true,
108
152
  "flags": {
109
153
  "json": {
110
154
  "name": "json",
111
155
  "type": "boolean",
112
156
  "description": "Format output as json.",
113
157
  "helpGroup": "GLOBAL",
114
- "allowNo": false
158
+ "allowNo": false,
159
+ "deprecateAliases": true
160
+ },
161
+ "loglevel": {
162
+ "name": "loglevel",
163
+ "type": "option",
164
+ "hidden": true,
165
+ "multiple": false,
166
+ "deprecated": {
167
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
168
+ },
169
+ "deprecateAliases": true
115
170
  },
116
171
  "verbose": {
117
172
  "name": "verbose",
118
173
  "type": "boolean",
119
174
  "summary": "Display whether the configuration variables are set locally or globally.",
120
- "allowNo": false
175
+ "allowNo": false,
176
+ "deprecateAliases": true
121
177
  }
122
178
  },
123
179
  "args": {},
@@ -125,32 +181,36 @@
125
181
  "header": "CONFIGURATION VARIABLES",
126
182
  "body": [
127
183
  {
128
- "name": "apiVersion",
129
- "description": "API version of your project. Default: API version of your Dev Hub org. (sfdx only)"
184
+ "name": "org-instance-url",
185
+ "description": "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com."
186
+ },
187
+ {
188
+ "name": "org-api-version",
189
+ "description": "API version of your project. Default: API version of your Dev Hub org."
130
190
  },
131
191
  {
132
- "name": "disableTelemetry",
133
- "description": "Disables the collection of usage and user environment information, etc. Default: false. (sfdx only)"
192
+ "name": "target-dev-hub",
193
+ "description": "Username or alias of your default Dev Hub org. (sf only)"
134
194
  },
135
195
  {
136
- "name": "instanceUrl",
137
- "description": "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com. (sfdx only)"
196
+ "name": "target-org",
197
+ "description": "Username or alias of the org that all commands run against by default. (sf only)"
138
198
  },
139
199
  {
140
- "name": "maxQueryLimit",
141
- "description": "Maximum number of Salesforce records returned by a CLI command. Default: 10,000. (sfdx only)"
200
+ "name": "org-isv-debugger-sid",
201
+ "description": "ISV debugger SID."
142
202
  },
143
203
  {
144
- "name": "restDeploy",
145
- "description": "Whether deployments use the Metadata REST API (true) or SOAP API (false, default value). (sfdx only)"
204
+ "name": "org-isv-debugger-url",
205
+ "description": "ISV debugger URL."
146
206
  },
147
207
  {
148
- "name": "target-org",
149
- "description": "Username or alias of the org that all commands run against by default. (sf only)"
208
+ "name": "org-custom-metadata-templates",
209
+ "description": "A valid repository URL or directory for the custom org metadata templates."
150
210
  },
151
211
  {
152
- "name": "target-dev-hub",
153
- "description": "Username or alias of your default Dev Hub org. (sf only)"
212
+ "name": "org-max-query-limit",
213
+ "description": "Maximum number of Salesforce records returned by a CLI command. Default: 10,000."
154
214
  }
155
215
  ]
156
216
  }
@@ -163,17 +223,31 @@
163
223
  "pluginName": "@salesforce/plugin-settings",
164
224
  "pluginAlias": "@salesforce/plugin-settings",
165
225
  "pluginType": "core",
166
- "aliases": [],
226
+ "aliases": [
227
+ "force:config:list"
228
+ ],
167
229
  "examples": [
168
230
  "List both global configuration variables and those local to your project:\n$ <%= config.bin %> <%= command.id %>"
169
231
  ],
232
+ "deprecateAliases": true,
170
233
  "flags": {
171
234
  "json": {
172
235
  "name": "json",
173
236
  "type": "boolean",
174
237
  "description": "Format output as json.",
175
238
  "helpGroup": "GLOBAL",
176
- "allowNo": false
239
+ "allowNo": false,
240
+ "deprecateAliases": true
241
+ },
242
+ "loglevel": {
243
+ "name": "loglevel",
244
+ "type": "option",
245
+ "hidden": true,
246
+ "multiple": false,
247
+ "deprecated": {
248
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
249
+ },
250
+ "deprecateAliases": true
177
251
  }
178
252
  },
179
253
  "args": {}
@@ -186,27 +260,42 @@
186
260
  "pluginName": "@salesforce/plugin-settings",
187
261
  "pluginAlias": "@salesforce/plugin-settings",
188
262
  "pluginType": "core",
189
- "aliases": [],
263
+ "aliases": [
264
+ "force:config:set"
265
+ ],
190
266
  "examples": [
191
267
  "Set the local target-org configuration variable to an org username:\n<%= config.bin %> <%= command.id %> target-org=me@my.org",
192
268
  "Set the local target-org configuration variable to an alias:\n<%= config.bin %> <%= command.id %> target-org=my-scratch-org",
193
269
  "Set the global target-org configuration variable:\n<%= config.bin %> <%= command.id %> --global target-org=my-scratch-org",
194
270
  "Set a single configuration variable without using an equal sign; this syntax doesn't work when setting multiple configuration variables:\n<%= config.bin %> <%= command.id %> target-org me@my.com"
195
271
  ],
272
+ "deprecateAliases": true,
196
273
  "flags": {
197
274
  "json": {
198
275
  "name": "json",
199
276
  "type": "boolean",
200
277
  "description": "Format output as json.",
201
278
  "helpGroup": "GLOBAL",
202
- "allowNo": false
279
+ "allowNo": false,
280
+ "deprecateAliases": true
281
+ },
282
+ "loglevel": {
283
+ "name": "loglevel",
284
+ "type": "option",
285
+ "hidden": true,
286
+ "multiple": false,
287
+ "deprecated": {
288
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
289
+ },
290
+ "deprecateAliases": true
203
291
  },
204
292
  "global": {
205
293
  "name": "global",
206
294
  "type": "boolean",
207
295
  "char": "g",
208
296
  "summary": "Set the configuration variables globally, so they can be used from any Salesforce DX project.",
209
- "allowNo": false
297
+ "allowNo": false,
298
+ "deprecateAliases": true
210
299
  }
211
300
  },
212
301
  "args": {},
@@ -214,32 +303,36 @@
214
303
  "header": "CONFIGURATION VARIABLES",
215
304
  "body": [
216
305
  {
217
- "name": "apiVersion",
218
- "description": "API version of your project. Default: API version of your Dev Hub org. (sfdx only)"
306
+ "name": "org-instance-url",
307
+ "description": "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com."
219
308
  },
220
309
  {
221
- "name": "disableTelemetry",
222
- "description": "Disables the collection of usage and user environment information, etc. Default: false. (sfdx only)"
310
+ "name": "org-api-version",
311
+ "description": "API version of your project. Default: API version of your Dev Hub org."
223
312
  },
224
313
  {
225
- "name": "instanceUrl",
226
- "description": "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com. (sfdx only)"
314
+ "name": "target-dev-hub",
315
+ "description": "Username or alias of your default Dev Hub org. (sf only)"
227
316
  },
228
317
  {
229
- "name": "maxQueryLimit",
230
- "description": "Maximum number of Salesforce records returned by a CLI command. Default: 10,000. (sfdx only)"
318
+ "name": "target-org",
319
+ "description": "Username or alias of the org that all commands run against by default. (sf only)"
231
320
  },
232
321
  {
233
- "name": "restDeploy",
234
- "description": "Whether deployments use the Metadata REST API (true) or SOAP API (false, default value). (sfdx only)"
322
+ "name": "org-isv-debugger-sid",
323
+ "description": "ISV debugger SID."
235
324
  },
236
325
  {
237
- "name": "target-org",
238
- "description": "Username or alias of the org that all commands run against by default. (sf only)"
326
+ "name": "org-isv-debugger-url",
327
+ "description": "ISV debugger URL."
239
328
  },
240
329
  {
241
- "name": "target-dev-hub",
242
- "description": "Username or alias of your default Dev Hub org. (sf only)"
330
+ "name": "org-custom-metadata-templates",
331
+ "description": "A valid repository URL or directory for the custom org metadata templates."
332
+ },
333
+ {
334
+ "name": "org-max-query-limit",
335
+ "description": "Maximum number of Salesforce records returned by a CLI command. Default: 10,000."
243
336
  }
244
337
  ]
245
338
  }
@@ -252,25 +345,40 @@
252
345
  "pluginName": "@salesforce/plugin-settings",
253
346
  "pluginAlias": "@salesforce/plugin-settings",
254
347
  "pluginType": "core",
255
- "aliases": [],
348
+ "aliases": [
349
+ "force:config:unset"
350
+ ],
256
351
  "examples": [
257
352
  "Unset the local \"target-org\" configuration variable:\n<%= config.bin %> <%= command.id %> target-org",
258
353
  "Unset multiple configuration variables globally:\n<%= config.bin %> <%= command.id %> target-org api-version --global"
259
354
  ],
355
+ "deprecateAliases": true,
260
356
  "flags": {
261
357
  "json": {
262
358
  "name": "json",
263
359
  "type": "boolean",
264
360
  "description": "Format output as json.",
265
361
  "helpGroup": "GLOBAL",
266
- "allowNo": false
362
+ "allowNo": false,
363
+ "deprecateAliases": true
364
+ },
365
+ "loglevel": {
366
+ "name": "loglevel",
367
+ "type": "option",
368
+ "hidden": true,
369
+ "multiple": false,
370
+ "deprecated": {
371
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
372
+ },
373
+ "deprecateAliases": true
267
374
  },
268
375
  "global": {
269
376
  "name": "global",
270
377
  "type": "boolean",
271
378
  "char": "g",
272
379
  "summary": "Unset the configuration variables globally, so they can no longer be used from any Salesforce DX project.",
273
- "allowNo": false
380
+ "allowNo": false,
381
+ "deprecateAliases": true
274
382
  }
275
383
  },
276
384
  "args": {},
@@ -278,32 +386,36 @@
278
386
  "header": "CONFIGURATION VARIABLES",
279
387
  "body": [
280
388
  {
281
- "name": "apiVersion",
282
- "description": "API version of your project. Default: API version of your Dev Hub org. (sfdx only)"
389
+ "name": "org-instance-url",
390
+ "description": "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com."
391
+ },
392
+ {
393
+ "name": "org-api-version",
394
+ "description": "API version of your project. Default: API version of your Dev Hub org."
283
395
  },
284
396
  {
285
- "name": "disableTelemetry",
286
- "description": "Disables the collection of usage and user environment information, etc. Default: false. (sfdx only)"
397
+ "name": "target-dev-hub",
398
+ "description": "Username or alias of your default Dev Hub org. (sf only)"
287
399
  },
288
400
  {
289
- "name": "instanceUrl",
290
- "description": "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com. (sfdx only)"
401
+ "name": "target-org",
402
+ "description": "Username or alias of the org that all commands run against by default. (sf only)"
291
403
  },
292
404
  {
293
- "name": "maxQueryLimit",
294
- "description": "Maximum number of Salesforce records returned by a CLI command. Default: 10,000. (sfdx only)"
405
+ "name": "org-isv-debugger-sid",
406
+ "description": "ISV debugger SID."
295
407
  },
296
408
  {
297
- "name": "restDeploy",
298
- "description": "Whether deployments use the Metadata REST API (true) or SOAP API (false, default value). (sfdx only)"
409
+ "name": "org-isv-debugger-url",
410
+ "description": "ISV debugger URL."
299
411
  },
300
412
  {
301
- "name": "target-org",
302
- "description": "Username or alias of the org that all commands run against by default. (sf only)"
413
+ "name": "org-custom-metadata-templates",
414
+ "description": "A valid repository URL or directory for the custom org metadata templates."
303
415
  },
304
416
  {
305
- "name": "target-dev-hub",
306
- "description": "Username or alias of your default Dev Hub org. (sf only)"
417
+ "name": "org-max-query-limit",
418
+ "description": "Maximum number of Salesforce records returned by a CLI command. Default: 10,000."
307
419
  }
308
420
  ]
309
421
  }