changelog-tool 0.7.1 → 1.0.0

package/.github/workflows/node.yml

@@ -18,7 +18,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x]
+        node-version: [16.x, 18.x, 20.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

package/changelog.md

@@ -1,6 +1,32 @@
 Changelog
 =========
 
+1.0.0 (2023-06-20)
+------------------
+
+First stable release! Just kidding, it was already stable.
+
+* Add support for [Markdown reference links][1]. References are a Markdown
+  feature that lets you write links in paragraphs, but put the actual target
+  near the end of the document similar to references in technical documents.
+  This can declutter the reading experience for those reading the Markdown
+  sources. The tool doesn't let you quickly add links via the CLI yet, but it
+  will no longer mangle them when they appear.
+* Testing Node 20
+* Bugfix: Always insert an empty line between the 'preface' and bulletpoints
+  sections of a version block.
+
+
+0.7.2 (2023-02-17)
+------------------
+
+* Added a `--nowrap` option to `show`, which doesn't wrap long lines. This is
+  useful for copy-pasting changelog into places where linebreaks are
+  significant, such as the Github releases section.
+* Support multiple digits for the alpha/beta release string.
+* Also allows setting the changelog message as positional arguments.
+
+
 0.7.1 (2023-02-14)
 ------------------
 
@@ -60,4 +86,7 @@ Changelog
 0.1.0 (2023-02-08)
 ------------------
 
-* Implemented the 'help' and 'init' commands.
+* Implemented the 'help' and 'init' commands
+
+[1]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#link "Markdown cheatsheet: Links"
+

package/changelog.mjs

@@ -10,13 +10,21 @@ export class Changelog {
    */
   versions = [];
 
+  /**
+   * @type {Link[]}
+   */
+  links = [];
+
   toString() {
 
     return (
       this.title + '\n' +
       ('='.repeat(this.title.length)) + '\n' +
       '\n' +
-      this.versions.map(version => version.toString()).join('\n\n')
+      this.versions.map(version => version.toString()).join('\n\n') +
+
+      // Sorry about this line future me (or someone else)
+      (this.links.length > 0 ? ('\n' + this.links.map( link => wrap(`[${link.name}]: ${link.href}${link.title?` "${link.title}"`:''}`, link.name.length+4)).join('\n') + '\n') : '')
     );
 
   }
@@ -116,15 +124,28 @@ export class VersionLog {
 
   toString() {
 
+    return this.output();
+
+  }
+
+  /**
+   * Renders the changelog as a string.
+   *
+   * @param {boolean} lineWrap
+   * @returns {string}
+   */
+  output(lineWrap = true) {
+
+    const lineLength = lineWrap ? 79 : Infinity;
     const title = this.version + ' (' + (this.date ?? '????-??-??') + ')';
     return (
       title + '\n' +
       ('-'.repeat(title.length)) + '\n' +
-      (this.preface ? '\n' + wrap(this.preface) : '') +
+      (this.preface ? '\n' + wrap(this.preface, 0, lineLength) + '\n' : '') +
       '\n' +
-      this.items.map(version => version.toString()).join('\n') +
+      this.items.map(version => version.output(lineWrap)).join('\n') +
       '\n' +
-      (this.postface ? '\n' + wrap(this.postface) + '\n' : '')
+      (this.postface ? '\n' + wrap(this.postface, 0, lineLength) + '\n' : '')
     );
 
   }
@@ -134,7 +155,7 @@ export class VersionLog {
 export class LogItem {
 
   /**
-   * @type string
+   * @type {string}
    */
   message;
 
@@ -145,6 +166,17 @@ export class LogItem {
     this.message = message;
   }
 
+  /**
+   * Renders the changelog as a string.
+   *
+   * @param {boolean} lineWrap
+   * @returns {string}
+   */
+  output(lineWrap = true) {
+    const lineLength = lineWrap ? 79 : Infinity;
+    return wrap('* ' + this.message, 2, lineLength);
+  }
+
   toString() {
 
     return wrap('* ' + this.message, 2);
@@ -153,4 +185,9 @@ export class LogItem {
 
 }
 
-
+/**
+ * @typedef Link {Object}
+ * @property Link.href {string}
+ * @property Link.name {string}
+ * @property Link.title {string|null}
+ */

package/cli.mjs

@@ -49,6 +49,10 @@ async function main() {
         type: 'boolean',
         description: 'Indicates that the current change is a major change.',
       },
+      nowrap: {
+        type: 'boolean',
+        description: 'Don\'t wrap "show" output'
+      }
     },
     allowPositionals: true,
   });
@@ -79,7 +83,12 @@ async function main() {
         changeType = 'major';
       }
       if (!values.message) {
-        throw new Error('The "-m" or "--message" argument is required');
+        if (positionals.length>1) {
+          // We also support setting a message after the command instead of -m
+          values.message = positionals.slice(1).join(' ');
+        } else {
+          throw new Error('The "-m" or "--message" argument is required');
+        }
       }
       await add({
         message: values.message,
@@ -93,7 +102,11 @@ async function main() {
       await format();
       break;
     case 'show' :
-      await show({ all: !!values.all, version: positionals[1]});
+      await show({
+        all: !!values.all,
+        version: positionals[1],
+        noWrap: !!values.nowrap
+      });
       break;
     case 'list' :
       await list();
@@ -170,8 +183,9 @@ async function list() {
  * @param {Object} showOptions
  * @param {boolean} showOptions.all Show all versions
  * @param {string?} showOptions.version show a specific version
+ * @param {boolean?} showOptions.noWrap don't line-wrap output
  */
-async function show({all, version}) {
+async function show({all, version, noWrap}) {
 
   const changelog = await parseChangelog();
 
@@ -186,7 +200,7 @@ async function show({all, version}) {
 
   console.log(
     toRender
-      .map( log => log.toString())
+      .map( log => log.output(!noWrap))
       .join('\n\n')
   );
 

package/package.json

@@ -1,13 +1,20 @@
 {
   "name": "changelog-tool",
-  "version": "0.7.1",
+  "version": "1.0.0",
   "description": "A CLI tool for manipulating changelogs",
   "type": "module",
   "main": "index.mjs",
+  "homepage": "https://github.com/evert/changelog-tool",
+  "author": "Evert Pot (https://evertpot.com/)",
+  "license": "MIT",
   "scripts": {
     "test": "node --test",
     "watch": "tsc --watch"
   },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:evert/changelog-tool.git"
+  },
   "keywords": [
     "changelog",
     "markdown"

package/parse.mjs

@@ -14,6 +14,10 @@ export async function parseFile(filename) {
 
 }
 
+const linkReferenceRe = /^\[([a-zA-Z0-9])+\]:/;
+const versionRe = /^([0-9\.]{3,}(?:-(?:alpha|beta)\.[0-9]+)?) \(([0-9]{4}-[0-9]{2}-[0-9]{2}|\?\?\?\?-\?\?-\?\?)\)$/;
+
+
 /**
  * @param {string} changelogInput
  * @returns {Changelog}
@@ -51,10 +55,31 @@ export function parse(changelogInput) {
       continue;
     }
 
+    // Look for link references
+    if (linkReferenceRe.test(line)) {
+
+      let linkRefLine = line;
+      while(lines[idx+1]?.match(/^\W\W/)) {
+        // If the line was folded over multiple lines, read those too.
+        linkRefLine += ' ' + lines[idx+1].trim();
+        idx++;
+      }
+      const name = linkRefLine.match(linkReferenceRe)?.[1];
+      const href = linkRefLine.split(' ')[1];
+      const title = linkRefLine.includes('"') ? linkRefLine.substring(linkRefLine.indexOf('"')+1,linkRefLine.lastIndexOf('"')) : null;
+      changelog.links.push({
+        name: /** @type {string} */(name),
+        href,
+        title
+      });
+      continue;
+
+    }
+
     // Look to the next line for ----
     if (lines[idx+1]?.match(/^-{1,}$/)) {
       // Found a new Version
-      const matches = line.match(/^([0-9\.]{3,}(?:-(?:alpha|beta)\.[0-9])?) \(([0-9]{4}-[0-9]{2}-[0-9]{2}|\?\?\?\?-\?\?-\?\?)\)$/);
+      const matches = line.match(versionRe);
 
       if (!matches) {
         throw new Error(`A version title must have the format "1.0.0 (YYYY-MM-DD)" or "1.0.0 (????-??-??)" for unreleased versions. We found: "${line}"`);

package/readme.md

@@ -8,6 +8,9 @@ This tool currently expects to work with a file named 'changelog.md' in the
 current working directory. This is a markdown file that looks like this:
 
 ```
+Changelog
+=========
+
 0.4.0 (????-??-??)
 ------------------
 

package/test/parse.mjs

@@ -83,7 +83,6 @@ Well, that's all folks.
 *
 `;
 
-  debugger;
   const result = await parse(input);
 
   const latest = result.get('0.2.0');
@@ -93,3 +92,44 @@ Well, that's all folks.
 
 
 });
+
+test('Link references', async() => {
+
+
+  const input = `Changesss
+=========
+
+0.2.0 (????-??-??)
+------------------
+
+WOW another release. How good is that?
+Here's another line.
+
+* Implemented the 'list' command.
+* Added testing framework. See [the blog post][1] for more information.
+
+0.1.0 (2023-02-08)
+------------------
+
+* Implemented the ['help'][2] and 'init' commands.
+
+[1]: https://evertpot.com/ "My Blog"
+[2]: https://indieweb.social/@evert "My Mastodon account, but it's split
+  over two lines"
+`;
+
+  debugger;
+  const result = await parse(input);
+
+  assert.deepEqual({
+    name: '1',
+    href: 'https://evertpot.com/',
+    title: 'My Blog',
+  }, result.links[0]);
+  assert.deepEqual({
+    name: '2',
+    href: 'https://indieweb.social/@evert',
+    title: 'My Mastodon account, but it\'s split over two lines',
+  }, result.links[1]);
+
+});