chore(formatting)

Author: Magic-Man-us

.github/workflows/ci.yml

@@ -13,25 +13,25 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      
+
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: "3.11"
           cache: "pip"
-      
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install ruff black mypy
           pip install -e ".[dev]"
-      
+
       - name: Run Ruff
         run: ruff check src/ tests/
-      
+
       - name: Run Black
         run: black --check src/ tests/
-      
+
       - name: Run MyPy
         run: mypy src/
 
@@ -41,25 +41,25 @@ jobs:
     strategy:
       matrix:
         python-version: ["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 }}
           cache: "pip"
-      
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install -e ".[dev]"
-      
+
       - name: Run tests with coverage
         run: |
           pytest --cov=sitescanner --cov-report=xml --cov-report=term
-      
+
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4
         with:
@@ -71,23 +71,23 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      
+
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: "3.11"
           cache: "pip"
-      
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install bandit safety
           pip install -e .
-      
+
       - name: Run Bandit
         run: bandit -r src/ -f json -o bandit-report.json
         continue-on-error: true
-      
+
       - name: Run Safety
         run: safety check --json
         continue-on-error: true

PRE_COMMIT_SETUP.md

@@ -0,0 +1,99 @@
+# Pre-commit Setup
+
+Pre-commit hooks have been configured to automatically check code quality before each commit.
+
+## Installed Hooks
+
+The following checks run automatically on every commit:
+
+1. **Ruff** - Fast Python linter (checks and fixes issues)
+2. **Black** - Python code formatter
+3. **Mypy** - Static type checker
+4. **Pre-commit hooks** - Trailing whitespace, YAML checks, etc.
+
+## Usage
+
+### Automatic (on git commit)
+Hooks run automatically when you commit:
+```bash
+git add <files>
+git commit -m "Your message"
+# Pre-commit hooks will run automatically
+```
+
+### Manual run on all files
+```bash
+pre-commit run --all-files
+```
+
+### Manual run on staged files
+```bash
+pre-commit run
+```
+
+### Run specific hook
+```bash
+pre-commit run ruff --all-files
+pre-commit run black --all-files
+pre-commit run mypy --all-files
+```
+
+### Skip hooks (not recommended)
+```bash
+git commit --no-verify -m "Skip hooks"
+```
+
+## Individual Tool Usage
+
+### Ruff
+```bash
+# Check for issues
+ruff check src/ tests/
+
+# Fix auto-fixable issues
+ruff check --fix src/ tests/
+
+# Format code
+ruff format src/ tests/
+```
+
+### Black
+```bash
+# Check formatting
+black --check src/ tests/
+
+# Format code
+black src/ tests/
+```
+
+### Mypy
+```bash
+# Type check
+mypy src/
+
+# With ignore missing imports
+mypy src/ --ignore-missing-imports
+```
+
+## Configuration Files
+
+- `.pre-commit-config.yaml` - Pre-commit hook configuration
+- `pyproject.toml` - Contains Ruff, Black, and Mypy configurations
+
+## What Gets Checked
+
+✅ Code formatting (Black)
+✅ Import sorting (Ruff)
+✅ Linting (Ruff) - unused imports, code quality, etc.
+✅ Type hints (Mypy)
+✅ Trailing whitespace
+✅ End of file fixes
+✅ YAML/TOML syntax
+
+## Installation on New Clones
+
+If you clone this repo elsewhere:
+```bash
+source .venv/bin/activate
+pre-commit install
+```

README.md

@@ -109,10 +109,10 @@ async def main():
         max_depth=3,
         enabled_scanners=["sql_injection", "xss"],
     )
-    
+
     async with Scanner(config) as scanner:
         result = await scanner.scan()
-        
+
     print(f"Found {len(result.vulnerabilities)} vulnerabilities")
     for vuln in result.vulnerabilities:
         print(f"- {vuln.vuln_type}: {vuln.severity}")
@@ -173,7 +173,7 @@ sitescanner5000/
   run: |
     pip install sitescanner5000
     sitescanner scan ${{ secrets.TARGET_URL }} --output scan-results.json --format json
-    
+
 - name: Check for Critical Vulnerabilities
   run: |
     # Exit code 2 = critical vulnerabilities found

tests/__init__.py

@@ -1,5 +1,6 @@
 """Empty test file to satisfy initial test structure."""
 
+
 def test_placeholder():
     """Placeholder test to ensure pytest runs successfully."""
     assert True

tests/test_sql_injection.py

@@ -47,10 +47,7 @@ async def test_sql_scanner_detects_vulnerability(mock_session, vulnerable_sql_re
     mock_session.get.return_value = mock_context
 
     # Scan pages
-    vulnerabilities = await scanner.scan_pages(
-        ["https://example.com/page?id=1"],
-        mock_session
-    )
+    vulnerabilities = await scanner.scan_pages(["https://example.com/page?id=1"], mock_session)
 
     # Should detect SQL injection
     assert len(vulnerabilities) > 0
@@ -67,10 +64,7 @@ async def test_sql_scanner_no_parameters(mock_session):
     mock_response.text = AsyncMock(return_value="<html>Safe page</html>")
     mock_session.get = AsyncMock(return_value=mock_response)
 
-    vulnerabilities = await scanner.scan_pages(
-        ["https://example.com/page"],
-        mock_session
-    )
+    vulnerabilities = await scanner.scan_pages(["https://example.com/page"], mock_session)
 
     # Should return empty list (no parameters to test)
     assert len(vulnerabilities) == 0

tests/test_xss.py

@@ -49,10 +49,7 @@ async def test_xss_scanner_detects_vulnerability(mock_session, xss_reflected_res
     mock_session.get.return_value = mock_context
 
     # Scan pages
-    vulnerabilities = await scanner.scan_pages(
-        ["https://example.com/search?q=test"],
-        mock_session
-    )
+    vulnerabilities = await scanner.scan_pages(["https://example.com/search?q=test"], mock_session)
 
     # Should detect XSS
     assert len(vulnerabilities) > 0
@@ -75,10 +72,7 @@ async def test_xss_scanner_safe_page(mock_session):
     mock_context.__aexit__.return_value = None
     mock_session.get.return_value = mock_context
 
-    vulnerabilities = await scanner.scan_pages(
-        ["https://example.com/search?q=test"],
-        mock_session
-    )
+    vulnerabilities = await scanner.scan_pages(["https://example.com/search?q=test"], mock_session)
 
     # Should not detect XSS (content is properly encoded)
     assert len(vulnerabilities) == 0