changelog-tool 0.5.0 → 0.6.0

package/changelog.md

@@ -1,6 +1,15 @@
 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)
 ------------------
 
@@ -8,8 +17,6 @@ Changelog
   `--minor` arguments.
 * The `add` command now uses the -m argument instead of a positional for the
   message.
-* bla
-* bla
 
 
 0.4.1 (2023-02-12)

package/changelog.mjs

@@ -38,13 +38,13 @@ export class Changelog {
    * Adds a new version to the log. Version string is automatically increased
    * from the previous one
    *
-   * @params {'patch'|'minor'|'major'} changeType
+   * @param {'patch'|'minor'|'major'} changeType
    * @returns {VersionLog}
    */
   newVersion(changeType = 'patch') {
 
     const lastVersion = this.versions[0].version;
-    const newVersion = calculateNextVersion(lastVersion);
+    const newVersion = calculateNextVersion(lastVersion, changeType);
     const versionLog = new VersionLog(newVersion);
 
     return this.add(versionLog);

package/cli.mjs

@@ -6,6 +6,7 @@ import * as url from 'node:url';
 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';
 
@@ -78,7 +79,7 @@ async function main() {
         changeType = 'major';
       }
       if (!values.message) {
-        throw new Error('The "-m" or "-message" argument is required');
+        throw new Error('The "-m" or "--message" argument is required');
       }
       await add({
         message: values.message,
@@ -238,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.5.0",
+  "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,33 +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 -m [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.
 ```
 
-### Invoking add
+### 'add' command
 
-Easiest is to just run:
+The add comment lets you add a new message at the bottom of the last unreleased
+version.
+
+To use it, just run:
 
 ```
-npx changelog add -m "Bug fix"
+changelog add -m "Bug fix"
 ```
 
-This will automatically add a line to the latest unreleased version. If there
-is no unreleased version, it will create a new patch version.
+If there is no unreleased version, it will create a new section and increase
+the version number.
 
-If the change should cause a minor or major version bump, you can specify the
-these options too:
+If the current change should result in a new major or minor version number, you
+can use the following arguments.
 
 ```
-npx changelog add --minor -m "New feature"
-npx changelog add --major -m "Backwards compatibility break"
+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,