feat: Refactored the source to TypeScript

- The source is now strongly typed TypeScript
- We support both ESM and CJS user config files now
- Fixed a bug with include_commit_body which always overrode the user config file's value
- Switched from npm to pnpm
- Switched from ncc to esbuild
- Updated all dependencies
- Improved the indenting of commit body text: now all lines are indented, not just the first one
- Replaced deprecated substr with substring

Author: kevinrenskers

.eslintrc.js

@@ -11,13 +11,13 @@ jobs:
 
     steps:
       - name: Checkout locally
-        uses: actions/checkout@v2
+        uses: actions/checkout@v6
         if: ${{ env.ACT }}
         with:
           path: "tag-changelog"
 
       - name: Checkout GitHub
-        uses: actions/checkout@v2
+        uses: actions/checkout@v6
         if: ${{ !env.ACT }}
 
       - name: Create latest tag
@@ -35,13 +35,14 @@ jobs:
         uses: ./
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+          include_commit_body: true
           exclude_types: other,doc,chore,build
 
       - name: Create release
         uses: softprops/action-gh-release@v2
         if: ${{ !env.ACT }}
         with:
-          tag_name: ${{ github.ref }}
-          name: Release ${{ github.ref }}
+          tag_name: ${{ github.ref_name }}
+          name: Release ${{ github.ref_name }}
           body: ${{ steps.changelog.outputs.changes }}
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/run.yml

@@ -1,2 +1,3 @@
 node_modules/
 .secrets
+.claude

.gitignore

@@ -0,0 +1,38 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+tag-changelog is a GitHub Action that generates changelogs from conventional commits between git tags. It parses commit messages, groups them by type, and outputs formatted changelog text. It runs on Node 20. Source is TypeScript with ESM imports, bundled to a single file via esbuild.
+
+## Commands
+
+- `pnpm test` — run Mocha tests (`test/*.spec.ts`)
+- `pnpm check` — lint and auto-fix with ESLint + Prettier, then type-check with `tsc --noEmit`
+- `pnpm package` — check then bundle `src/index.ts` → `dist/index.js` via esbuild
+- `pnpm act` — package and test locally with `act` (GitHub Actions local runner)
+
+Run a single test file: `pnpm mocha --require tsx test/parseCommitMessage.spec.ts`
+
+## Architecture
+
+All source is in `src/` (TypeScript), tests in `test/`, bundled output in `dist/`. Shared type definitions are in `src/types.ts`.
+
+**`src/index.ts`** — Action entry point. Reads GitHub Action inputs (`token`, `exclude_types`, `include_commit_body`, `config_file`), fetches tags and commits via GitHub API, processes commits through the pipeline, and sets two outputs: `changelog` (with version header) and `changes` (without header).
+
+**Processing pipeline:**
+
+1. `parseCommitMessage.ts` — Parses conventional commit format using `@conventional-commits/parser`. Extracts type, scope, subject, body, breaking change notes, and PR number (`#123` pattern). Non-conventional commits fall back to type "other".
+2. `groupByType.ts` — Groups parsed commits by type into an ordered array, sorted by the type order defined in config.
+3. `generateChangelog.ts` — Filters excluded types, renders each type section and breaking change notes using config render functions, wraps with version header.
+4. `translateType.ts` — Maps commit type strings (e.g., "feat") to human-readable labels (e.g., "New Features") using config.
+
+**`src/defaultConfig.ts`** — Default configuration defining type groups/labels, render functions (`renderTypeSection`, `renderNotes`, `renderChangelog`), and options (`excludeTypes`, `includeCommitBody`). Users can provide a custom JS config file that gets merged via `Object.assign`.
+
+## Key Details
+
+- `dist/index.js` is the bundled artifact that GitHub Actions runs. It must be rebuilt (`pnpm package`) after any `src/` changes and committed.
+- Code style: Prettier with 140 char print width, avoid arrow parens, ES5 trailing commas. ESLint with typescript-eslint enforces no-var, prefer-const, eqeqeq.
+- Tests use Node's built-in `assert` with Mocha (via `tsx` loader) — no assertion library needed.
+- Only `src/` modules (not `index.ts`) have test coverage; `index.ts` is integration-level (GitHub API calls).

CLAUDE.md

@@ -24,7 +24,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@latest
+        uses: actions/checkout@v6
 
       - name: Create changelog text
         id: changelog
@@ -36,8 +36,8 @@ jobs:
       - name: Create release
         uses: softprops/action-gh-release@v2
         with:
-          tag_name: ${{ github.ref }}
-          name: Release ${{ github.ref }}
+          tag_name: ${{ github.ref_name }}
+          name: Release ${{ github.ref_name }}
           body: ${{ steps.changelog.outputs.changes }}
           token: ${{ secrets.GITHUB_TOKEN }}
 ```
@@ -64,12 +64,12 @@ jobs:
     config_file: .github/tag-changelog-config.js
 ```
 
-The config file can be used to map commit types to changelog labels, to override the rendering of changelog sections, and the rendering of the overall changelog. You only need to override the things you want to override. For example, you can leave out `renderTypeSection` and `renderChangelog` and only include the `types` config; the [default config](https://github.com/loopwerk/tag-changelog/blob/main/src/defaultConfig.js) will be used for whatever is not overriden.
+The config file can be used to map commit types to changelog labels, to override the rendering of changelog sections, and the rendering of the overall changelog. You only need to override the things you want to override. For example, you can leave out `renderTypeSection` and `renderChangelog` and only include the `types` config; the [default config](https://github.com/loopwerk/tag-changelog/blob/main/src/defaultConfig.ts) will be used for whatever is not overriden.
 
 ### Example config file:
 
 ```javascript
-module.exports = {
+export default {
   types: [
     { types: ["feat", "feature"], label: "🎉 New Features" },
     { types: ["fix", "bugfix"], label: "🐛 Bugfixes" },
@@ -86,7 +86,7 @@ module.exports = {
 
   excludeTypes: ["other"],
 
-  renderTypeSection: function (label, commits) {
+  renderTypeSection(label, commits) {
     let text = `\n## ${label}\n`;
 
     commits.forEach(commit => {
@@ -99,9 +99,9 @@ module.exports = {
     return text;
   },
 
-  renderChangelog: function (release, changes) {
+  renderChangelog(release, changes) {
     const now = new Date();
-    return `# ${release} - ${now.toISOString().substr(0, 10)}\n` + changes + "\n\n";
+    return `# ${release} - ${now.toISOString().substring(0, 10)}\n` + changes + "\n\n";
   },
 };
 ```
@@ -140,4 +140,4 @@ Thanks to [Helmisek/conventional-changelog-generator](https://github.com/Helmise
 
 ## Support
 
-Commercial support is available via [Loopwerk](https://www.loopwerk.io/open-source/support/).
+Commercial support is available via [Loopwerk](https://www.loopwerk.io/open-source/support/).

README.md

@@ -14,9 +14,8 @@ inputs:
   include_commit_body:
     description: Whether to include the commit body in the changelog
     required: false
-    default: "false"
   config_file:
-    description: Location of the config JSON file
+    description: Location of the config JS file
     required: false
 outputs:
   changelog: