sfdx-plugin-update-notifier 1.2.0 → 1.2.2

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.2.2](https://github.com/jayree/sfdx-plugin-update-notifier/compare/v1.2.1...v1.2.2) (2022-10-08)
+
+
+### Bug Fixes
+
+* **deps:** bump oclif-plugin-update-notifier from 1.5.0 to 1.5.1 ([02e8e91](https://github.com/jayree/sfdx-plugin-update-notifier/commit/02e8e9109355e340b278304ef681ea7e70189a04))
+
+## [1.2.1](https://github.com/jayree/sfdx-plugin-update-notifier/compare/v1.2.0...v1.2.1) (2022-09-20)
+
+
+### Bug Fixes
+
+* add missing changelog hook ([11e9fe6](https://github.com/jayree/sfdx-plugin-update-notifier/commit/11e9fe6955ff44f3607df475e6bd367d6eef90c7))
+
 # [1.2.0](https://github.com/jayree/sfdx-plugin-update-notifier/compare/v1.1.0...v1.2.0) (2022-09-20)
 
 

package/README.md

@@ -21,7 +21,7 @@ $ sfdx plugins:install sfdx-plugin-update-notifier
 $ sfdx plugins:[COMMAND]
 running command...
 $ sfdx plugins
-sfdx-plugin-update-notifier 1.2.0
+sfdx-plugin-update-notifier 1.2.2
 $ sfdx help plugins:[COMMAND]
 USAGE
   $ sfdx plugins:COMMAND

package/lib/hooks/changelog.d.ts

@@ -0,0 +1,2 @@
+import { Hook } from '@oclif/core';
+export declare const changelog: Hook<'changelog'>;

package/lib/hooks/changelog.js

@@ -0,0 +1,95 @@
+/*
+ * Copyright (c) 2022, jayree
+ * 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
+ */
+/* istanbul ignore file */
+import { join } from 'node:path';
+import fs from 'fs-extra';
+import Debug from 'debug';
+import TerminalRenderer from 'marked-terminal';
+import { marked } from 'marked';
+import semver from 'semver';
+// original from https://github.com/salesforcecli/plugin-info/blob/main/src/shared/parseReleaseNotes.ts
+const parseReleaseNotes = (notes, version) => {
+    let found = false;
+    let closestVersion;
+    let versions;
+    const parsed = marked.lexer(notes);
+    let tokens;
+    const findVersion = (desiredVersion) => {
+        versions = [];
+        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;
+                // We will use this to find the closest patch if passed version is not found
+                versions.push(coercedVersion);
+                if (coercedVersion === desiredVersion) {
+                    found = true;
+                    return token;
+                }
+                found = false;
+            }
+            else if (found === true) {
+                return token;
+            }
+        });
+    };
+    findVersion(version);
+    if (!tokens.length) {
+        // If version was not found, try again with the closest patch version
+        const semverRange = `${semver.major(version)}.${semver.minor(version)}.x`;
+        closestVersion = semver.maxSatisfying(versions, semverRange);
+        findVersion(closestVersion);
+    }
+    if (closestVersion !== undefined) {
+        const warning = marked.lexer(`# ATTENTION: Version ${version} was not found. Showing notes for closest patch version ${closestVersion}.`)[0];
+        tokens.unshift(warning);
+    }
+    return tokens;
+};
+// eslint-disable-next-line @typescript-eslint/require-await
+export const changelog = async function () {
+    const debug = Debug(`${this.config.bin}:sfdx-plugin-update-notifier:hooks:changelog`);
+    process.once('exit', () => {
+        try {
+            const pluginRootPath = join(new URL('./', import.meta.url).pathname, '..', '..');
+            const { name, version } = fs.readJsonSync(join(pluginRootPath, 'package.json'));
+            const changelogFile = fs.readFileSync(join(pluginRootPath, 'CHANGELOG.md'), 'utf8');
+            const cacheDir = join(this.config.cacheDir, name);
+            const versionFile = join(cacheDir, 'version');
+            fs.ensureFileSync(versionFile);
+            let latestVersion;
+            try {
+                latestVersion = fs.readJSONSync(versionFile);
+            }
+            catch (error) {
+                latestVersion = { version: '0.0.0' };
+            }
+            debug({ latestVersion: latestVersion.version, version });
+            if (latestVersion.version !== version) {
+                const tokens = parseReleaseNotes(changelogFile, version);
+                if (!tokens.length) {
+                    debug(`${name} - didn't find version '${version}'.`);
+                }
+                else {
+                    marked.setOptions({
+                        renderer: new TerminalRenderer({ emoji: false }),
+                    });
+                    tokens.unshift(marked.lexer(`# Changelog for '${name}':`)[0]);
+                    this.log(marked.parser(tokens));
+                    fs.writeJsonSync(versionFile, { version });
+                }
+            }
+            else {
+                debug(`${name} - no update`);
+            }
+        }
+        catch (error) {
+            debug(error);
+        }
+    });
+};
+//# sourceMappingURL=changelog.js.map

package/lib/hooks/changelog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"changelog.js","sourceRoot":"","sources":["../../src/hooks/changelog.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,0BAA0B;AAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,gBAAgB,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAG5B,uGAAuG;AACvG,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAE,OAAe,EAAkB,EAAE;IAC3E,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,IAAI,cAAsB,CAAC;IAC3B,IAAI,QAAkB,CAAC;IAEvB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAEnC,IAAI,MAAsB,CAAC;IAE3B,MAAM,WAAW,GAAG,CAAC,cAAsB,EAAQ,EAAE;QACnD,QAAQ,GAAG,EAAE,CAAC;QAEd,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YAC/B,yEAAyE;YACzE,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,KAAK,IAAI,CAAC,EAAE;gBAChD,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;gBAEzD,4EAA4E;gBAC5E,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBAE9B,IAAI,cAAc,KAAK,cAAc,EAAE;oBACrC,KAAK,GAAG,IAAI,CAAC;oBAEb,OAAO,KAAK,CAAC;iBACd;gBAED,KAAK,GAAG,KAAK,CAAC;aACf;iBAAM,IAAI,KAAK,KAAK,IAAI,EAAE;gBACzB,OAAO,KAAK,CAAC;aACd;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,WAAW,CAAC,OAAO,CAAC,CAAC;IAErB,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;QAClB,qEAAqE;QACrE,MAAM,WAAW,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAE1E,cAAc,GAAG,MAAM,CAAC,aAAa,CAAS,QAAQ,EAAE,WAAW,CAAC,CAAC;QAErE,WAAW,CAAC,cAAc,CAAC,CAAC;KAC7B;IAED,IAAI,cAAc,KAAK,SAAS,EAAE;QAChC,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAC1B,wBAAwB,OAAO,2DAA2D,cAAc,GAAG,CAC5G,CAAC,CAAC,CAAC,CAAC;QAEL,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;KACzB;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,4DAA4D;AAC5D,MAAM,CAAC,MAAM,SAAS,GAAsB,KAAK;IAC/C,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,8CAA8C,CAAC,CAAC;IACtF,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE;QACxB,IAAI;YACF,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YACjF,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,CAG7E,CAAC;YACF,MAAM,aAAa,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC;YACpF,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAClD,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YAC9C,EAAE,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;YAC/B,IAAI,aAAkC,CAAC;YACvC,IAAI;gBACF,aAAa,GAAG,EAAE,CAAC,YAAY,CAAC,WAAW,CAAwB,CAAC;aACrE;YAAC,OAAO,KAAK,EAAE;gBACd,aAAa,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;aACtC;YACD,KAAK,CAAC,EAAE,aAAa,EAAE,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;YACzD,IAAI,aAAa,CAAC,OAAO,KAAK,OAAO,EAAE;gBACrC,MAAM,MAAM,GAAG,iBAAiB,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;gBACzD,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;oBAClB,KAAK,CAAC,GAAG,IAAI,2BAA2B,OAAO,IAAI,CAAC,CAAC;iBACtD;qBAAM;oBACL,MAAM,CAAC,UAAU,CAAC;wBAChB,QAAQ,EAAE,IAAI,gBAAgB,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;qBACjD,CAAC,CAAC;oBACH,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC9D,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;oBAChC,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;iBAC5C;aACF;iBAAM;gBACL,KAAK,CAAC,GAAG,IAAI,cAAc,CAAC,CAAC;aAC9B;SACF;QAAC,OAAO,KAAK,EAAE;YACd,KAAK,CAAC,KAAK,CAAC,CAAC;SACd;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.2.0","commands":{}}
+{"version":"1.2.2","commands":{}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sfdx-plugin-update-notifier",
   "description": "update-notifier for sfdx plugins",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "author": "jayree",
   "type": "module",
   "bugs": "https://github.com/jayree/sfdx-plugin-update-notifier/issues",
@@ -9,7 +9,11 @@
     "@oclif/core": "^1.16.3",
     "@salesforce/kit": "^1.6.1",
     "debug": "^4.3.4",
+    "fs-extra": "^10.1.0",
+    "marked": "^4.1.0",
+    "marked-terminal": "^5.1.1",
     "oclif-plugin-update-notifier": "^1.5.0",
+    "semver": "^7.3.7",
     "tslib": "^2.4.0"
   },
   "devDependencies": {
@@ -29,6 +33,7 @@
     "@types/marked-terminal": "^3.1.3",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.7.18",
+    "@types/semver": "^7.3.12",
     "@types/sinon": "^10.0.13",
     "@typescript-eslint/eslint-plugin": "^5.38.0",
     "@typescript-eslint/parser": "^5.38.0",
@@ -75,7 +80,8 @@
     "bin": "sfdx",
     "hooks": {
       "init": "./lib/hooks/init",
-      "prerun": "./lib/hooks/prerun"
+      "prerun": "./lib/hooks/prerun",
+      "update": "./lib/hooks/changelog"
     },
     "plugins": [
       "oclif-plugin-update-notifier"