build: add commitlint and husky for commit message validation

- Add package.json with commitlint and husky dependencies
- Configure commitlint with conventional commit rules
- Set up git hook to validate commit messages before creation
- Update .gitignore for Node.js files
- Update CONTRIBUTING.md and README.md with setup instructions

Author: bordeux

.commitlintrc.json

@@ -0,0 +1,27 @@
+{
+  "extends": ["@commitlint/config-conventional"],
+  "rules": {
+    "type-enum": [
+      2,
+      "always",
+      [
+        "feat",
+        "fix",
+        "docs",
+        "style",
+        "refactor",
+        "perf",
+        "test",
+        "build",
+        "ci",
+        "chore",
+        "revert"
+      ]
+    ],
+    "type-case": [2, "always", "lower-case"],
+    "type-empty": [2, "never"],
+    "subject-empty": [2, "never"],
+    "subject-case": [0],
+    "header-max-length": [2, "always", 100]
+  }
+}

.gitignore

@@ -86,3 +86,10 @@ cobertura.xml
 
 # Generated by tests
 /tmp/
+
+# Node.js (commitlint, semantic-release)
+node_modules/
+package-lock.json
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit ${1}

CONTRIBUTING.md

@@ -21,6 +21,7 @@ This project adheres to a code of conduct. By participating, you are expected to
 ### Prerequisites
 
 - Rust 1.70 or higher ([Install Rust](https://rustup.rs/))
+- Node.js 18 or higher ([Install Node.js](https://nodejs.org/)) - for commit validation
 - cargo-make (optional but recommended): `cargo install --force cargo-make`
 
 ### Setup
@@ -35,7 +36,15 @@ This project adheres to a code of conduct. By participating, you are expected to
    ```bash
    git remote add upstream https://github.com/ORIGINAL_OWNER/tmpltool.git
    ```
-4. Create a new branch:
+4. Install Node.js dependencies (for commit validation):
+   ```bash
+   npm install
+   ```
+   This will:
+   - Install commitlint and husky
+   - Set up git hooks to validate commit messages
+   - Prevent commits that don't follow conventional commit format
+5. Create a new branch:
    ```bash
    git checkout -b feature/my-feature
    ```
@@ -77,6 +86,21 @@ cargo make test-examples
 
 This project uses [Conventional Commits](https://www.conventionalcommits.org/) for automated versioning and changelog generation.
 
+**Important:** Commit messages are automatically validated using commitlint. Invalid commits will be rejected before they're created.
+
+### Commit Validation
+
+When you try to commit, a git hook will automatically check your commit message format. If it doesn't follow the conventional commit format, you'll see an error like:
+
+```
+⧗   input: bad commit message
+✖   type must be one of [feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert] [type-enum]
+✖   found 1 problems, 0 warnings
+husky - commit-msg hook exited with code 1 (error)
+```
+
+To fix this, make sure your commit message follows the format below.
+
 ### Commit Message Format
 
 ```
@@ -279,6 +303,34 @@ Releases are automated using semantic-release:
    - Creates GitHub release
    - Publishes Docker image
 
+## Troubleshooting
+
+### Commit Validation Not Working
+
+If commit validation isn't working:
+
+1. Make sure you ran `npm install` after cloning the repository
+2. Check that `.husky/commit-msg` exists and is executable
+3. Reinstall hooks: `npm run prepare`
+
+### Bypassing Commit Validation (NOT Recommended)
+
+In rare cases, you may need to bypass validation (e.g., fixing a broken commit history):
+
+```bash
+git commit --no-verify -m "your message"
+```
+
+**Warning:** Only use `--no-verify` when absolutely necessary, as it will bypass the commit validation.
+
+### Testing Commit Messages
+
+You can test a commit message without making a commit:
+
+```bash
+echo "feat: add new feature" | npx commitlint
+```
+
 ## Questions?
 
 If you have questions, please:

README.md

@@ -984,9 +984,17 @@ For detailed contribution guidelines, including commit conventions, development
 ### Quick Start
 
 1. Fork the repository
-2. Create a feature branch (`git checkout -b feature/amazing-feature`)
-3. Make your changes
-4. Run tests and QA checks (`cargo make qa`)
-5. Commit using [conventional commits](#commit-convention)
-6. Push to your fork
-7. Open a Pull Request
+2. Clone your fork and install dependencies:
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/tmpltool.git
+   cd tmpltool
+   npm install  # Installs commit validation hooks
+   ```
+3. Create a feature branch (`git checkout -b feature/amazing-feature`)
+4. Make your changes
+5. Run tests and QA checks (`cargo make qa`)
+6. Commit using [conventional commits](#commit-convention) - invalid commits will be automatically rejected
+7. Push to your fork
+8. Open a Pull Request
+
+**Note:** Commit messages are automatically validated. If your commit is rejected, make sure it follows the [conventional commit format](#commit-convention).

package.json

@@ -0,0 +1,34 @@
+{
+  "name": "tmpltool",
+  "version": "0.0.0-development",
+  "description": "Fast and simple command-line template rendering tool using Tera templates",
+  "private": true,
+  "scripts": {
+    "prepare": "husky install",
+    "test:commit": "commitlint --from=HEAD~1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bordeux/tmpltool.git"
+  },
+  "keywords": [
+    "template",
+    "tera",
+    "cli",
+    "rust"
+  ],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@commitlint/cli": "^18.4.3",
+    "@commitlint/config-conventional": "^18.4.3",
+    "husky": "^8.0.3"
+  },
+  "dependencies": {
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/exec": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "conventional-changelog-conventionalcommits": "^7.0.2",
+    "semantic-release": "^23.0.0"
+  }
+}