CU-86b7kybxx - feat: add initial configuration for git hooks and CI workflow

Author: IUribeSwapps

.dev-hooks.yml

@@ -0,0 +1,12 @@
+# Dev Tools Hooks Configuration for this project, test this repo
+
+pre-push:
+  enabled: true
+  skip_branch_validation: false
+
+  commands:
+    - name: "Check CLI Help"
+      run: "venv/bin/dev-hooks --help > /dev/null"
+
+    - name: "Check CLI Version"
+      run: "venv/bin/dev-hooks --version"

.github/workflows/test.yml

@@ -0,0 +1,57 @@
+name: Tests
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .
+
+      - name: Test CLI
+        run: |
+          dev-hooks --help
+          dev-hooks --version
+
+      - name: Test installation in a git repo
+        run: |
+          git init /tmp/test-repo
+          dev-hooks install --path /tmp/test-repo
+          dev-hooks list --path /tmp/test-repo
+          dev-hooks uninstall --path /tmp/test-repo
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+
+      - name: Run linter
+        run: ruff check src/

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2024-12-10
+
+### Added
+- Initial release
+- `commit-msg` hook for Conventional Commits validation
+- `pre-commit` hook for PHPCS code quality (Drupal/WordPress)
+- `pre-push` hook for branch naming conventions
+- CLI commands: `install`, `uninstall`, `list`
+- Support for selective hook installation
+- Force overwrite option for existing hooks

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing
+
+Thanks for your interest in contributing!
+
+## Development Setup
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/your-username/dev-tools-hooks.git
+   cd dev-tools-hooks
+   ```
+
+2. Create a virtual environment:
+   ```bash
+   python3 -m venv venv
+   source venv/bin/activate
+   ```
+
+3. Install in development mode:
+   ```bash
+   pip install -e .
+   ```
+
+## Code Style
+
+- Follow PEP 8 guidelines
+- Use type hints where possible
+- Keep functions focused and small
+
+## Submitting Changes
+
+1. Create a new branch: `git checkout -b feat/your-feature`
+2. Make your changes
+3. Test locally: `dev-hooks install && dev-hooks list`
+4. Commit using conventional commits: `feat: add new feature`
+5. Push and create a Pull Request
+
+## Adding New Hooks
+
+1. Create your hook script in `hooks/`
+2. Copy it to `src/dev_tools_hooks/hooks/`
+3. Add the hook name to `AVAILABLE_HOOKS` in `installer.py`
+4. Update the `cmd_list` function in `cli.py` with a description

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Swapps
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyproject.toml

@@ -10,7 +10,7 @@ readme = "README.md"
 license = {text = "MIT"}
 requires-python = ">=3.8"
 authors = [
-    {name = "Dev Tools", email = "dev@example.com"}
+    {name = "Swapps", email = "dev@swapps.com"}
 ]
 keywords = ["git", "hooks", "conventional-commits", "phpcs", "development"]
 classifiers = [
@@ -32,8 +32,8 @@ classifiers = [
 dev-hooks = "dev_tools_hooks.cli:main"
 
 [project.urls]
-Homepage = "https://github.com/dev/dev-tools-hooks"
-Repository = "https://github.com/dev/dev-tools-hooks"
+Homepage = "https://github.com/swapps/dev-tools-hooks"
+Repository = "https://github.com/swapps/dev-tools-hooks"
 
 [tool.setuptools.packages.find]
 where = ["src"]

src/dev_tools_hooks/__init__.py

@@ -8,7 +8,7 @@
 """
 
 __version__ = "1.0.0"
-__author__ = "Dev Tools"
+__author__ = "Swapps"
 
 from .installer import install_hooks, uninstall_hooks