fix: ruff lint fixes, add ruff CI step, CONTRIBUTING.md, remove BOM from config files

Author: Revenue Holdings

.github/workflows/publish.yml

@@ -32,4 +32,4 @@ jobs:
       run: twine check dist/*
 
     - name: Publish to PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
+      uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/test.yml

@@ -26,6 +26,8 @@ jobs:
           python -m pip install --upgrade pip
           pip install -e ".[dev]"
 
+      - name: Lint with ruff
+        run: pip install ruff && ruff check src/ --target-version py310
       - name: Run tests
         run: |
           python -m pytest tests/ -v --tb=short
@@ -34,3 +36,4 @@ jobs:
         run: |
           deadcode --version
           deadcode --help
+

CHANGELOG.md

@@ -0,0 +1,16 @@
+# 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.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-05-17
+
+### Added
+- Initial beta release
+- Core functionality
+- CLI interface
+- Test suite
+- CI/CD workflows with ruff lint and pytest
+- CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing
+
+Thanks for your interest in contributing!
+
+## Development Setup
+
+1. Fork and clone the repo
+2. Create a virtual environment: python -m venv .venv && source .venv/bin/activate
+3. Install dev dependencies: pip install -e ".[dev]"
+4. Run tests: pytest tests/ -v
+5. Lint: uff check src/
+
+## Pull Requests
+
+- Fork the repo and create a feature branch
+- Add tests for any new functionality
+- Ensure all existing tests pass
+- Run uff check src/ --fix before committing
+- Keep PRs focused on a single change
+
+## Reporting Issues
+
+- Use GitHub Issues
+- Include Python version, OS, and steps to reproduce
+- Include relevant error output
+
+## Code Style
+
+- Python 3.10+
+- Type hints where practical
+- Follow ruff defaults (Black-compatible formatting)
+
+## License
+
+By contributing, you agree your work will be licensed under the same license as this project.

pyproject.toml

@@ -46,3 +46,14 @@ where = ["src"]
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 python_files = ["test_*.py"]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "SIM"]
+ignore = ["E501"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["*"]

src/deadcode/cli.py

@@ -2,22 +2,21 @@
 
 from __future__ import annotations
 
+import click
 import json
 import sys
 from pathlib import Path
-from typing import Any
-
-import click
 from rich.console import Console
 from rich.table import Table
+
 try:
     from revenueholdings_license import require_license
 except ImportError:
     require_license = None
 
 from . import __version__
 from .config import DeadCodeConfig
-from .scanner import DeadCodeScanner, ScanResult, Finding
+from .scanner import DeadCodeScanner, Finding
 
 console = Console()
 err_console = Console(stderr=True)

src/deadcode/config.py

@@ -47,7 +47,7 @@ def load(cls, project_dir: str | Path) -> DeadCodeConfig:
             return cls()
 
         try:
-            with open(config_path, "r", encoding="utf-8") as f:
+            with open(config_path, encoding="utf-8") as f:
                 data = yaml.safe_load(f) or {}
         except Exception:
             return cls()

src/deadcode/scanner.py

@@ -10,12 +10,10 @@
 from __future__ import annotations
 
 import os
+import pathspec
 import re
 from dataclasses import dataclass, field
 from pathlib import Path
-from typing import Any
-
-import pathspec
 
 # ── Data structures ───────────────────────────────────────────────────
 
@@ -163,7 +161,6 @@ def scan(self) -> ScanResult:
         css_classes: dict[str, list[tuple[str, int]]] = {}  # class -> [(file, line)]
         used_css_classes: set[str] = set()
         components: dict[str, str] = {}  # ComponentName -> file
-        component_imports: set[str] = set()  # names of imported components
         routes: list[tuple[str, str]] = []  # (route_path, file)
 
         for filepath in all_files: