changelog-tool 0.2.0 → 0.4.0

package/changelog.md

@@ -1,6 +1,18 @@
 Changelog
 =========
 
+0.4.0 (2023-02-12)
+------------------
+
+* Implemented the "format", "parse" and "release" commands.
+
+
+0.3.0 (2023-02-12)
+------------------
+
+* Implemented the 'show' command.
+
+
 0.2.0 (2023-02-12)
 ------------------
 

package/changelog.mjs

@@ -16,8 +16,7 @@ export class Changelog {
       this.title + '\n' +
       ('='.repeat(this.title.length)) + '\n' +
       '\n' +
-      this.versions.map(version => version.toString()).join('\n\n') +
-      '\n'
+      this.versions.map(version => version.toString()).join('\n\n')
     );
 
   }
@@ -26,17 +25,59 @@ export class Changelog {
    * Adds a new Version log
    *
    * @param version {VersionLog}
+   * @returns {VersionLog}
    */
   add(version) {
 
-    this.versions.push(version);
+    this.versions = [version, ...this.versions];
+    return version;
+
+  }
+
+  /**
+   * Adds a new version to the log. Version string is automatically increased
+   * from the previous one
+   *
+   * @returns {VersionLog}
+   */
+  newVersion() {
+
+    const lastVersionStr = this.versions[0].version;
+    const lastVersionParts = lastVersionStr.split('.');
+    if (!lastVersionParts.at(-1)?.match(/^[0-9]+$/)) {
+      throw new Error(`Could not automatically determine the next version string after "${lastVersionStr}"`);
+    }
+    const newVersionStr = [
+      ...lastVersionParts.slice(0, -1),
+      // @ts-ignore-error 'Possibly udefined', but we know it isnt
+      parseInt(lastVersionParts.at(-1)) + 1
+    ].join('.');
+    const versionLog = new VersionLog(newVersionStr);
+
+    return this.add(versionLog);
+
+  }
+
+  /**
+   * Finds a VersionLog by its version string
+   *
+   * @param {string} version
+   * @returns {VersionLog}
+   */
+  get(version) {
+
+    const log = this.versions.find( myLog => myLog.version === version);
+    if (!log) {
+      throw new Error(`Couldn't find version ${version} in the changelog`);
+    }
+    return log;
 
   }
 
 }
 
 export class VersionLog {
-  
+
   /**
    * @type {string}
    */
@@ -72,9 +113,12 @@ export class VersionLog {
 
   /**
    * @param {string} message
+   * @returns {LogItem}
    */
   add(message) {
-    this.items.push(new LogItem(message));
+    const item = new LogItem(message);
+    this.items.push(item);
+    return item;
   }
 
   toString() {
@@ -83,11 +127,11 @@ export class VersionLog {
     return (
       title + '\n' +
       ('-'.repeat(title.length)) + '\n' +
-      (this.preface ? wrap(this.preface) + '\n' : '') +
+      (this.preface ? '\n' + wrap(this.preface) : '') +
       '\n' +
       this.items.map(version => version.toString()).join('\n') +
       '\n' +
-      (this.postface ? wrap(this.postface) + '\n' : '')
+      (this.postface ? '\n' + wrap(this.postface) + '\n' : '')
     );
 
   }

package/cli.mjs

@@ -0,0 +1,213 @@
+// @ts-check
+import { parseArgs } from 'node:util';
+import * as fs from 'node:fs/promises';
+import * as url from 'node:url';
+import { readPackageVersion, exists } from './util.mjs';
+import { Changelog, VersionLog, LogItem } from './changelog.mjs';
+import { parseFile } from './parse.mjs';
+
+const filename = 'changelog.md';
+
+const pkg = JSON.parse(
+  await fs.readFile(
+    url.fileURLToPath(url.resolve(import.meta.url, './package.json')),
+    'utf-8',
+  )
+);
+
+async function main() {
+
+  const { positionals, values } = parseArgs({
+    options: {
+      help: {
+        type: 'boolean',
+        short: 'h',
+        default: false,
+        description: 'This help screen',
+      },
+      all: {
+        type: 'boolean',
+        default: false,
+        description: 'Show all versions',
+      },
+    },
+    allowPositionals: true,
+  });
+
+
+
+  if (positionals.length < 1 || values.help) {
+    help();
+    process.exit(1);
+  }
+
+  const command = positionals[0];
+
+  switch(command) {
+    case 'help' :
+      await help();
+      break;
+    case 'init' :
+      await init();
+      break;
+    case 'add' :
+      if (positionals.length < 2) {
+        throw new Error('The "message" argument must be specified with the "add" command');
+      }
+      await add(positionals.slice(1).join(' '));
+      break;
+    case 'release' :
+      await release();
+      break;
+    case 'format' :
+      await format();
+      break;
+    case 'show' :
+      await show({ all: !!values.all, version: positionals[1]});
+      break;
+    case 'list' :
+      await list();
+      break;
+    default:
+      process.stderr.write(`Unknown command ${command}\n`);
+      process.exit(1);
+      break;
+  }
+
+}
+
+try {
+  await main();
+} catch (err) {
+  process.stderr.write('Error: ' + err.message + '\n');
+  process.exit(1);
+}
+
+function help() {
+  console.log(
+`Changelog Tool v${pkg.version}
+
+Manipulate your changelog file
+
+Usage:
+
+  changelog init           - Create a new, empty changelog.
+  changelog add [message]  - Adds a new line to the changelog.
+  changelog release        - Marks the current changelog as released.
+  changelog show           - Show the last changelog.
+  changelog show [version] - Show the changelog of a specific version.
+  changelog list           - List all versions in the changelog.
+  changelog format         - Reformats the changelog in the standard format.
+
+The logs this tool uses follows a specific markdown format. Currently it will
+only look for a file named 'changelog.md' in the current directory.
+
+To see an example of this format, you can either run 'changelog init' or
+check out the changelog shipped with this project:
+
+https://github.com/evert/changelog-tool
+`);
+
+}
+
+async function init() {
+
+  if (await exists(filename)) {
+    throw new Error(`A file named ${filename} already exists`);
+  }
+
+  const changelog = new Changelog();
+  const version = new VersionLog(await readPackageVersion());
+  version.add('New project!');
+  changelog.versions.push(version);
+
+  await fs.writeFile(filename, changelog.toString());
+  console.log(`${filename} created`);
+
+}
+
+async function list() {
+
+  const changelog = await parseChangelog();
+
+  for(const version of changelog.versions) {
+    console.log(version.version);
+  }
+
+}
+
+/**
+ * @param {Object} showOptions
+ * @param {boolean} showOptions.all Show all versions
+ * @param {string?} showOptions.version show a specific version
+ */
+async function show({all, version}) {
+
+  const changelog = await parseChangelog();
+
+  let toRender;
+  if (all) {
+    toRender = changelog.versions;
+  } else if (version) {
+    toRender = [changelog.get(version)];
+  } else {
+    toRender = [changelog.versions[0]];
+  }
+
+  console.log(
+    toRender
+      .map( log => log.toString())
+      .join('\n\n')
+  );
+
+}
+
+async function format() {
+  const changelog = await parseChangelog();
+  await fs.writeFile(filename, changelog.toString());
+  console.log(`${changelog.versions.length} changelogs saved to ${filename}`);
+}
+
+/**
+ * @param {string} message
+ */
+async function add(message) {
+  const changelog = await parseChangelog();
+
+  let lastVersion = changelog.versions[0];
+  if (lastVersion.date) {
+    lastVersion = changelog.newVersion();
+    console.log('Creating new version: %s', lastVersion.version);
+  }
+  lastVersion.add(message);
+
+  await fs.writeFile(filename, changelog.toString());
+  console.log(`${changelog.versions.length} changelogs saved to ${filename}`);
+}
+
+async function release() {
+  const changelog = await parseChangelog();
+
+  let lastVersion = changelog.versions[0];
+  if (lastVersion.date) {
+    throw new Error(`Previous version "${lastVersion.version}" already had a release date`);
+  }
+  lastVersion.date = new Date().toISOString().substr(0,10);
+  console.log(`Releasing ${lastVersion.version}`);
+  await fs.writeFile(filename, changelog.toString());
+  console.log(`${changelog.versions.length} changelogs saved to ${filename}`);
+
+}
+
+/**
+ * @returns {Promise<Changelog>}
+ */
+async function parseChangelog() {
+
+  if (!await exists(filename)) {
+    throw new Error(`${filename} not found in current directory`);
+  }
+
+  return await parseFile(filename);
+
+}

package/index.mjs

@@ -1,131 +1,2 @@
-// @ts-check
-import { parseArgs } from 'node:util';
-import * as fs from 'node:fs/promises';
-import * as url from 'node:url';
-import { readPackageVersion, exists } from './util.mjs';
-import { Changelog, VersionLog, LogItem } from './changelog.mjs';
-import { parseFile } from './parse.mjs';
-
-const filename = 'changelog.md';
-
-const pkg = JSON.parse(
-  await fs.readFile(
-    url.fileURLToPath(url.resolve(import.meta.url, './package.json')),
-    'utf-8',
-  )
-);
-
-async function main() {
-
-  const { positionals, values } = parseArgs({
-    options: {
-      help: {
-        type: 'boolean',
-        short: 'h',
-        default: false,
-        description: 'This help screen',
-      },
-    },
-    allowPositionals: true,
-  });
-
-
-
-  if (positionals.length < 1 || values.help) {
-    help();
-    process.exit(1);
-  }
-
-  const command = positionals[0];
-
-  switch(command) {
-    case 'help' :
-      await help();
-      break;
-    case 'init' :
-      await init();
-      break;
-      /*
-    case 'add' :
-      await add();
-      break;
-    case 'release' :
-      await release();
-      break;
-    case 'show' :
-      await show();
-      break;
-      */
-    case 'list' :
-      await list();
-      break;
-    default:
-      process.stderr.write(`Unknown command ${command}\n`);
-      process.exit(1);
-      break;
-  }
-
-}
-
-try {
-  await main();
-} catch (err) {
-  process.stderr.write('Error: ' + err.message + '\n');
-  process.exit(1);
-}
-
-function help() {
-  console.log(
-`Changelog Tool v${pkg.version}
-
-Manipulate your changelog file
-
-Usage:
-
-  changelog init           - Create a new, empty changelog.
-  changelog add [message]  - Adds a new line to the changelog.
-  changelog release        - Marks the current changelog as released.
-  changelog show           - Show the last changelog.
-  changelog show [version] - Show the changelog of a specific version.
-  changelog list           - List all versions in the changelog.
-
-The logs this tool uses follows a specific markdown format. Currently it will
-only look for a file named 'changelog.md' in the current directory.
-
-To see an example of this format, you can either run 'changelog init' or
-check out the changelog shipped with this project:
-
-https://github.com/evert/changelog-tool
-`);
-
-}
-
-async function init() {
-
-  if (await exists(filename)) {
-    throw new Error(`A file named ${filename} already exists`); 
-  }
-
-  const changelog = new Changelog();
-  const version = new VersionLog(await readPackageVersion());
-  version.add('New project!');
-  changelog.versions.push(version); 
-
-  await fs.writeFile(filename, changelog.toString());
-  console.log(`${filename} created`);
-
-}
-
-async function list() {
-
-  if (!await exists(filename)) {
-    throw new Error(`${filename} not found in current directory`);
-  }
-
-  const changelog = await parseFile(filename);
-
-  for(const version of changelog.versions) {
-    console.log(version.version);
-  }
-
-}
+export { parse, parseFile } from './parse.mjs';
+export { Changelog, VersionLog, LogItem } from './changelog.mjs';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "changelog-tool",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "A CLI tool for manipulating changelogs",
   "main": "index.mjs",
   "scripts": {
@@ -15,6 +15,9 @@
   "engine": {
     "node": ">16"
   },
+  "bin": {
+    "changelog": "./cli.mjs"
+  },
   "devDependencies": {
     "@types/node": "^18.11.19",
     "typescript": "^4.9.5"

package/parse.mjs

@@ -27,15 +27,37 @@ export function parse(changelogInput) {
   const changelog = new Changelog();
   changelog.title = lines[0];
 
+  let lastVersionLog = null;
+  let lastBullet = null;
+
   for(let idx=2; idx<lines.length; idx++) {
 
+    const line = lines[idx];
+
+    if (line.startsWith('* ')) {
+      // Found a bullet point
+      if (!lastVersionLog) {
+        throw new Error(`Parse error: found a bullet point * outside of a level 2 heading on line ${idx+1}`);
+      }
+      lastBullet = lastVersionLog.add(line.substr(1).trim());
+      continue;
+    }
+    if (line.startsWith('  ')) {
+      // Continuation of last line.
+      if (!lastBullet) {
+        throw new Error(`Parse error: unexpected indented string on line ${line+1}`);
+      }
+      lastBullet.message += ' ' + line.trim();
+      continue;
+    }
+
+    // Look to the next line for ----
     if (lines[idx+1]?.match(/^-{1,}$/)) {
       // Found a new Version
-      const versionTitle = lines[idx];
-      const matches = versionTitle.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: "${lines[idx]}"`);
+        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}"`);
       }
 
       const versionLog = new VersionLog(matches[1]);
@@ -44,10 +66,29 @@ export function parse(changelogInput) {
       } else {
         versionLog.date = matches[2];
       }
-      changelog.add(versionLog);
+      changelog.versions.push(versionLog);
+      lastVersionLog = versionLog;
+      lastBullet = null;
+      idx++;
+      continue;
 
     }
 
+    if (line.trim()==='') {
+      continue;
+    }
+
+    if (!lastVersionLog) {
+      throw new Error(`Parse error: unexpected string on line ${line+1}`);
+    }
+    // If we got here, this is either a loose preface or postface line.
+    if (lastBullet) {
+      lastVersionLog.postface = lastVersionLog.postface ? lastVersionLog.postface + ' ' + line : line;
+    } else {
+      lastVersionLog.preface = lastVersionLog.preface ? lastVersionLog.preface + ' ' + line : line;
+    }
+
+
   }
 
   return changelog;

package/readme.md

@@ -0,0 +1,48 @@
+Changelog tool
+==============
+
+This repository contains a simple tool for reading and manipulating changelog
+files.
+
+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:
+
+```
+0.4.0 (????-??-??)
+------------------
+
+* Feature A
+* Bugfix 3
+
+0.3.0 (2023-02-08)
+------------------
+
+* First public release!
+```
+
+Questionmarks for the date indicate an unreleased version.
+
+Installation
+------------
+
+```sh
+npm install changelog-tool --save-dev
+```
+
+CLI
+---
+
+To tool can be used programmatically and with the CLI. The CLI has the
+following commands:
+
+```
+npx changelog init           - Create a new, empty npx changelog.
+npx changelog add [message]  - Adds a new line to the npx changelog.
+npx changelog release        - Marks the current npx changelog as released.
+npx changelog show           - Show the last npx changelog.
+npx changelog show [version] - Show the npx changelog of a specific version.
+npx changelog list           - List all versions in the npx changelog.
+npx changelog format         - Reformats the npx changelog in the standard format.
+```
+
+Feature requests and bug reports are welcome.

package/test/parse.mjs

@@ -2,7 +2,7 @@ import { test } from 'node:test';
 import { parse } from '../parse.mjs';
 import * as assert from 'node:assert';
 
-test('Parsing a basic changelog', async () => {
+test('Parsing changelog metadata', async () => {
 
   const input = `Time for a change
 =========
@@ -31,3 +31,64 @@ test('Parsing a basic changelog', async () => {
   assert.equal('0.1.0', result.versions[1].version);
 
 });
+
+test('Parsing changelog entries', async () => {
+
+  const input = `Time for a change
+=========
+
+0.2.0 (????-??-??)
+------------------
+
+* Implemented the 'list' command.
+* Added testing framework.
+
+0.1.0 (2023-02-08)
+------------------
+
+* Implemented the 'help' and 'init' commands.
+*
+`;
+
+  const result = await parse(input);
+
+  const latest = result.get('0.2.0');
+  assert.equal(2, latest.items.length);
+  assert.equal('Implemented the \'list\' command.', latest.items[0].message);
+
+
+});
+
+test('Preface and postface', async () => {
+
+  const input = `Time for a change
+=========
+
+0.2.0 (????-??-??)
+------------------
+
+WOW another release. How good is that?
+Here's another line.
+
+* Implemented the 'list' command.
+* Added testing framework.
+
+Well, that's all folks.
+
+0.1.0 (2023-02-08)
+------------------
+
+* Implemented the 'help' and 'init' commands.
+*
+`;
+
+  debugger;
+  const result = await parse(input);
+
+  const latest = result.get('0.2.0');
+
+  assert.equal('WOW another release. How good is that? Here\'s another line.', latest.preface);
+  assert.equal('Well, that\'s all folks.', latest.postface);
+
+
+});

package/util.mjs

@@ -49,7 +49,7 @@ export async function readPackageVersion() {
  * @param {number} secondLineOffset
  * @param {number} lineLength
  */
-export function wrap(input, secondLineOffset = 0, lineLength = 80) {
+export function wrap(input, secondLineOffset = 0, lineLength = 79) {
 
   const words = input.split(' ');
   const lines = [];