@salesforce/plugin-info 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+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.1.0](https://github.com/salesforcecli/plugin-info/compare/v1.0.0...v1.1.0) (2021-11-22)
+
+
+### Features
+
+* initial setup and release notes fetch ([d258d91](https://github.com/salesforcecli/plugin-info/commit/d258d91cf3f781c0afbc4f8b3c776cd4fd0085ef))
+* parse and render release notes ([f5e3398](https://github.com/salesforcecli/plugin-info/commit/f5e3398f14e74aa1f83fa308c9601f1b770afcae))
+* parse release notes ([83f0a47](https://github.com/salesforcecli/plugin-info/commit/83f0a47d5e54e0e0cacace1f3bc12ad757aa6e38))
+
+
+### Bug Fixes
+
+* no more partial version match. updates footer ([010c4f3](https://github.com/salesforcecli/plugin-info/commit/010c4f38e963e416f57032db9578a28b26ed2b08))
+* pin typescript ([c02bd4e](https://github.com/salesforcecli/plugin-info/commit/c02bd4e0beb4b686e5a3e6ced866e97d4d61ed88))
+* switch from axios to got, added tests ([ef74275](https://github.com/salesforcecli/plugin-info/commit/ef74275517f2305e705e9f21d62f9f916a17471a))
+* test for Windows ([16db159](https://github.com/salesforcecli/plugin-info/commit/16db159ca3fb64a51f0076881bea5df37e4edce9))
+
+## 1.0.0 (2021-10-12)

package/LICENSE.txt

@@ -0,0 +1,12 @@
+Copyright (c) 2018, Salesforce.com, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,112 @@
+# plugin-info
+
+[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-info.svg?label=@salesforce/plugin-info)](https://www.npmjs.com/package/@salesforce/plugin-info) [![CircleCI](https://circleci.com/gh/salesforcecli/plugin-info/tree/main.svg?style=shield)](https://circleci.com/gh/salesforcecli/plugin-info/tree/main) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-info.svg)](https://npmjs.org/package/@salesforce/plugin-info) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/plugin-info/main/LICENSE.txt)
+## Learn about the plugin-info
+
+Salesforce CLI plugins are based on the [oclif plugin framework](<(https://oclif.io/docs/introduction.html)>). Read the [plugin developer guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_plugins.meta/sfdx_cli_plugins/cli_plugins_architecture_sf_cli.htm) to learn about Salesforce CLI plugin development.
+
+This repository contains a lot of additional scripts and tools to help with general Salesforce node development and enforce coding standards. You should familiarize yourself with some of the [node developer packages](https://github.com/forcedotcom/sfdx-dev-packages/) used by Salesforce. There is also a default circleci config using the [release management orb](https://github.com/forcedotcom/npm-release-management-orb) standards.
+
+Additionally, there are some additional tests that the Salesforce CLI will enforce if this plugin is ever bundled with the CLI. These test are included by default under the `posttest` script and it is recommended to keep these tests active in your plugin, regardless if you plan to have it bundled.
+
+This plugin is bundled with the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli). For more information on the CLI, read the [getting started guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_intro.htm).
+
+We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.
+
+## Install
+
+```bash
+sfdx plugins:install info@x.y.z
+```
+
+## Issues
+
+Please report any issues at https://github.com/forcedotcom/cli/issues
+
+## Contributing
+
+1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
+2. Create a new issue before starting your project so that we can keep track of
+   what you are trying to add/fix. That way, we can also offer suggestions or
+   let you know if there is already an effort in progress.
+3. Fork this repository.
+4. [Build the plugin locally](#build)
+5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
+6. Edit the code in your fork.
+7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
+8. Sign CLA (see [CLA](#cla) below).
+9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
+
+### CLA
+
+External contributors will be required to sign a Contributor's License
+Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.
+
+### Build
+
+To build the plugin locally, make sure to have yarn installed and run the following commands:
+
+```bash
+# Clone the repository
+git clone git@github.com:salesforcecli/plugin-info
+
+# Install the dependencies and compile
+yarn install
+yarn build
+```
+
+To use your plugin, run using the local `./bin/run` or `./bin/run.cmd` file.
+
+```bash
+# Run using local run file.
+./bin/run info
+```
+
+There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
+
+```bash
+# Link your plugin to the sfdx cli
+sfdx plugins:link .
+# To verify
+sfdx plugins
+```
+
+## Commands
+
+<!-- commands -->
+* [`sfdx info:releasenotes:display [-v <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-inforeleasenotesdisplay--v-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
+
+## `sfdx info:releasenotes:display [-v <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
+
+display Salesforce CLI release notes on the command line
+
+```
+USAGE
+  $ sfdx info:releasenotes:display [-v <string>] [--json] [--loglevel 
+  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
+
+OPTIONS
+  -v, --version=version                                                             CLI version or tag for which to
+                                                                                    display release notes
+
+  --json                                                                            format output as json
+
+  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
+                                                                                    this command invocation
+
+ALIASES
+  $ sfdx whatsnew
+
+EXAMPLES
+  Display release notes for the currently installed CLI version:
+     sfdx info:releasenotes:display
+
+  Display release notes for CLI version 7.120.0:
+     sfdx info:releasenotes:display --version 7.120.0
+
+  Display release notes for the CLI version that corresponds to a tag (stable, stable-rc, latest, latest-rc, rc):
+     sfdx info:releasenotes:display --version latest
+```
+
+_See code: [src/commands/info/releasenotes/display.ts](https://github.com/salesforcecli/plugin-info/blob/v1.1.0/src/commands/info/releasenotes/display.ts)_
+<!-- commandsstop -->

package/lib/commands/info/releasenotes/display.d.ts

@@ -0,0 +1,12 @@
+import { flags, SfdxCommand } from '@salesforce/command';
+export default class Display extends SfdxCommand {
+    private static helpers;
+    static description: string;
+    static aliases: string[];
+    static examples: string[];
+    protected static flagsConfig: {
+        version: flags.Discriminated<flags.String>;
+        hook: flags.Discriminated<flags.Boolean<boolean>>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/info/releasenotes/display.js

@@ -0,0 +1,87 @@
+"use strict";
+/*
+ * Copyright (c) 2021, 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 });
+// Needed this to ensure the "helpers" were declared before read in examples
+/* eslint-disable @typescript-eslint/member-ordering */
+const os = require("os");
+const marked_1 = require("marked");
+const TerminalRenderer = require("marked-terminal");
+const kit_1 = require("@salesforce/kit");
+const command_1 = require("@salesforce/command");
+const core_1 = require("@salesforce/core");
+const getInfoConfig_1 = require("../../../shared/getInfoConfig");
+const getReleaseNotes_1 = require("../../../shared/getReleaseNotes");
+const getDistTagVersion_1 = require("../../../shared/getDistTagVersion");
+const parseReleaseNotes_1 = require("../../../shared/parseReleaseNotes");
+// Initialize Messages with the current plugin directory
+core_1.Messages.importMessagesDirectory(__dirname);
+const HIDE_NOTES = 'PLUGIN_INFO_HIDE_RELEASE_NOTES';
+const HIDE_FOOTER = 'PLUGIN_INFO_HIDE_FOOTER';
+// Load the specific messages for this file. Messages from @salesforce/command, @salesforce/core,
+// or any library that is using the messages framework can also be loaded this way.
+const messages = core_1.Messages.loadMessages('@salesforce/plugin-info', 'display');
+class Display extends command_1.SfdxCommand {
+    async run() {
+        var _a;
+        const env = new kit_1.Env();
+        if (env.getBoolean(HIDE_NOTES)) {
+            // We don't ever want to exit the process for info:releasenotes:display (whatsnew)
+            // In most cases we will log a message, but here we only trace log in case someone using stdout of the update command
+            this.logger.trace(`release notes disabled via env var: ${HIDE_NOTES}`);
+            this.logger.trace('exiting');
+            return;
+        }
+        const isHook = !!this.flags.hook;
+        try {
+            const installedVersion = this.config.pjson.version;
+            const infoConfig = await (0, getInfoConfig_1.getInfoConfig)(this.config.root);
+            const { distTagUrl, releaseNotesPath, releaseNotesFilename } = infoConfig.releasenotes;
+            let version = (_a = this.flags.version) !== null && _a !== void 0 ? _a : installedVersion;
+            if (Display.helpers.includes(version)) {
+                version = await (0, getDistTagVersion_1.getDistTagVersion)(distTagUrl, version);
+            }
+            const releaseNotes = await (0, getReleaseNotes_1.getReleaseNotes)(releaseNotesPath, releaseNotesFilename, version);
+            const tokens = (0, parseReleaseNotes_1.parseReleaseNotes)(releaseNotes, version, releaseNotesPath);
+            marked_1.marked.setOptions({
+                renderer: new TerminalRenderer(),
+            });
+            this.ux.log(marked_1.marked.parser(tokens));
+            if (isHook && !env.getBoolean(HIDE_FOOTER)) {
+                const footer = messages.getMessage('footer', [this.config.bin, releaseNotesPath, HIDE_NOTES, HIDE_FOOTER]);
+                this.ux.log(marked_1.marked.parse(footer));
+            }
+        }
+        catch (err) {
+            if (isHook) {
+                // Do not throw error if --hook is passed, just warn so we don't exit any processes.
+                // --hook is passed in the post install/update scripts
+                const { message, stack } = err;
+                this.ux.warn(`${this.id} failed: ${message}`);
+                this.logger.trace(stack);
+                return;
+            }
+            throw err;
+        }
+    }
+}
+exports.default = Display;
+Display.helpers = ['stable', 'stable-rc', 'latest', 'latest-rc', 'rc'];
+Display.description = messages.getMessage('commandDescription');
+Display.aliases = ['whatsnew'];
+Display.examples = messages.getMessage('examples', [Display.helpers.join(', ')]).split(os.EOL);
+Display.flagsConfig = {
+    version: command_1.flags.string({
+        char: 'v',
+        description: messages.getMessage('flags.version'),
+    }),
+    hook: command_1.flags.boolean({
+        hidden: true,
+        description: messages.getMessage('flags.hook'),
+    }),
+};
+//# sourceMappingURL=display.js.map

package/lib/commands/info/releasenotes/display.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"display.js","sourceRoot":"","sources":["../../../../src/commands/info/releasenotes/display.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,4EAA4E;AAC5E,uDAAuD;AAEvD,yBAAyB;AACzB,mCAAgC;AAChC,oDAAoD;AACpD,yCAAsC;AACtC,iDAAyD;AACzD,2CAA4C;AAC5C,iEAA8D;AAC9D,qEAAkE;AAClE,yEAAsE;AACtE,yEAAsE;AAEtE,wDAAwD;AACxD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAE5C,MAAM,UAAU,GAAG,gCAAgC,CAAC;AACpD,MAAM,WAAW,GAAG,yBAAyB,CAAC;AAE9C,iGAAiG;AACjG,mFAAmF;AACnF,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,yBAAyB,EAAE,SAAS,CAAC,CAAC;AAE7E,MAAqB,OAAQ,SAAQ,qBAAW;IAoBvC,KAAK,CAAC,GAAG;;QACd,MAAM,GAAG,GAAG,IAAI,SAAG,EAAE,CAAC;QAEtB,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YAC9B,kFAAkF;YAClF,qHAAqH;YACrH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uCAAuC,UAAU,EAAE,CAAC,CAAC;YACvE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAE7B,OAAO;SACR;QAED,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QAEjC,IAAI;YACF,MAAM,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;YAEnD,MAAM,UAAU,GAAG,MAAM,IAAA,6BAAa,EAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAEzD,MAAM,EAAE,UAAU,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,GAAG,UAAU,CAAC,YAAY,CAAC;YAEvF,IAAI,OAAO,GAAG,MAAC,IAAI,CAAC,KAAK,CAAC,OAAkB,mCAAI,gBAAgB,CAAC;YAEjE,IAAI,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;gBACrC,OAAO,GAAG,MAAM,IAAA,qCAAiB,EAAC,UAAU,EAAE,OAAO,CAAC,CAAC;aACxD;YAED,MAAM,YAAY,GAAG,MAAM,IAAA,iCAAe,EAAC,gBAAgB,EAAE,oBAAoB,EAAE,OAAO,CAAC,CAAC;YAE5F,MAAM,MAAM,GAAG,IAAA,qCAAiB,EAAC,YAAY,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC;YAE1E,eAAM,CAAC,UAAU,CAAC;gBAChB,QAAQ,EAAE,IAAI,gBAAgB,EAAE;aACjC,CAAC,CAAC;YAEH,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,eAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;YAEnC,IAAI,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE;gBAC1C,MAAM,MAAM,GAAG,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,gBAAgB,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;gBAE3G,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,eAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;aACnC;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,MAAM,EAAE;gBACV,oFAAoF;gBACpF,sDAAsD;gBACtD,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,GAAY,CAAC;gBAExC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,YAAY,OAAO,EAAE,CAAC,CAAC;gBAE9C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBAEzB,OAAO;aACR;YAED,MAAM,GAAG,CAAC;SACX;IACH,CAAC;;AA7EH,0BA8EC;AA7EgB,eAAO,GAAG,CAAC,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;AAEhE,mBAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAExD,eAAO,GAAG,CAAC,UAAU,CAAC,CAAC;AAEvB,gBAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;AAEpF,mBAAW,GAAG;IAC7B,OAAO,EAAE,eAAK,CAAC,MAAM,CAAC;QACpB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,eAAe,CAAC;KAClD,CAAC;IACF,IAAI,EAAE,eAAK,CAAC,OAAO,CAAC;QAClB,MAAM,EAAE,IAAI;QACZ,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC;KAC/C,CAAC;CACH,CAAC"}

package/lib/constants.d.ts

@@ -0,0 +1 @@
+export declare const PLUGIN_INFO_GET_TIMEOUT: number;

package/lib/constants.js

@@ -0,0 +1,11 @@
+"use strict";
+/*
+ * Copyright (c) 2021, 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.PLUGIN_INFO_GET_TIMEOUT = void 0;
+exports.PLUGIN_INFO_GET_TIMEOUT = (process.env.PLUGIN_INFO_GET_TIMEOUT || 3000);
+//# sourceMappingURL=constants.js.map

package/lib/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,uBAAuB,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,IAAI,IAAI,CAAW,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export = _default;

package/lib/index.js

@@ -0,0 +1,9 @@
+"use strict";
+/*
+ * Copyright (c) 2021, 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
+ */
+module.exports = {};
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;AAEH,iBAAS,EAAE,CAAC"}

package/lib/shared/getDistTagVersion.d.ts

@@ -0,0 +1,6 @@
+export declare type DistTagJson = {
+    latest: string;
+    'latest-rc': string;
+};
+declare const getDistTagVersion: (url: string, distTag: string) => Promise<string>;
+export { getDistTagVersion };

package/lib/shared/getDistTagVersion.js

@@ -0,0 +1,21 @@
+"use strict";
+/*
+ * Copyright (c) 2021, 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.getDistTagVersion = void 0;
+const got_1 = require("got");
+const constants_1 = require("../constants");
+const getDistTagVersion = async (url, distTag) => {
+    // TODO: Could use npm instead here. That way private cli repos could auth with .npmrc
+    // -- could utilize this: https://github.com/salesforcecli/plugin-trust/blob/0393b906a30e8858816625517eda5db69377c178/src/lib/npmCommand.ts
+    const options = { timeout: constants_1.PLUGIN_INFO_GET_TIMEOUT };
+    const body = await (0, got_1.default)(url, options).json();
+    // We are only interested in latest and latest-rc, could update this if other tags are desired
+    return distTag.includes('rc') ? body['latest-rc'] : body['latest'];
+};
+exports.getDistTagVersion = getDistTagVersion;
+//# sourceMappingURL=getDistTagVersion.js.map

package/lib/shared/getDistTagVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDistTagVersion.js","sourceRoot":"","sources":["../../src/shared/getDistTagVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,6BAAsB;AACtB,4CAAuD;AAOvD,MAAM,iBAAiB,GAAG,KAAK,EAAE,GAAW,EAAE,OAAe,EAAmB,EAAE;IAChF,sFAAsF;IACtF,2IAA2I;IAC3I,MAAM,OAAO,GAAG,EAAE,OAAO,EAAE,mCAAuB,EAAE,CAAC;IAErD,MAAM,IAAI,GAAG,MAAM,IAAA,aAAG,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC,IAAI,EAAe,CAAC;IAEzD,8FAA8F;IAC9F,OAAO,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACrE,CAAC,CAAC;AAEO,8CAAiB"}

package/lib/shared/getInfoConfig.d.ts

@@ -0,0 +1,15 @@
+import { PJSON } from '@oclif/config';
+export interface PjsonWithInfo extends PJSON {
+    oclif: PJSON['oclif'] & {
+        info: InfoConfig;
+    };
+}
+export interface InfoConfig {
+    releasenotes: {
+        distTagUrl: string;
+        releaseNotesPath: string;
+        releaseNotesFilename: string;
+    };
+}
+declare const getInfoConfig: (path: string) => Promise<InfoConfig>;
+export { getInfoConfig };

package/lib/shared/getInfoConfig.js

@@ -0,0 +1,36 @@
+"use strict";
+/*
+ * Copyright (c) 2021, 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.getInfoConfig = void 0;
+const path_1 = require("path");
+const core_1 = require("@salesforce/core");
+/* sfdx example to add to cli pjson.oclif
+
+example location with npm install:
+~/.nvm/versions/node/v14.17.5/lib/node_modules/sfdx-cli/package.json
+
+Add to oclif object
+"info": {
+  "releasenotes": {
+    "distTagUrl": "https://registry.npmjs.org/-/package/sfdx-cli/dist-tags",
+    "releaseNotesPath": "https://github.com/forcedotcom/cli/tree/main/releasenotes/sfdx",
+    "releaseNotesFilename": "README.md"
+  }
+}
+*/
+const getInfoConfig = async (path) => {
+    // TODO: could add env var support for these values
+    const fullPath = (0, path_1.join)(path, 'package.json');
+    const json = (await core_1.fs.readJson(fullPath));
+    const { info } = json.oclif;
+    if (!info)
+        throw new Error('getInfoConfig() failed to find pjson.oclif.info config');
+    return info;
+};
+exports.getInfoConfig = getInfoConfig;
+//# sourceMappingURL=getInfoConfig.js.map

package/lib/shared/getInfoConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getInfoConfig.js","sourceRoot":"","sources":["../../src/shared/getInfoConfig.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,2CAAsC;AAiBtC;;;;;;;;;;;;;EAaE;AAEF,MAAM,aAAa,GAAG,KAAK,EAAE,IAAY,EAAuB,EAAE;IAChE,mDAAmD;IACnD,MAAM,QAAQ,GAAG,IAAA,WAAI,EAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAE5C,MAAM,IAAI,GAAG,CAAC,MAAM,SAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAkB,CAAC;IAE5D,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;IAE5B,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAErF,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEO,sCAAa"}

package/lib/shared/getReleaseNotes.d.ts

@@ -0,0 +1,2 @@
+declare const getReleaseNotes: (base: string, filename: string, version: string) => Promise<string>;
+export { getReleaseNotes };

package/lib/shared/getReleaseNotes.js

@@ -0,0 +1,29 @@
+"use strict";
+/*
+ * Copyright (c) 2021, 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.getReleaseNotes = void 0;
+const got_1 = require("got");
+const semver_1 = require("semver");
+const constants_1 = require("../constants");
+const getReleaseNotes = async (base, filename, version) => {
+    const majorVersion = (0, semver_1.major)(version);
+    const rawBase = base.replace('github.com', 'raw.githubusercontent.com').replace('/blob/', '/').replace('/tree/', '/');
+    const options = {
+        timeout: constants_1.PLUGIN_INFO_GET_TIMEOUT,
+        throwHttpErrors: false,
+    };
+    const getPromises = [
+        (0, got_1.default)(`${rawBase}/v${majorVersion}.md`, options),
+        (0, got_1.default)(`${rawBase}/${filename}`, { ...options, throwHttpErrors: true }),
+    ];
+    const [versioned, readme] = await Promise.all(getPromises);
+    const { body } = versioned.statusCode === 200 ? versioned : readme;
+    return body;
+};
+exports.getReleaseNotes = getReleaseNotes;
+//# sourceMappingURL=getReleaseNotes.js.map

package/lib/shared/getReleaseNotes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getReleaseNotes.js","sourceRoot":"","sources":["../../src/shared/getReleaseNotes.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,6BAAsB;AACtB,mCAA+B;AAC/B,4CAAuD;AAEvD,MAAM,eAAe,GAAG,KAAK,EAAE,IAAY,EAAE,QAAgB,EAAE,OAAe,EAAmB,EAAE;IACjG,MAAM,YAAY,GAAG,IAAA,cAAK,EAAC,OAAO,CAAC,CAAC;IAEpC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,2BAA2B,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IAEtH,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,mCAAuB;QAChC,eAAe,EAAE,KAAK;KACvB,CAAC;IAEF,MAAM,WAAW,GAAG;QAClB,IAAA,aAAG,EAAC,GAAG,OAAO,KAAK,YAAY,KAAK,EAAE,OAAO,CAAC;QAC9C,IAAA,aAAG,EAAC,GAAG,OAAO,IAAI,QAAQ,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;KACrE,CAAC;IAEF,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAE3D,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC,UAAU,KAAK,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;IAEnE,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEO,0CAAe"}

package/lib/shared/parseReleaseNotes.d.ts

@@ -0,0 +1,3 @@
+import { marked } from 'marked';
+declare const parseReleaseNotes: (notes: string, version: string, baseUrl: string) => marked.Token[];
+export { parseReleaseNotes };

package/lib/shared/parseReleaseNotes.js

@@ -0,0 +1,46 @@
+"use strict";
+/*
+ * Copyright (c) 2018, 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.parseReleaseNotes = void 0;
+const marked_1 = require("marked");
+const parseReleaseNotes = (notes, version, baseUrl) => {
+    let found = false;
+    const parsed = marked_1.marked.lexer(notes);
+    // https://stackoverflow.com/a/6969486
+    const escapeRegExp = (string) => {
+        return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
+    };
+    const regexp = new RegExp(`\\b${escapeRegExp(version)}\\b`);
+    const tokens = parsed.filter((token) => {
+        // TODO: Could make header depth (2) a setting in oclif.info.releasenotes
+        if (token.type === 'heading' && token.depth === 2) {
+            if (regexp.exec(token.text)) {
+                found = true;
+                return token;
+            }
+            found = false;
+        }
+        else if (found === true) {
+            return token;
+        }
+    });
+    if (!tokens.length) {
+        throw new Error(`Didn't find version '${version}'. View release notes online at: ${baseUrl}`);
+    }
+    const fixRelativeLinks = (token) => {
+        // If link is relative, add the baseurl. https://regex101.com/r/h802kJ/1
+        // FWIW: 'marked' does have a 'baseURL' option, but the 'marked-terminal' renderer does not honor it
+        if (token.type === 'link' && !token.href.match(/(?:[a-z][a-z0-9+.-]*:|\/\/)/gi)) {
+            token.href = `${baseUrl}/${token.href}`;
+        }
+    };
+    marked_1.marked.walkTokens(tokens, fixRelativeLinks);
+    return tokens;
+};
+exports.parseReleaseNotes = parseReleaseNotes;
+//# sourceMappingURL=parseReleaseNotes.js.map

package/lib/shared/parseReleaseNotes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseReleaseNotes.js","sourceRoot":"","sources":["../../src/shared/parseReleaseNotes.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,mCAAgC;AAEhC,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAE,OAAe,EAAE,OAAe,EAAkB,EAAE;IAC5F,IAAI,KAAK,GAAG,KAAK,CAAC;IAElB,MAAM,MAAM,GAAG,eAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAEnC,sCAAsC;IACtC,MAAM,YAAY,GAAG,CAAC,MAAc,EAAU,EAAE;QAC9C,OAAO,MAAM,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC,CAAC,oCAAoC;IAC5F,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAE5D,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACrC,yEAAyE;QACzE,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,KAAK,KAAK,CAAC,EAAE;YACjD,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;gBAC3B,KAAK,GAAG,IAAI,CAAC;gBAEb,OAAO,KAAK,CAAC;aACd;YAED,KAAK,GAAG,KAAK,CAAC;SACf;aAAM,IAAI,KAAK,KAAK,IAAI,EAAE;YACzB,OAAO,KAAK,CAAC;SACd;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;QAClB,MAAM,IAAI,KAAK,CAAC,wBAAwB,OAAO,oCAAoC,OAAO,EAAE,CAAC,CAAC;KAC/F;IAED,MAAM,gBAAgB,GAAG,CAAC,KAAmB,EAAQ,EAAE;QACrD,wEAAwE;QACxE,oGAAoG;QACpG,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,+BAA+B,CAAC,EAAE;YAC/E,KAAK,CAAC,IAAI,GAAG,GAAG,OAAO,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;SACzC;IACH,CAAC,CAAC;IAEF,eAAM,CAAC,UAAU,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAE5C,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEO,8CAAiB"}

package/messages/display.js

@@ -0,0 +1,24 @@
+module.exports = {
+  commandDescription: 'display Salesforce CLI release notes on the command line',
+  flags: {
+    version: 'CLI version or tag for which to display release notes',
+    hook: 'suppresses errors; this is a hidden parameter used after install or update',
+  },
+  examples: [
+    `Display release notes for the currently installed CLI version:
+  <%= config.bin %> <%= command.id %>
+
+Display release notes for CLI version 7.120.0:
+  <%= config.bin %> <%= command.id %> --version 7.120.0
+
+Display release notes for the CLI version that corresponds to a tag (%s):
+  <%= config.bin %> <%= command.id %> --version latest
+  `,
+  ],
+  footer: `---
+- Run \`%s whatsnew\` to manually view the current release notes.
+- You can also view them on GitHub by visiting the [forcedotcom/cli](%s) repo.
+- Silence notes by setting the \`%s\` env var to \`true\`.
+- Hide this footer by setting the \`%s\` env var to \`true\`.
+---`,
+};

package/messages/messages.json

@@ -0,0 +1,22 @@
+{
+  "HelpDefaults": "If not supplied, the apiversion, template, and outputdir use default values.\n",
+  "HelpOutputDirRelative": "The outputdir can be an absolute path or relative to the current working directory.\n",
+  "HelpOutputDirRelativeLightning": "If you don’t specify an outputdir, we create a subfolder in your current working directory with the name of your bundle. For example, if the current working directory is force-app and your Lightning bundle is called myBundle, we create force-app/myBundle/ to store the files in the bundle.\n",
+  "HelpExamplesTitle": "\nExamples:\n",
+  "OutputDirFlagDescription": "folder for saving the created files",
+  "OutputDirFlagLongDescription": "The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The default is the current directory.",
+  "TemplateFlagDescription": "template to use for file creation",
+  "TemplateFlagLongDescription": "The template to use to create the file. Supplied parameter values or default values are filled into a copy of the template.",
+  "TargetDirOutput": "target dir = %s",
+  "App": "app",
+  "Event": "event",
+  "Interface": "interface",
+  "Test": "test",
+  "Component": "component",
+  "Page": "page",
+
+  "AlphaNumericNameError": "Name must contain only alphanumeric characters.",
+  "NameMustStartWithLetterError": "Name must start with a letter.",
+  "EndWithUnderscoreError": "Name can't end with an underscore.",
+  "DoubleUnderscoreError": "Name can't contain 2 consecutive underscores."
+}

package/oclif.manifest.json

@@ -0,0 +1 @@
+{"version":"1.1.0","commands":{"info:releasenotes:display":{"id":"info:releasenotes:display","description":"display Salesforce CLI release notes on the command line","usage":"<%= command.id %> [-v <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-info","pluginType":"core","aliases":["whatsnew"],"examples":["Display release notes for the currently installed CLI version:","  <%= config.bin %> <%= command.id %>","","Display release notes for CLI version 7.120.0:","  <%= config.bin %> <%= command.id %> --version 7.120.0","","Display release notes for the CLI version that corresponds to a tag (stable, stable-rc, latest, latest-rc, rc):","  <%= config.bin %> <%= command.id %> --version latest","  "],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"version":{"name":"version","type":"option","char":"v","description":"CLI version or tag for which to display release notes"},"hook":{"name":"hook","type":"boolean","description":"suppresses errors; this is a hidden parameter used after install or update","hidden":true,"allowNo":false}},"args":[]}}}

package/package.json

@@ -0,0 +1,132 @@
+{
+    "name": "@salesforce/plugin-info",
+    "description": "Plugin for accessing cli info from the command line",
+    "version": "1.1.0",
+    "author": "Salesforce",
+    "bugs": "https://github.com/forcedotcom/cli/issues",
+    "dependencies": {
+        "@oclif/config": "^1",
+        "@salesforce/command": "^4.1.5",
+        "@salesforce/core": "^2.29.0",
+        "@salesforce/kit": "^1.5.17",
+        "got": "^11.8.2",
+        "marked": "^4.0.1",
+        "marked-terminal": "^4.2.0",
+        "semver": "^7.3.5",
+        "sinon-chai": "^3.7.0",
+        "tslib": "^2"
+    },
+    "devDependencies": {
+        "@oclif/dev-cli": "^1",
+        "@oclif/plugin-command-snapshot": "^2.2.2",
+        "@salesforce/cli-plugins-testkit": "^1.4.17",
+        "@salesforce/dev-config": "^2.1.2",
+        "@salesforce/dev-scripts": "^0.9.18",
+        "@salesforce/plugin-command-reference": "^1.3.17",
+        "@salesforce/prettier-config": "^0.0.2",
+        "@salesforce/ts-sinon": "1.3.21",
+        "@types/fs-extra": "^9.0.13",
+        "@types/marked": "^4.0.0",
+        "@types/marked-terminal": "^3.1.3",
+        "@types/semver": "^7.3.8",
+        "@typescript-eslint/eslint-plugin": "^4.33.0",
+        "@typescript-eslint/parser": "^4.33.0",
+        "chai": "^4.3.4",
+        "cz-conventional-changelog": "^3.3.0",
+        "eslint": "^7.32.0",
+        "eslint-config-prettier": "^8.3.0",
+        "eslint-config-salesforce": "^0.1.6",
+        "eslint-config-salesforce-license": "^0.1.6",
+        "eslint-config-salesforce-typescript": "^0.2.8",
+        "eslint-plugin-header": "^3.1.1",
+        "eslint-plugin-import": "^2.25.3",
+        "eslint-plugin-jsdoc": "^35.5.1",
+        "eslint-plugin-prettier": "^3.4.1",
+        "husky": "^4.3.8",
+        "lint-staged": "^11.2.6",
+        "mocha": "^8.4.0",
+        "nyc": "^15.1.0",
+        "prettier": "^2.4.1",
+        "pretty-quick": "^3.1.0",
+        "shx": "0.3.3",
+        "sinon": "^11.1.1",
+        "ts-node": "^10.4.0",
+        "typescript": "^4.5.2"
+    },
+    "config": {
+        "commitizen": {
+            "path": "cz-conventional-changelog"
+        }
+    },
+    "engines": {
+        "node": ">=12.0.0"
+    },
+    "files": [
+        "/lib",
+        "/messages",
+        "/oclif.manifest.json"
+    ],
+    "homepage": "https://github.com/salesforcecli/plugin-info",
+    "keywords": [
+        "force",
+        "salesforce",
+        "sfdx",
+        "salesforcedx",
+        "sfdx-plugin"
+    ],
+    "license": "BSD-3-Clause",
+    "oclif": {
+        "commands": "./lib/commands",
+        "bin": "sfdx",
+        "devPlugins": [
+            "@oclif/plugin-help",
+            "@oclif/plugin-command-snapshot",
+            "@salesforce/plugin-command-reference"
+        ],
+        "topics": {
+            "info": {
+                "description": "access cli info from the command line",
+                "subtopics": {
+                    "releasenotes": {
+                        "description": "commands related to cli release notes"
+                    }
+                }
+            }
+        }
+    },
+    "repository": "salesforcecli/plugin-info",
+    "scripts": {
+        "build": "sf-build",
+        "clean": "sf-clean",
+        "clean-all": "sf-clean all",
+        "clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json",
+        "compile": "sf-compile",
+        "docs": "sf-docs",
+        "format": "sf-format",
+        "lint": "sf-lint",
+        "postpack": "shx rm -f oclif.manifest.json",
+        "posttest": "yarn lint && yarn test:deprecation-policy && yarn test:command-reference",
+        "prepack": "sf-prepack",
+        "prepare": "sf-install",
+        "pretest": "sf-compile-test",
+        "test": "sf-test",
+        "test:command-reference": "./bin/run commandreference:generate --erroronwarnings",
+        "test:deprecation-policy": "./bin/run snapshot:compare",
+        "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
+        "version": "oclif-dev readme"
+    },
+    "husky": {
+        "hooks": {
+            "pre-commit": "sf-husky-pre-commit",
+            "commit-msg": "sf-husky-commit-msg",
+            "pre-push": "sf-husky-pre-push"
+        }
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "sfdx": {
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-info/1.1.0.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-info/1.1.0.sig"
+    }
+}