@salesforce/cli 1.16.0 → 1.17.0

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 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.17.0](https://github.com/salesforcecli/cli/compare/v1.16.0...v1.17.0) (2022-03-02)
+
 ## [1.16.0](https://github.com/salesforcecli/cli/compare/v1.15.0...v1.16.0) (2022-02-23)
 
 ## [1.15.0](https://github.com/salesforcecli/cli/compare/v1.14.0...v1.15.0) (2022-02-16)

package/README.md

@@ -31,7 +31,7 @@ $ npm install -g @salesforce/cli
 $ sf COMMAND
 running command...
 $ sf (--version|-v)
-@salesforce/cli/1.16.0 linux-x64 node-v14.19.0
+@salesforce/cli/1.17.0 linux-x64 node-v14.19.0
 $ sf --help [COMMAND]
 USAGE
   $ sf COMMAND
@@ -322,7 +322,7 @@ EXAMPLES
     $ sf deploy --interactive
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.0.6/src/commands/deploy.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v1.1.1/src/commands/deploy.ts)_
 
 ## `sf deploy functions`
 
@@ -1003,7 +1003,7 @@ DESCRIPTION
   Display help for sf.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.10/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.11/src/commands/help.ts)_
 
 ## `sf info:releasenotes:display [-v <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
 
@@ -1070,7 +1070,7 @@ EXAMPLES
     $ sf login
 ```
 
-_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.7/src/commands/login.ts)_
+_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.8/src/commands/login.ts)_
 
 ## `sf login functions`
 
@@ -1337,7 +1337,7 @@ EXAMPLES
     $ sf logout --no-prompt
 ```
 
-_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.7/src/commands/logout.ts)_
+_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v1.0.8/src/commands/logout.ts)_
 
 ## `sf logout functions`
 

package/bin/run

@@ -1,5 +1,8 @@
 #!/usr/bin/env node
 
+/* tslint:disable:no-var-requires only-arrow-functions */
+/* eslint-disable global-require, prefer-arrow-callback */
+
 // Since the CLI is a single process, we can have a larger amount of max listeners since
 // the process gets shut down. Don't set it to 0 (no limit) since we should still be aware
 // of rouge event listeners
@@ -8,6 +11,26 @@ process.setMaxListeners(parseInt(process.env.SF_MAX_EVENT_LISTENERS, 10) || 1000
 // Don't let other plugins override the CLI specified max listener count
 process.setMaxListeners = () => {};
 
-require('@oclif/core').run()
-.then(require('@oclif/core/flush'))
-.catch(require('@oclif/core/handle'))
+// Check node version before requiring additional packages
+require('../dist/versions').checkNodeVersion();
+
+const cli = require('../dist/cli');
+const pjson = require('../package.json');
+
+// OVERRIDES gets replaced with particular values for binary builds,
+// but simply use defaults for npm and local invocations
+const overrides = {
+  /* @OVERRIDES@ */
+};
+const version = overrides.version || pjson.version;
+const channel = overrides.channel || 'stable';
+
+cli
+  .create(version, channel)
+  .run()
+  .then(function (result) {
+    require('@oclif/core/flush')();
+  })
+  .catch(function (err) {
+    require('@oclif/core/handle')(err);
+  });

package/dist/cli.js

@@ -0,0 +1,119 @@
+"use strict";
+/*
+ * Copyright (c) 2022, 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.create = exports.configureAutoUpdate = exports.configureUpdateSites = exports.UPDATE_DISABLED_DEMO = exports.UPDATE_DISABLED_NPM = exports.UPDATE_DISABLED_INSTALLER = void 0;
+const os = require("os");
+const path = require("path");
+const core_1 = require("@oclif/core");
+const kit_1 = require("@salesforce/kit");
+const ts_types_1 = require("@salesforce/ts-types");
+const Debug = require("debug");
+const env_1 = require("./util/env");
+const debug = Debug('sf');
+const envVars = [
+    ...new Set([
+        ...Object.keys(process.env).filter((e) => e.startsWith('SF_') || e.startsWith('SFDX_')),
+        'NODE_OPTIONS',
+        env_1.Env.SF_AUTOUPDATE_DISABLE,
+        'SF_BINPATH',
+        'SF_COMPILE_CACHE',
+        env_1.Env.SF_DISABLE_AUTOUPDATE,
+        env_1.Env.SF_ENV,
+        env_1.Env.SF_INSTALLER,
+        env_1.Env.SF_LAZY_LOAD_MODULES,
+        env_1.Env.SF_NPM_REGISTRY,
+        'SF_REDIRECTED',
+        env_1.Env.SF_S3_HOST,
+        env_1.Env.SF_UPDATE_INSTRUCTIONS,
+    ]),
+];
+exports.UPDATE_DISABLED_INSTALLER = 'Manual and automatic CLI updates have been disabled by setting "SF_AUTOUPDATE_DISABLE=true". ' +
+    'To check for a new version, unset that environment variable.';
+exports.UPDATE_DISABLED_NPM = 'Use "npm update --global @salesforce/cli" to update npm-based installations.';
+exports.UPDATE_DISABLED_DEMO = 'Manual and automatic CLI updates have been disabled in DEMO mode. ' +
+    'To check for a new version, unset the environment variable SF_ENV.';
+function configureUpdateSites(config, env = env_1.default) {
+    const s3Host = env.getS3HostOverride();
+    if (s3Host) {
+        // Override config value if set via envar
+        (0, kit_1.set)(config, 'pjson.oclif.update.s3.host', s3Host);
+    }
+    const npmRegistry = env.getNpmRegistryOverride();
+    if (npmRegistry) {
+        // Override config value if set via envar
+        (0, kit_1.set)(config, 'pjson.oclif.warn-if-update-available.registry', npmRegistry);
+    }
+}
+exports.configureUpdateSites = configureUpdateSites;
+function configureAutoUpdate(envars) {
+    if (envars.isDemoMode()) {
+        // Disable autoupdates in demo mode
+        envars.setAutoupdateDisabled(true);
+        envars.setUpdateInstructions(exports.UPDATE_DISABLED_DEMO);
+        return;
+    }
+    if (envars.isInstaller()) {
+        envars.normalizeAutoupdateDisabled();
+        if (envars.isAutoupdateDisabled()) {
+            envars.setUpdateInstructions(exports.UPDATE_DISABLED_INSTALLER);
+        }
+        return;
+    }
+    // Not an installer, so this must be running from an npm installation
+    if (!envars.isAutoupdateDisabledSet()) {
+        // Disable autoupdates if run from an npm install or in local dev, if not explicitly set
+        envars.setAutoupdateDisabled(true);
+    }
+    if (envars.isAutoupdateDisabled()) {
+        envars.setUpdateInstructions(exports.UPDATE_DISABLED_NPM);
+    }
+}
+exports.configureAutoUpdate = configureAutoUpdate;
+function debugCliInfo(version, channel, env, config) {
+    function debugSection(section, items) {
+        const pad = 25;
+        debug('%s:', section.padStart(pad));
+        items.forEach(([name, value]) => debug('%s: %s', name.padStart(pad), value));
+    }
+    debugSection('OS', [
+        ['platform', os.platform()],
+        ['architecture', os.arch()],
+        ['release', os.release()],
+        ['shell', config.shell],
+    ]);
+    debugSection('NODE', [['version', process.versions.node]]);
+    debugSection('CLI', [
+        ['version', version],
+        ['channel', channel],
+        ['bin', config.bin],
+        ['data', config.dataDir],
+        ['cache', config.cacheDir],
+        ['config', config.configDir],
+    ]);
+    debugSection('ENV', [...envVars].map((key) => [key, env.getString(key, '<not set>')]));
+    debugSection('ARGS', process.argv.map((arg, i) => [i.toString(), arg]));
+}
+function create(version, channel, run, env = env_1.default) {
+    const root = path.resolve(__dirname, '..');
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const pjson = require(path.resolve(__dirname, '..', 'package.json'));
+    const args = process.argv.slice(2);
+    return {
+        async run() {
+            const config = new core_1.Config({ name: (0, ts_types_1.get)(pjson, 'oclif.bin'), root, version, channel });
+            await config.load();
+            configureUpdateSites(config, env);
+            configureAutoUpdate(env);
+            debugCliInfo(version, channel, env, config);
+            // Example of how run is used in a test https://github.com/salesforcecli/cli/pull/171/files#diff-1deee0a575599b2df117c280da319f7938aaf6fdb0c04bcdbde769dbf464be69R46
+            return run ? run(args, config) : await (0, core_1.run)(args, config);
+        },
+    };
+}
+exports.create = create;
+//# sourceMappingURL=cli.js.map

package/dist/help/sfCommandHelp.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SfCommandHelp = void 0;
 /*
- * Copyright (c) 2020, salesforce.com, inc.
+ * Copyright (c) 2022, 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

package/dist/help/sfHelp.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 /*
- * Copyright (c) 2020, salesforce.com, inc.
+ * Copyright (c) 2022, 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

package/dist/util/env.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Env = void 0;
+/*
+ * Copyright (c) 2022, 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
+ */
+const core_1 = require("@salesforce/core");
+class Env extends core_1.EnvVars {
+    constructor(env = process.env) {
+        super(env);
+    }
+    isAutoupdateDisabled() {
+        return this.getBoolean(Env.SF_AUTOUPDATE_DISABLE) || this.getBoolean(Env.SF_DISABLE_AUTOUPDATE);
+    }
+    isAutoupdateDisabledSet() {
+        return !!this.getString(Env.SF_AUTOUPDATE_DISABLE) || !!this.getString(Env.SF_DISABLE_AUTOUPDATE);
+    }
+    setAutoupdateDisabled(value, updateInstructions) {
+        this.setBoolean(Env.SF_AUTOUPDATE_DISABLE, value);
+        this.setBoolean(Env.SF_DISABLE_AUTOUPDATE, value);
+        if (updateInstructions) {
+            this.setUpdateInstructions(updateInstructions);
+        }
+    }
+    setUpdateInstructions(value) {
+        this.setString(Env.SF_UPDATE_INSTRUCTIONS, value);
+    }
+    isDemoMode() {
+        return (this.getString(Env.SF_ENV, 'production') || '').toLowerCase() === 'demo';
+    }
+    isInstaller() {
+        // Check SFDX_INSTALLER instead of SF_INSTALLER until such time sf has its own installers
+        return this.getBoolean(Env.SFDX_INSTALLER);
+    }
+    getS3HostOverride() {
+        return this.getString(Env.SF_S3_HOST);
+    }
+    setS3HostOverride(value) {
+        return this.setString(Env.SF_S3_HOST, value);
+    }
+    getNpmRegistryOverride() {
+        return this.getString(Env.SF_NPM_REGISTRY);
+    }
+    setNpmRegistryOverride(value) {
+        return this.setString(Env.SF_NPM_REGISTRY, value);
+    }
+    isLazyRequireEnabled() {
+        return this.getBoolean(Env.SF_LAZY_LOAD_MODULES);
+    }
+    normalizeAutoupdateDisabled() {
+        // Ensure that the legacy envar always causes the oclif counterpart to be set
+        // see https://github.com/oclif/plugin-update/blob/3946fb296a0a95544ab6364b36a1f7422c8aeddf/src/hooks/init.ts#L22
+        if (this.getBoolean(Env.SF_AUTOUPDATE_DISABLE)) {
+            this.setBoolean(Env.SF_DISABLE_AUTOUPDATE, true);
+        }
+        else if (this.getBoolean(Env.SF_DISABLE_AUTOUPDATE)) {
+            this.setBoolean(Env.SF_AUTOUPDATE_DISABLE, true);
+        }
+    }
+}
+exports.Env = Env;
+Env.SF_AUTOUPDATE_DISABLE = 'SF_AUTOUPDATE_DISABLE';
+Env.SF_DISABLE_AUTOUPDATE = 'SF_DISABLE_AUTOUPDATE';
+Env.SF_ENV = 'SF_ENV';
+Env.SF_INSTALLER = 'SF_INSTALLER';
+Env.SFDX_INSTALLER = 'SFDX_INSTALLER';
+Env.SF_LAZY_LOAD_MODULES = 'SF_LAZY_LOAD_MODULES';
+Env.SF_NPM_REGISTRY = 'SF_NPM_REGISTRY';
+Env.SF_S3_HOST = 'SF_S3_HOST';
+Env.SF_UPDATE_INSTRUCTIONS = 'SF_UPDATE_INSTRUCTIONS';
+exports.default = new Env();
+//# sourceMappingURL=env.js.map

package/dist/versions.js

@@ -0,0 +1,46 @@
+"use strict";
+/* eslint-disable */
+/*
+ * Copyright (c) 2022, 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.checkNodeVersion = exports.isVersion = void 0;
+const semver = require("semver");
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const pjson = require('../package.json');
+/**
+ * Determines whether or not a tag string is a semantic version.
+ *
+ * @param {*} tag The possible version string
+ * @returns {boolean} True, if the string is recognized as a semantic version
+ */
+function isVersion(tag) {
+    if (!tag) {
+        return false;
+    }
+    return !!semver.valid(tag) || false;
+}
+exports.isVersion = isVersion;
+module.exports.isVersion = isVersion;
+/**
+ * Checks the current Node version for compatibility before launching the CLI.
+ */
+function checkNodeVersion(preferThrow = false, currentVersion = process.versions.node, requiredVersion = pjson.engines.node.slice(2)) {
+    if (semver.compare(currentVersion, requiredVersion) < 0) {
+        const message = `Unsupported Node.js version ${currentVersion}, version ${requiredVersion} or later is required.`;
+        if (!preferThrow) {
+            // eslint-disable-next-line no-console
+            console.error(message);
+            process.exit(1);
+        }
+        else {
+            throw new Error(message);
+        }
+    }
+}
+exports.checkNodeVersion = checkNodeVersion;
+module.exports.checkNodeVersion = checkNodeVersion;
+//# sourceMappingURL=versions.js.map