feat: support sfdx plugins with release notes or changelog

salesforcecli · Jan 17, 2023 · 6624818 · 6624818
1 parent 2683286
commit 6624818
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 11 deletions.
diff --git a/messages/display.md b/messages/display.md
@@ -14,6 +14,10 @@ CLI version or tag for which to display release notes.
 
 This hidden parameter is used in post install or update hooks.
 
+# flags.plugin.summary
+
+Plugin name for which to display release notes.
+
 # examples
 
 - Display release notes for the currently installed CLI version:

diff --git a/src/commands/info/releasenotes/display.ts b/src/commands/info/releasenotes/display.ts
@@ -13,7 +13,7 @@ import { marked } from 'marked';
 import * as TerminalRenderer from 'marked-terminal';
 import { Env } from '@salesforce/kit';
 import { Flags, SfCommand, loglevel } from '@salesforce/sf-plugins-core';
-import { Lifecycle, Logger, Messages } from '@salesforce/core';
+import { Lifecycle, Logger, Messages, SfError } from '@salesforce/core';
 import { AnyJson, JsonMap } from '@salesforce/ts-types';
 import { getInfoConfig } from '../../../shared/getInfoConfig';
 import { getReleaseNotes } from '../../../shared/getReleaseNotes';
@@ -40,6 +40,13 @@ export default class Display extends SfCommand<DisplayOutput> {
 
   public static readonly examples = messages.getMessages('examples', [Display.helpers.join(', ')]);
 
+  public static args = [
+    {
+      name: 'plugin',
+      description: messages.getMessage('flags.plugin.summary'),
+    },
+  ];
+
   public static readonly flags = {
     version: Flags.string({
       char: 'v',
@@ -54,7 +61,7 @@ export default class Display extends SfCommand<DisplayOutput> {
 
   public async run(): Promise<DisplayOutput> {
     const logger = Logger.childFromRoot(this.constructor.name);
-    const { flags } = await this.parse(Display);
+    const { flags, args } = await this.parse(Display);
     const env = new Env();
 
     const isHook = !!flags.hook;
@@ -70,9 +77,13 @@ export default class Display extends SfCommand<DisplayOutput> {
     }
 
     try {
-      const installedVersion = this.config.pjson.version;
+      const [plugin] = args.plugin ? this.config.plugins.filter((p) => p.name === args.plugin) : [this.config];
+
+      if (!plugin) throw new SfError(`No plugin '${args.plugin as string}' found`);
+
+      const installedVersion = plugin.pjson.version;
 
-      const infoConfig = await getInfoConfig(this.config.root);
+      const infoConfig = await getInfoConfig(plugin.root);
 
       const { distTagUrl, releaseNotesPath, releaseNotesFilename } = infoConfig.releasenotes;
 
@@ -90,7 +101,7 @@ export default class Display extends SfCommand<DisplayOutput> {
         renderer: new TerminalRenderer({ emoji: false }),
       });
 
-      tokens.unshift(marked.lexer(`# Release notes for '${this.config.bin}':`)[0]);
+      tokens.unshift(marked.lexer(`# Release notes for '${plugin.name}':`)[0]);
 
       if (flags.json) {
         const body = tokens.map((token) => token.raw).join(os.EOL);
@@ -104,7 +115,7 @@ export default class Display extends SfCommand<DisplayOutput> {
         if (env.getBoolean(HIDE_FOOTER)) {
           await Lifecycle.getInstance().emitTelemetry({ eventName: 'FOOTER_HIDDEN' });
         } else {
-          const footer = messages.getMessage('footer', [this.config.bin, releaseNotesPath, HIDE_NOTES, HIDE_FOOTER]);
+          const footer = messages.getMessage('footer', [plugin.name, releaseNotesPath, HIDE_NOTES, HIDE_FOOTER]);
           this.log(marked.parse(footer));
         }
       }

diff --git a/src/shared/parseReleaseNotes.ts b/src/shared/parseReleaseNotes.ts
@@ -22,8 +22,8 @@ const parseReleaseNotes = (notes: string, version: string, baseUrl: string): mar
 
     tokens = parsed.filter((token) => {
       // TODO: Could make header depth (2) a setting in oclif.info.releasenotes
-      if (token.type === 'heading' && token.depth === 2) {
-        const coercedVersion = semver.coerce(token.text).version;
+      if (token.type === 'heading' && token.depth <= 2) {
+        const coercedVersion = semver.coerce(token.text)?.version;
 
         // We will use this to find the closest patch if passed version is not found
         versions.push(coercedVersion);

diff --git a/test/commands/info/releasenotes/display.test.ts b/test/commands/info/releasenotes/display.test.ts
@@ -48,7 +48,7 @@ describe('info:releasenotes:display', () => {
   }
 
   const runDisplayCmd = async (params: string[]) => {
-    oclifConfigStub.bin = 'sfdx';
+    oclifConfigStub.name = 'sfdx-cli';
 
     const cmd = new TestDisplay(params, oclifConfigStub);
 
@@ -168,7 +168,7 @@ describe('info:releasenotes:display', () => {
   it('logs logs a header with cli bin', async () => {
     await runDisplayCmd([]);
 
-    expect(uxLogStub.args[0][0]).to.contain("# Release notes for 'sfdx':");
+    expect(uxLogStub.args[0][0]).to.contain("# Release notes for 'sfdx-cli':");
   });
 
   it('calls getReleaseNotes with passed version', async () => {
@@ -257,7 +257,7 @@ describe('info:releasenotes:display', () => {
     const json = await runDisplayCmd(['--json']);
 
     const expected = {
-      body: `# Release notes for 'sfdx':${os.EOL}## Release notes for 3.3.3`,
+      body: `# Release notes for 'sfdx-cli':${os.EOL}## Release notes for 3.3.3`,
       url: mockInfoConfig.releasenotes.releaseNotesPath,
     };