vnxt 1.9.5 → 1.14.0

package/README.md

@@ -22,42 +22,56 @@ A lightweight CLI tool for automated version bumping with changelog generation a
 
 ## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Installation
 
-### Global Installation
+### npm (all platforms)
 
-**Bash/PowerShell:**
 ```bash
 npm install -g vnxt
 ```
 
-After installation, you can use either `vnxt` or the shorter alias `vx`:
+### Scoop (Windows)
+
+```powershell
+scoop bucket add vnxt https://github.com/n-orrow/scoop-vnxt
+scoop install vnxt
+```
+
+### Chocolatey (Windows)
+
+> ⏳ Pending moderation — will be available on the Chocolatey community repository shortly.
+
+```powershell
+choco install vnxt
+```
+
+### Homebrew (macOS/Linux)
+
 ```bash
-vnxt --help
-vx --help  # Same thing, shorter!
+brew tap n-orrow/vnxt
+brew install vnxt
 ```
 
-### Local Installation (from source)
+### From Source
 
 **Bash/macOS/Linux:**
 ```bash
-# Clone the repository
 git clone https://github.com/n-orrow/vnxt.git
 cd vnxt
-
-# Install globally via npm link
 chmod +x vnxt.js
 npm link
 ```
 
 **PowerShell/Windows:**
 ```powershell
-# Clone the repository
 git clone https://github.com/n-orrow/vnxt.git
 cd vnxt
-
-# Install globally via npm link
 npm link
 ```
 
+After installation, you can use either `vnxt` or the shorter alias `vx`:
+```bash
+vx --help
+```
+
 ## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Usage
 
 ### Basic Examples
@@ -89,18 +103,19 @@ All options work with both `vnxt` and `vx`:
 ```
 -m, --message <msg>      Commit message (required unless using interactive mode)
 -t, --type <type>        Version type: patch, minor, major (auto-detected from message)
--v, --version <ver>      Set specific version (e.g., 2.0.0-beta.1)
--V, --version            Show vnxt version
--p, --push              Push to remote with tags
+-sv, --set-version <v>   Set a specific version (e.g., 2.0.0-beta.1)
+-vv, --vnxt-version      Show the installed vnxt version
+-gv, --get-version       Show the current project's version
+-p, --push               Push to remote with tags
 -dnp, --no-push          Prevent auto-push (overrides config)
---publish               Push and trigger npm publish via GitHub Actions
--c, --changelog         Update CHANGELOG.md
--d, --dry-run           Show what would happen without making changes
--a, --all [mode]        Stage files before versioning (prompts if no mode)
-                        Modes: tracked, all, interactive (i), patch (p)
--r, --release           Generate release notes file
--q, --quiet             Minimal output (errors only)
--h, --help              Show help message
+--publish                Push and trigger npm publish via GitHub Actions (implies --push)
+-c, --changelog          Update CHANGELOG.md
+-d, --dry-run            Show what would happen without making changes
+-a, --all [mode]         Stage files before versioning (prompts if no mode)
+                         Modes: tracked, all, interactive (i), patch (p)
+-r, --release            Generate release notes file (saved to release-notes/)
+-q, --quiet              Minimal output (errors only)
+-h, --help               Show help message
 ```
 
 ### Automatic Version Detection
@@ -112,7 +127,7 @@ vnxt automatically detects the version bump type from your commit message:
 - `patch:` → **patch** version bump
 - `feat:` or `feature:` → **minor** version bump
 - `fix:` → **patch** version bump
-- `BREAKING:` or contains `BREAKING` → **major** version bump
+- `BREAKING` (anywhere in message) or `breaking:` → **major** version bump
 
 You can override this with the `-t` flag.
 
@@ -144,8 +159,8 @@ Set a specific version number (useful for pre-releases):
 
 **Bash/PowerShell:**
 ```bash
-vx -v 2.0.0-beta.1 -m "beta: initial release candidate"
-vx -v 1.5.0-rc.2 -m "release candidate 2"
+vx -sv 2.0.0-beta.1 -m "beta: initial release candidate"
+vx -sv 1.5.0-rc.2 -m "release candidate 2"
 ```
 
 ### Changelog Generation
@@ -177,19 +192,25 @@ Generate a formatted release notes file:
 vx -m "feat: major feature release" -r
 ```
 
-Creates `release-notes-v1.2.0.md`:
+You'll be prompted to add optional context before the file is created. Release notes are saved to `release-notes/v1.2.0.md` (respects your `tagPrefix` config):
 ```markdown
 # Release v1.2.0
 
-Released: 2024-02-10
+Released: 2024-02-10 at 14:32:00 UTC
+Author: Your Name
 
 ## Changes
 feat: major feature release
 
 ## Installation
 npm install your-package@1.2.0
+
+## Full Changelog
+See CHANGELOG.md for complete version history.
 ```
 
+**Note:** `--publish` automatically generates release notes too, so `-r` is only needed for standalone bumps where you want the file without publishing.
+
 ### File Staging Options
 
 vnxt offers flexible file staging with the `-a` flag:
@@ -237,14 +258,28 @@ Display the installed vnxt version:
 
 **Bash/PowerShell:**
 ```bash
-vx -V
+vx -vv
+# or
+vnxt --vnxt-version
+```
+
+Output:
+```
+vnxt v1.9.3
+```
+
+Display the current project's version:
+
+**Bash/PowerShell:**
+```bash
+vx -gv
 # or
-vnxt --version
+vnxt --get-version
 ```
 
 Output:
 ```
-vnxt v1.8.0
+my-package v2.4.1
 ```
 
 ### npm Publish
@@ -257,10 +292,12 @@ vx -m "feat: new feature" --publish
 ```
 
 This will:
-1. Bump the version and commit
-2. Push with a standard `v*` tag
-3. Push an additional `publish/v*` tag
-4. GitHub Actions detects the `publish/v*` tag and publishes to npm automatically
+1. Prompt for optional release notes context
+2. Bump the version and commit
+3. Auto-generate a release notes file in `release-notes/`
+4. Push with a standard `v*` tag
+5. Push an additional `publish/v*` tag
+6. GitHub Actions detects the `publish/v*` tag and publishes to npm automatically
 
 This means you can batch up multiple changes without publishing to npm each time:
 ```bash
@@ -417,7 +454,7 @@ vx -m "feat: final feature" --publish
 
 **Bash/PowerShell:**
 ```bash
-vx -V
+vx -vv
 ```
 
 ## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Troubleshooting

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vnxt",
-  "version": "1.9.5",
+  "version": "1.14.0",
   "description": "Version incrementation CLI tool with built in git commit, push and changelog generation",
   "main": "vnxt.js",
   "bin": {

package/vnxt.js

@@ -402,7 +402,7 @@ function generateChangelog(newVersion, message) {
 // Generate Release Notes
 // =============================================================================
 
-function generateReleaseNotes(newVersion, message, context, packageJson) {
+function generateReleaseNotes(newVersion, message, context, packageJson, isPublish = false) {
     log('📋 Generating release notes...', 'cyan');
 
     const date = new Date();
@@ -412,12 +412,33 @@ function generateReleaseNotes(newVersion, message, context, packageJson) {
     let author = '';
     try { author = execSync('git config user.name', {stdio: 'pipe'}).toString().trim(); } catch {}
 
+    // If publishing, gather all commits since the last publish/v* tag
+    let changes = message;
+    if (isPublish) {
+        try {
+            const lastPublishTag = execSync(
+                'git tag --list "publish/v*" --sort=-version:refname',
+                {stdio: 'pipe'}
+            ).toString().trim().split('\n').filter(Boolean)[0];
+
+            if (lastPublishTag) {
+                const commits = execSync(
+                    `git log ${lastPublishTag}..HEAD --pretty=format:"- %s"`,
+                    {stdio: 'pipe'}
+                ).toString().trim();
+                if (commits) changes = commits;
+            }
+        } catch {
+            // Fall back to current message if git log fails
+        }
+    }
+
     const notes = `# Release ${config.tagPrefix}${newVersion}
 
 Released: ${dateShort} at ${timestamp.split(' ')[1]}${author ? `\nAuthor: ${author}` : ''}
 
 ## Changes
-${message}${context ? `\n\n## Release Notes\n${context}` : ''}
+${changes}${context ? `\n\n## Release Notes\n${context}` : ''}
 
 ## Installation
 \`\`\`bash
@@ -618,7 +639,7 @@ async function main() {
         const { oldVersion, newVersion, packageJson } = bumpVersion(opts);
 
         if (opts.generateChangelog)    generateChangelog(newVersion, opts.message);
-        if (opts.generateReleaseNotes) generateReleaseNotes(newVersion, opts.message, releaseNotesContext, packageJson);
+        if (opts.generateReleaseNotes) generateReleaseNotes(newVersion, opts.message, releaseNotesContext, packageJson, opts.publishToNpm);
         if (opts.push)                 pushToRemote(opts, newVersion);
 
         printSummary(opts, oldVersion, newVersion, branch);
@@ -629,4 +650,4 @@ async function main() {
     }
 }
 
-main();
+main();