@kors/generate-changelog 0.1.11

package/README.md

@@ -0,0 +1,5 @@
+## Generate changelog from git commit history
+
+```bash
+npx @kors/generate-changelog
+```

package/distribution/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/distribution/cli.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { generateChangelog } from "./lib/index.js";
+const write = process.argv[2];
+console.log(generateChangelog({ write: write ? true : false }));

package/distribution/index.d.ts

@@ -0,0 +1 @@
+export { generateChangelog } from './lib/index.js';

package/distribution/index.js

@@ -0,0 +1 @@
+export { generateChangelog } from './lib/index.js';

package/distribution/lib/index.d.ts

@@ -0,0 +1,5 @@
+export interface Options {
+    write?: boolean;
+}
+declare const generateChangelog: ({ write }: Options) => {};
+export { generateChangelog };

package/distribution/lib/index.js

@@ -0,0 +1,105 @@
+// run with `npx tsx scripts/generate-changelog.ts` or something
+import { execSync } from 'node:child_process';
+import * as fs from 'node:fs';
+const generateChangelog = ({ write }) => {
+    try {
+        // Get git log output
+        const gitLog = execSync('git log --oneline  --no-color').toString();
+        const lines = gitLog.split('\n');
+        // Initialize changelog object
+        const changelog = {
+            releases: {},
+        };
+        let currentVersion = "0.0.0";
+        const versionRegex = /^[0-9a-f]+\s+(\d+\.\d+\.\d+(?:-[a-zA-Z0-9]+(?:\.\d+)?)?)/;
+        const prNumberRegex = /#(\d+)/;
+        lines.forEach((line) => {
+            // Check if line contains a version
+            const versionMatch = line.match(versionRegex);
+            if (versionMatch?.[1]) {
+                currentVersion = versionMatch[1];
+                changelog.releases[currentVersion] = [];
+            }
+            else if (currentVersion && line.trim()) {
+                // Process commit message
+                const commitMessage = line.substring(8).trim(); // Remove commit hash
+                const prMatch = commitMessage.match(prNumberRegex);
+                let formattedMessage = commitMessage;
+                // Determine the type of change
+                let changeType = '[Fixed]';
+                if (commitMessage.toLowerCase().includes('add')) {
+                    changeType = '[Added]';
+                }
+                else if (commitMessage.toLowerCase().includes('improve')) {
+                    changeType = '[Improved]';
+                }
+                else if (commitMessage.toLowerCase().includes('remove')) {
+                    changeType = '[Removed]';
+                }
+                // Format the message similar to the example
+                if (prMatch) {
+                    formattedMessage = `${changeType} ${commitMessage} - #${prMatch[1]}`;
+                }
+                else {
+                    formattedMessage = `${changeType} ${commitMessage}`;
+                }
+                const isMergeCommit = formattedMessage.includes('Merge branch') || formattedMessage.includes('Merge pull request');
+                const isVersionBump = /^\d+\.\d+\.\d+/.test(formattedMessage);
+                if (!isMergeCommit &&
+                    !isVersionBump &&
+                    formattedMessage !== '' &&
+                    currentVersion) {
+                    if (!changelog.releases[currentVersion]) {
+                        changelog.releases[currentVersion] = [];
+                    }
+                    changelog.releases[currentVersion].push(formattedMessage);
+                }
+            }
+            else {
+                // fallback and defaults
+                console.log('fallback and defaults', line);
+            }
+        });
+        // check version and if it's still the default, rename it.
+        if (currentVersion === '0.0.0') {
+            delete Object.assign(changelog.releases, { ['changes']: changelog.releases['0.0.0'] })['0.0.0'];
+        }
+        // Sort versions using semver comparison
+        const sortedReleases = {};
+        Object.keys(changelog.releases)
+            .sort((a, b) => {
+            // Keep 'changes' at the end
+            if (a === 'changes')
+                return 1;
+            if (b === 'changes')
+                return -1;
+            // Split version strings into components and ensure numbers (default to 0)
+            const aParts = a.split('.').map(part => Number(part) || 0);
+            const bParts = b.split('.').map(part => Number(part) || 0);
+            // Compare major, minor, and patch versions
+            for (let i = 0; i < 3; i++) {
+                if (aParts[i] !== bParts[i]) {
+                    return (bParts?.[i] ?? 0) - (aParts?.[i] ?? 0);
+                }
+            }
+            return 0;
+        })
+            .forEach(key => {
+            if (changelog.releases[key]) {
+                sortedReleases[key] = changelog.releases[key];
+            }
+        });
+        changelog.releases = sortedReleases;
+        if (write) {
+            // Write changelog to file
+            fs.writeFileSync('changelog.json', JSON.stringify(changelog, null, 2));
+        }
+        console.log('Changelog has been generated successfully!');
+        return changelog;
+    }
+    catch (error) {
+        console.error('Error generating changelog:', error);
+        return {};
+    }
+};
+export { generateChangelog };

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@kors/generate-changelog",
+  "description": "Generate a changelog json from a git commit history",
+  "version": "0.1.11",
+  "type": "module",
+  "bin": {
+    "generate-changelog": "./distribution/cli.js"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc",
+    "preview": "vite preview"
+  },
+  "author": {
+    "name": "Stef Kors",
+    "email": "stef.kors+npmpackage@gmail.com",
+    "url": "https://github.com/StefKors"
+  },
+  "repository": "https://github.com/StefKors/generate-changelog",
+  "files": [
+    "distribution"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "exports": {
+    "types": "./distribution/index.d.ts",
+    "default": "./distribution/index.js"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.1",
+    "typescript": "^5.7.2",
+    "vite": "^6.0.1",
+    "vite-plugin-dts": "^4.3.0"
+  },
+  "packageManager": "npm@10.1.0",
+  "keywords": [
+    "npm",
+    "package",
+    "changelog",
+    "semver",
+    "json",
+    "versioning",
+    "release notes",
+    "version tracking",
+    "automation",
+    "software development",
+    "continuous integration",
+    "CI/CD",
+    "development tools",
+    "change tracking",
+    "release management",
+    "git",
+    "git hooks",
+    "node.js",
+    "command-line tool",
+    "open source",
+    "developer tools"
+  ]
+}