feat(ref: no-ref): pre-commit msg

Author: andriikamaldinov1

.github/hooks/commit-msg

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+set -e
+
+commit_msg=$(cat .git/COMMIT_EDITMSG)
+echo "$commit_msg" | dart run commitlint_cli --edit "$1"

.github/hooks/pre-commit

@@ -0,0 +1,85 @@
+# To avoid running this pre-commit simply write your commit like:
+# git commit -m "test commit" --no-verify
+# with the --no-verify flag being the operative addition
+
+printf "\e[33;1m%s\e[0m\n" 'Pre-Commit'
+
+# Undo the stash of the files
+pop_stash_files () {
+	if [ -n "$hasChanges" ]; then
+		printf "\e[33;1m%s\e[0m\n" '=== Applying git stash changes ==='
+		git stash pop
+	fi
+}
+
+# Stash unstaged files
+hasChanges=$(git diff)
+if [ -n "$hasChanges" ]; then
+	printf "\e[33;1m%s\e[0m\n" 'Stashing unstaged changes'
+	git stash push --keep-index
+fi
+
+# Flutter import sorter
+printf "\e[33;1m%s\e[0m\n" '=== Running Dart import sorter ==='
+dart run import_sorter:main
+hasNewFilesSorted=$(git diff)
+if [ -n "$hasNewFilesSorted" ]; then
+	git add .
+	printf "\e[33;1m%s\e[0m\n" 'Sorted imports added to git stage'
+fi
+printf "\e[33;1m%s\e[0m\n" 'Finished running Flutter import sorter'
+printf '%s\n' "${avar}"
+
+# Dart fix
+printf "\e[33;1m%s\e[0m\n" '=== Running Dart fix ==='
+dart fix --apply
+hasNewFilesFixed=$(git diff)
+if [ -n "$hasNewFilesFixed" ]; then
+	git add .
+	printf "\e[33;1m%s\e[0m\n" 'Dart fix files added to git stage'
+fi
+printf "\e[33;1m%s\e[0m\n" 'Finished running Dart fix'
+printf '%s\n' "${avar}"
+
+# Dart formatter
+printf "\e[33;1m%s\e[0m\n" '=== Running Dart formatter ==='
+dart format .
+
+hasNewFilesFormatted=$(git diff)
+if [ -n "$hasNewFilesFormatted" ]; then
+	git add .
+	printf "\e[33;1m%s\e[0m\n" 'Formatted files added to git stage'
+fi
+printf "\e[33;1m%s\e[0m\n" 'Finished running Dart Formatter'
+printf '%s\n' "${avar}"
+
+# Flutter Analyzer
+printf "\e[33;1m%s\e[0m\n" '=== Running Flutter analyzer ==='
+flutter analyze
+
+if [ $? -ne 0 ]; then
+	printf "\e[31;1m%s\e[0m\n" '=== Flutter analyzer error ==='
+	pop_stash_files
+	exit 1
+fi
+
+printf "\e[33;1m%s\e[0m\n" 'Finished running Flutter analyzer'
+printf '%s\n' "${avar}"
+
+
+# Unit tests
+printf "\e[33;1m%s\e[0m\n" '=== Running Unit Tests ==='
+flutter test -r expanded
+
+if [ $? -ne 0 ]; then
+	printf "\e[31;1m%s\e[0m\n" '=== Unit tests error ==='
+	pop_stash_files
+	exit 1
+fi
+
+printf "\e[33;1m%s\e[0m\n" 'Finished running Unit Tests'
+printf '%s\n' "${avar}"
+
+pop_stash_files
+
+printf "\e[33;1m%s\e[0m\n" 'Finished all tasks'

.github/scripts/setup_hooks.sh

@@ -0,0 +1,45 @@
+#!/bin/bash
+
+# Define the directory containing sample hooks
+SAMPLE_HOOKS_DIR=".github/hooks"
+
+# Define the target directory for Git hooks
+GIT_HOOKS_DIR=".git/hooks"
+
+# Function to copy or replace hooks
+copy_or_replace_hooks() {
+    for hook in "$SAMPLE_HOOKS_DIR"/*; do
+        hook_name=$(basename "$hook")
+        target_hook="$GIT_HOOKS_DIR/"
+        if [ -f "$target_hook" ]; then
+            echo "Replacing existing hook: $hook_name"
+        else
+            echo "Copying new hook: $hook_name"
+        fi
+        if [ -L "$target_hook$hook_name" ]; then
+            rm -r $target_hook$hook_name
+        fi
+
+        cp $hook $target_hook
+        chmod +x $target_hook$hook_name  # Ensure executable permission is set
+    done
+
+    git config --unset core.hooksPath
+}
+
+# Main function
+main() {
+    # Check if .git/hooks directory exists
+    if [ ! -d "$GIT_HOOKS_DIR" ]; then
+        echo "Error: .git/hooks directory not found. Are you in a Git repository?"
+        exit 1
+    fi
+
+    # Copy or replace hooks
+    copy_or_replace_hooks
+
+    echo "Git hooks setup complete."
+}
+
+# Run the main function
+main

commitlint.yaml

@@ -0,0 +1,9 @@
+include: package:commitlint_cli/commitlint.yaml
+
+rules:
+  scope-empty:
+    - 2
+    - never
+  scope-enum:
+    - 0
+    - never

pubspec.lock

@@ -30,6 +30,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "0.11.3"
+  ansi:
+    dependency: transitive
+    description:
+      name: ansi
+      sha256: "070af96189f9da6f996cee46049682bdcd1d191b483e13f9d2a2600729d8b2a1"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.4.2"
   args:
     dependency: transitive
     description:
@@ -54,6 +62,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "2.1.1"
+  change_case:
+    dependency: transitive
+    description:
+      name: change_case
+      sha256: f4e08feaa845e75e4f5ad2b0e15f24813d7ea6c27e7b78252f0c17f752cf1157
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.1.0"
   characters:
     dependency: transitive
     description:
@@ -102,6 +118,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.19.0"
+  commitlint_cli:
+    dependency: "direct dev"
+    description:
+      name: commitlint_cli
+      sha256: "7882210129f2616d4899ad85073a75ef293deac693dd6f7dc4f0492b0758322b"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.8.1"
   convert:
     dependency: transitive
     description:
@@ -462,6 +486,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "2.1.4"
+  verbose:
+    dependency: transitive
+    description:
+      name: verbose
+      sha256: "8e63580e35d58a15e4fca702fe91766430b1d28738c160c466e5cb10c373002a"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.1.1"
   vm_service:
     dependency: transitive
     description:

pubspec.yaml

@@ -18,6 +18,7 @@ dev_dependencies:
     sdk: flutter
   flutter_lints: ^2.0.0
   lint: ^2.3.0
+  commitlint_cli: ^0.8.1
   jsdaddy_custom_lints:
     git:
       url: https://github.com/JsDaddy/dart-linter-rules