✨ feat: add pre-commit hook config (#199)

Co-authored-by: welpo <welpo@users.noreply.github.com>

.pre-commit-hooks.yaml

@@ -0,0 +1,7 @@
+-   id: git-sumi
+    name: Lint commit message with git-sumi
+    description: Lints each new commit with git-sumi based on the configured project rules in your sumi.toml
+    entry: git-sumi --file
+    language: rust
+    pass_filenames: false
+    stages: [commit-msg]

.release-hooks/pre-release

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+# Pre-release hook for the release script: https://github.com/welpo/release
+VERSION_TAG="$1"
+VERSION="${VERSION_TAG#v}"  # Remove the 'v' prefix.
+WEBSITE_DOCS_PATH='website/docs/integration.md'
+
+# Update latest version in pre-commit hook docs.
+# -i: edit file in place
+# -pe: print and execute perl command
+perl -i -pe 's/(rev: v)\K[\d.]+(?=\s+#)/'$VERSION'/g' "$WEBSITE_DOCS_PATH"
+
+echo "Updated version in $WEBSITE_DOCS_PATH to:"
+grep "rev: v" "$WEBSITE_DOCS_PATH" || {
+    echo "Error: Version update failed"
+    exit 1
+}

website/docs/index.md

@@ -75,6 +75,10 @@ git sumi -c '🎨 refactor: format JS with Prettier'
 
 If your message passes all rules, it will be committed. Otherwise, you'll see what went wrong.
 
+:::tip
+Do you use the [pre-commit](https://pre-commit.com/#intro) package manager? Check out the [integration guide](/docs/integration/#using-pre-commit) to add git-**sumi** to your pre-commit configuration.
+:::
+
 ## Contributing
 
 Please do! We appreciate bug reports, improvements to documentation (however minor), feature requests, code contributions… To get started, take a look at the [contributing guidelines](https://github.com/welpo/git-sumi/blob/main/CONTRIBUTING.md).

website/docs/integration.md

@@ -4,6 +4,18 @@ sidebar_position: 6
 
 # Integration
 
+## Using pre-commit
+
+To integrate git-**sumi** with [pre-commit](https://pre-commit.com/#intro), add the following hook to your pre-commit config:
+
+```yaml title=".pre-commit-config.yaml" showLineNumbers
+repos:
+  - repo: https://github.com/welpo/git-sumi
+    rev: v0.0.9  # check latest version: https://github.com/welpo/git-sumi/tags
+    hooks:
+      - id: git-sumi
+```
+
 ## Local linting with Git hooks
 
 :::tip