changelog-tool - npm Package Compare versions

Comparing version 0.5.0 to 0.6.0

changelog.md

 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)
@@ -11,4 +20,2 @@ ------------------
   message.
-* bla
-* bla
 
@@ -15,0 +22,0 @@

package.json

 {
   "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"
   },
@@ -9,0 +11,0 @@ "keywords": [

readme.md

@@ -29,3 +29,3 @@ Changelog tool
 ```sh
-npm install changelog-tool --save-dev
+npm install changelog-tool --global
 ```
@@ -40,28 +40,31 @@
 ```
-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"
 ```
@@ -71,1 +74,20 @@
 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.

tsconfig.json

@@ -10,3 +10,2 @@ {
     "moduleResolution": "node",
-    "resolveJsonModule": true,
      
@@ -13,0 +12,0 @@ "noEmit": true,

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21121

increased by4.83%

Lines of code

575

increased by1.05%

Number of lines in readme file

91

increased by31.88%

Is type module

Yes

No dependency changes