changelog-tool 0.7.1 → 0.7.2

package/changelog.md

@@ -1,6 +1,16 @@
 Changelog
 =========
 
+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)
 ------------------
 

package/changelog.mjs

@@ -116,15 +116,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' +
-      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' : '')
     );
 
   }
@@ -145,6 +158,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);

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,6 +1,6 @@
 {
   "name": "changelog-tool",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "description": "A CLI tool for manipulating changelogs",
   "type": "module",
   "main": "index.mjs",

package/parse.mjs

@@ -54,7 +54,7 @@ export function parse(changelogInput) {
     // 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(/^([0-9\.]{3,}(?:-(?:alpha|beta)\.[0-9]+)?) \(([0-9]{4}-[0-9]{2}-[0-9]{2}|\?\?\?\?-\?\?-\?\?)\)$/);
 
       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}"`);