changelog-tool 0.4.1 → 0.6.0

package/changelog.md

@@ -1,6 +1,24 @@
 Changelog
 =========
 
+0.6.0 (2023-02-14)
+------------------
+
+* The release command now automatically calls "npm version" if a package.json
+  was found in the project directory
+* Bug fix: the --major and --minor arguments were ignored when using "add" to
+  create a new version log
+
+
+0.5.0 (2023-02-12)
+------------------
+
+* Support changing the version to the next major/minor using the `--major` and
+  `--minor` arguments.
+* The `add` command now uses the -m argument instead of a positional for the
+  message.
+
+
 0.4.1 (2023-02-12)
 ------------------
 

package/changelog.mjs

@@ -1,4 +1,4 @@
-import { wrap } from './util.mjs';
+import { calculateNextVersion, wrap } from './util.mjs';
 
 // @ts-check
 export class Changelog {
@@ -38,21 +38,14 @@ export class Changelog {
    * Adds a new version to the log. Version string is automatically increased
    * from the previous one
    *
+   * @param {'patch'|'minor'|'major'} changeType
    * @returns {VersionLog}
    */
-  newVersion() {
+  newVersion(changeType = 'patch') {
 
-    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);
+    const lastVersion = this.versions[0].version;
+    const newVersion = calculateNextVersion(lastVersion, changeType);
+    const versionLog = new VersionLog(newVersion);
 
     return this.add(versionLog);
 

package/cli.mjs

@@ -3,9 +3,10 @@
 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 { readPackageVersion, exists, calculateNextVersion } from './util.mjs';
 import { Changelog, VersionLog, LogItem } from './changelog.mjs';
 import { parseFile } from './parse.mjs';
+import { execSync } from 'node:child_process';
 
 const filename = 'changelog.md';
 
@@ -31,6 +32,23 @@ async function main() {
         default: false,
         description: 'Show all versions',
       },
+      message: {
+        type: 'string',
+        description: 'Changelog message',
+        short: 'm'
+      },
+      patch: {
+        type: 'boolean',
+        description: 'Indicates that the current change is a patch-level change.',
+      },
+      minor: {
+        type: 'boolean',
+        description: 'Indicates that the current change is a minor change.',
+      },
+      major: {
+        type: 'boolean',
+        description: 'Indicates that the current change is a major change.',
+      },
     },
     allowPositionals: true,
   });
@@ -52,10 +70,21 @@ async function main() {
       await init();
       break;
     case 'add' :
-      if (positionals.length < 2) {
-        throw new Error('The "message" argument must be specified with the "add" command');
+      /** @type {'major' | 'minor' | 'patch'} */
+      let changeType = 'patch';
+      if (values.minor) {
+        changeType = 'minor';
       }
-      await add(positionals.slice(1).join(' '));
+      if (values.major) {
+        changeType = 'major';
+      }
+      if (!values.message) {
+        throw new Error('The "-m" or "--message" argument is required');
+      }
+      await add({
+        message: values.message,
+        changeType,
+      });
       break;
     case 'release' :
       await release();
@@ -92,13 +121,13 @@ 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.
+  changelog init             - Create a new, empty changelog.
+  changelog add -m [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.
@@ -170,16 +199,28 @@ async function format() {
 }
 
 /**
- * @param {string} message
+ * @param {Object} options
+ * @param {string} options.message
+ * @param {'patch'|'major'|'minor'} options.changeType
  */
-async function add(message) {
+async function add({message, changeType}) {
   const changelog = await parseChangelog();
 
   let lastVersion = changelog.versions[0];
   if (lastVersion.date) {
-    lastVersion = changelog.newVersion();
+    lastVersion = changelog.newVersion(changeType);
     console.log('Creating new version: %s', lastVersion.version);
+  } else {
+    if (changeType === 'minor' || changeType === 'major') {
+      const previousVersion = changelog.versions[1];
+      const updatedVersionStr = calculateNextVersion(previousVersion.version, changeType);
+      if (updatedVersionStr !== lastVersion.version) {
+        console.log('Updating unreleased version from %s to %s', lastVersion.version, updatedVersionStr);
+        lastVersion.version = updatedVersionStr;
+      }
+    }
   }
+
   lastVersion.add(message);
 
   await fs.writeFile(filename, changelog.toString());
@@ -198,6 +239,12 @@ async function release() {
   await fs.writeFile(filename, changelog.toString());
   console.log(`${changelog.versions.length} changelogs saved to ${filename}`);
 
+  if (await exists('package.json')) {
+    const command = `npm version "${lastVersion.version}" --no-git-tag-version`;
+    console.log(command);
+    execSync(command);
+  }
+
 }
 
 /**

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "changelog-tool",
-  "version": "0.4.1",
+  "version": "0.6.0",
   "description": "A CLI tool for manipulating changelogs",
+  "type": "module",
   "main": "index.mjs",
   "scripts": {
-    "test": "node --test"
+    "test": "node --test",
+    "watch": "tsc --watch"
   },
   "keywords": [
     "changelog",

package/readme.md

@@ -26,7 +26,7 @@ Installation
 ------------
 
 ```sh
-npm install changelog-tool --save-dev
+npm install changelog-tool --global
 ```
 
 CLI
@@ -36,13 +36,55 @@ 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.
+changelog init             - Create a new, empty npx changelog.
+changelog add -m [message] - Adds a new line to the npx changelog.
+changelog release          - Marks the current npx changelog as released.
+changelog show             - Show the last npx changelog.
+changelog show [version]   - Show the npx changelog of a specific version.
+changelog list             - List all versions in the npx changelog.
+changelog format           - Reformats the npx changelog in the standard format.
 ```
 
-Feature requests and bug reports are welcome.
+### 'add' command
+
+The add comment lets you add a new message at the bottom of the last unreleased
+version.
+
+To use it, just run:
+
+```
+changelog add -m "Bug fix"
+```
+
+If there is no unreleased version, it will create a new section and increase
+the version number.
+
+If the current change should result in a new major or minor version number, you
+can use the following arguments.
+
+```
+changelog add --minor -m "New feature"
+changelog add --major -m "Backwards compatibility break"
+```
+
+These settings will automatically adjust the version string of the most recent
+unreleased version.
+
+### 'release' command
+
+The release command will look for a recent unreleased version in the changelog
+(where the date is marked `????-??-??`) and change it to the current date:
+
+```
+changelog release
+```
+
+If the tool detects a `package.json` file in the current directory, it will
+also call:
+
+```
+npm version [version] --no-git-tag-version
+```
+
+This command adjust the `version` field in `package.json` to match the latest
+changelog version.

package/test/parse.mjs

@@ -1,3 +1,4 @@
+// @ts-check
 import { test } from 'node:test';
 import { parse } from '../parse.mjs';
 import * as assert from 'node:assert';

package/tsconfig.json

@@ -7,7 +7,6 @@
     "checkJs": true,
 
     "moduleResolution": "node",
-    "resolveJsonModule": true,
      
     "noEmit": true,
     "strict": true,

package/util.mjs

@@ -62,7 +62,7 @@ export function wrap(input, secondLineOffset = 0, lineLength = 79) {
     }
 
     const maxLength = lines.length > 1 ? lineLength - secondLineOffset : lineLength;
-    
+
     const potentialNewLine = [lines.at(-1),word].join(' ');
     if (potentialNewLine.length>maxLength) {
       lines.push(word);
@@ -74,3 +74,37 @@ export function wrap(input, secondLineOffset = 0, lineLength = 79) {
   return lines.join('\n' + ' '.repeat(secondLineOffset));
 
 }
+
+/**
+ * @param {string} prevVersion
+ * @param {'patch'|'minor'|'major'} changeType
+ * @returns {string}
+ */
+export function calculateNextVersion(prevVersion, changeType = 'patch') {
+
+  // This function only currently understands 1 format, but this may change
+  // in the future.
+  if (!prevVersion.match(/^[0-9]+\.[0-9]+\.[0-9]+$/)) {
+    throw new Error(`Could not automatically determine the next ${changeType} version from ${prevVersion}. You might want to request a new feature to support this`);
+  }
+
+  const parts = prevVersion.split('.').map( part => +part);
+
+  switch(changeType) {
+    case 'major' :
+      parts[0]++;
+      parts[1]=0;
+      parts[2]=0;
+      break;
+    case 'minor' :
+      parts[1]++;
+      parts[2]=0;
+      break;
+    case 'patch' :
+      parts[2]++;
+      break;
+  }
+
+  return parts.join('.');
+
+}