behave-lint 1.0.0__tar.gz

behave_lint-1.0.0/.gitignore

@@ -0,0 +1,65 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.egg
+*.egg-info/
+dist/
+build/
+wheels/
+*.whl
+MANIFEST
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Testing
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+.tox/
+
+# Mypy
+.mypy_cache/
+.dmypy.json
+
+# Ruff
+.ruff_cache/
+
+# Cache (behave-lint runtime)
+.cache/
+behave_lint_cache/
+
+# Benchmarks
+benchmarks/projects/
+benchmarks/results/
+
+# MkDocs
+site/
+
+# OS
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+$RECYCLE.BIN/
+
+# Temporary
+*.tmp
+*.bak
+*.log
+
+# Reference documents (internal design specs, not published)
+ref/

behave_lint-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 behave-lint contributors
+
+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.

behave_lint-1.0.0/PKG-INFO

@@ -0,0 +1,284 @@
+Metadata-Version: 2.4
+Name: behave-lint
+Version: 1.0.0
+Summary: A fast, opinionated, extensible linter for Gherkin .feature files and Behave test suites.
+Project-URL: Homepage, https://github.com/MathiasPaulenko/behave-lint
+Project-URL: Documentation, https://mathiaspaulenko.github.io/behave-lint/
+Project-URL: Repository, https://github.com/MathiasPaulenko/behave-lint
+Project-URL: Issues, https://github.com/MathiasPaulenko/behave-lint/issues
+Project-URL: Changelog, https://github.com/MathiasPaulenko/behave-lint/blob/main/docs/CHANGELOG.md
+Author: Mathias Paulenko, behave-lint contributors
+License-Expression: MIT
+License-File: LICENSE
+Keywords: auto-fix,bdd,behave,ci-cd,code-quality,cucumber,feature-files,gherkin,lint,linter,sarif,static-analysis
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: behave-model<2,>=1.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pre-commit>=3.7; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest-xdist>=3.5; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
+Requires-Dist: mkdocs>=1.6; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.25; extra == 'docs'
+Requires-Dist: pymdown-extensions>=10.7; extra == 'docs'
+Provides-Extra: release
+Requires-Dist: hatchling>=1.21; extra == 'release'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=5.0; extra == 'test'
+Requires-Dist: pytest-xdist>=3.5; extra == 'test'
+Requires-Dist: pytest>=8.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# behave-lint
+
+[![CI](https://github.com/MathiasPaulenko/behave-lint/actions/workflows/ci.yml/badge.svg)](https://github.com/MathiasPaulenko/behave-lint/actions/workflows/ci.yml)
+[![Python](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: Ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://docs.astral.sh/ruff/)
+
+> A fast, opinionated, extensible linter for Gherkin `.feature` files and Behave test suites.
+
+**behave-lint** statically analyzes your Gherkin feature files for
+correctness, consistency, complexity, and style — without executing a
+single test. It ships with **31 built-in rules** across 6 categories,
+supports **auto-fix** for common violations, and outputs in **5 formats**
+including SARIF for GitHub Code Scanning.
+
+## Why behave-lint?
+
+| Without behave-lint | With behave-lint |
+|---|---|
+| Duplicate step definitions cause silent match failures | **BD001** detects duplicates at lint time |
+| Inconsistent tag casing breaks CI filters | **BS001** auto-fixes to `snake_case` |
+| Trailing punctuation in steps clutters reports | **BD005** strips it automatically |
+| No Given-When-Then ordering enforcement | **BC001** catches structural violations |
+| Feature files grow unchecked in complexity | **BX001-BX005** enforce limits |
+
+## Installation
+
+```bash
+pip install behave-lint
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add behave-lint
+```
+
+## Quick start
+
+```bash
+# Lint all feature files
+behave-lint features/
+
+# Apply safe auto-fixes
+behave-lint features/ --fix
+
+# JSON output for CI integration
+behave-lint features/ --json --output-file report.json
+
+# SARIF for GitHub Code Scanning
+behave-lint features/ --sarif --output-file results.sarif
+
+# List all available rules
+behave-lint --list-rules
+
+# Explain a specific rule
+behave-lint --explain BC001
+```
+
+## Features
+
+- **31 built-in rules** across 6 categories: correctness, step
+  definitions, consistency, complexity, style, and pedantic.
+- **Auto-fix** — safe, deterministic fixes for common violations
+  (`--fix`). Unsafe fixes require `--unsafe-fixes`.
+- **5 output formats** — console (colored), JSON, SARIF, Markdown, and
+  GitHub Actions inline annotations.
+- **Zero-config** — sensible defaults work out of the box. Override
+  anything via `[tool.behave-lint]` in `pyproject.toml`.
+- **Plugin system** — write custom rules and reporters as Python
+  packages. Register via entry points.
+- **CI/CD ready** — deterministic output, clear exit codes, SARIF
+  integration with GitHub Code Scanning.
+- **Fast** — sub-second on typical projects through caching and
+  parallel execution.
+
+## Rules
+
+| Category | Prefix | Rules | Default Severity |
+|----------|--------|-------|------------------|
+| [Correctness](docs/rules/correctness.md) | BC | 6 | Error |
+| [Step Definitions](docs/rules/step-definitions.md) | BD | 5 | Warning |
+| [Consistency](docs/rules/consistency.md) | BK | 5 | Warning / Info |
+| [Complexity](docs/rules/complexity.md) | BX | 5 | Warning |
+| [Style](docs/rules/style.md) | BS | 5 | Warning |
+| [Pedantic](docs/rules/pedantic.md) | BP | 5 | Info |
+
+### Auto-fixable rules
+
+| Rule | Fix | Safety |
+|------|-----|--------|
+| BC004 | Replace invalid tag characters with `_` | Safe |
+| BD004 | Convert `{param}` → `<param>` | Safe |
+| BD005 | Remove trailing punctuation from steps | Safe |
+| BS001 | Convert tags to `snake_case` | Safe |
+
+## Configuration
+
+Configure behave-lint in your `pyproject.toml`:
+
+```toml
+[tool.behave-lint]
+select = ["BC001", "BC002", "BS001"]
+ignore = ["BP001", "BP002"]
+fail-on = "warning"
+exclude = ["features/wip/"]
+
+[tool.behave-lint.severity]
+BK001 = "info"
+
+[tool.behave-lint.rules]
+BX001 = { max-steps = 8 }
+BP003 = { min-length = 5 }
+```
+
+**Precedence** (lowest → highest):
+
+1. Built-in defaults
+2. `pyproject.toml` `[tool.behave-lint]`
+3. Environment variables (`BEHAVE_LINT_*`)
+4. CLI flags
+
+See the [Configuration guide](docs/usage/configuration.md) for all
+options.
+
+## CI/CD integration
+
+### GitHub Actions with SARIF
+
+```yaml
+- run: pip install behave-lint
+- run: behave-lint features/ --sarif --output-file behave-lint.sarif
+- uses: github/codeql-action/upload-sarif@v3
+  with:
+    sarif_file: behave-lint.sarif
+```
+
+### Inline annotations
+
+```yaml
+- run: behave-lint features/ --output github
+```
+
+See the [CI/CD guide](docs/guides/ci-cd.md) for full workflows.
+
+## Output formats
+
+| Format | Flag | Use case |
+|--------|------|----------|
+| Console | `--output console` | Local development (default) |
+| JSON | `--json` | CI pipelines, custom tooling |
+| SARIF | `--sarif` | GitHub Code Scanning |
+| Markdown | `--output markdown` | PR comments, reports |
+| GitHub | `--output github` | Inline PR annotations |
+
+See the [Output Formats reference](docs/usage/output-formats.md) for
+schema details.
+
+## Examples
+
+Runnable example projects in the [`examples/`](examples/) directory:
+
+| Example | Description |
+|---------|-------------|
+| [basic-usage](examples/basic-usage/) | Minimal project with configuration |
+| [auto-fix](examples/auto-fix/) | Before/after demo of `--fix` |
+| [ci-cd](examples/ci-cd/) | GitHub Actions with SARIF upload |
+| [custom-rules](examples/custom-rules/) | Custom rule plugin with entry points |
+
+## Documentation
+
+### User guide
+
+- [Installation](docs/getting-started/installation.md)
+- [Quick Start](docs/getting-started/quick-start.md)
+- [CLI Reference](docs/usage/cli-reference.md)
+- [Configuration](docs/usage/configuration.md)
+- [Output Formats](docs/usage/output-formats.md)
+- [Auto-Fix](docs/usage/auto-fix.md)
+
+### Rules
+
+- [Rules Overview](docs/rules/index.md)
+- [Correctness (BC)](docs/rules/correctness.md)
+- [Step Definitions (BD)](docs/rules/step-definitions.md)
+- [Consistency (BK)](docs/rules/consistency.md)
+- [Complexity (BX)](docs/rules/complexity.md)
+- [Style (BS)](docs/rules/style.md)
+- [Pedantic (BP)](docs/rules/pedantic.md)
+
+### Guides
+
+- [CI/CD Integration](docs/guides/ci-cd.md)
+- [Pre-commit Hook](docs/guides/pre-commit.md)
+- [Custom Rules](docs/guides/custom-rules.md)
+- [Plugin Development](docs/guides/plugin-development.md)
+
+### Design documents
+
+- [Vision](ref/VISION.md) — project vision and mission
+- [Specification](ref/SPECIFICATION.md) — full feature specification
+- [Architecture](ref/ARCHITECTURE.md) — internal architecture
+- [API](ref/API.md) — public API specification
+- [Rule Engine Design](ref/RULE_ENGINE.md) — rule lifecycle and execution
+- [Rule Taxonomy](ref/RULE_TAXONOMY.md) — rule categories and metadata
+- [Configuration System](ref/CONFIGURATION_SYSTEM.md) — configuration schema
+- [Implementation Roadmap](ref/IMPLEMENTATION_ROADMAP.md) — milestone plan
+
+## Development
+
+```bash
+git clone https://github.com/MathiasPaulenko/behave-lint.git
+cd behave-lint
+uv sync
+uv run pre-commit install
+
+# Run tests
+uv run pytest
+
+# Lint
+uv run ruff check src/ tests/
+
+# Type check
+uv run mypy src/
+
+# Build docs
+uv run mkdocs build --strict
+```
+
+See [CONTRIBUTING.md](docs/CONTRIBUTING.md) for detailed contribution
+guidelines, coding standards, and PR workflow.
+
+## License
+
+[MIT](LICENSE)

behave_lint-1.0.0/README.md

@@ -0,0 +1,235 @@
+# behave-lint
+
+[![CI](https://github.com/MathiasPaulenko/behave-lint/actions/workflows/ci.yml/badge.svg)](https://github.com/MathiasPaulenko/behave-lint/actions/workflows/ci.yml)
+[![Python](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: Ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://docs.astral.sh/ruff/)
+
+> A fast, opinionated, extensible linter for Gherkin `.feature` files and Behave test suites.
+
+**behave-lint** statically analyzes your Gherkin feature files for
+correctness, consistency, complexity, and style — without executing a
+single test. It ships with **31 built-in rules** across 6 categories,
+supports **auto-fix** for common violations, and outputs in **5 formats**
+including SARIF for GitHub Code Scanning.
+
+## Why behave-lint?
+
+| Without behave-lint | With behave-lint |
+|---|---|
+| Duplicate step definitions cause silent match failures | **BD001** detects duplicates at lint time |
+| Inconsistent tag casing breaks CI filters | **BS001** auto-fixes to `snake_case` |
+| Trailing punctuation in steps clutters reports | **BD005** strips it automatically |
+| No Given-When-Then ordering enforcement | **BC001** catches structural violations |
+| Feature files grow unchecked in complexity | **BX001-BX005** enforce limits |
+
+## Installation
+
+```bash
+pip install behave-lint
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add behave-lint
+```
+
+## Quick start
+
+```bash
+# Lint all feature files
+behave-lint features/
+
+# Apply safe auto-fixes
+behave-lint features/ --fix
+
+# JSON output for CI integration
+behave-lint features/ --json --output-file report.json
+
+# SARIF for GitHub Code Scanning
+behave-lint features/ --sarif --output-file results.sarif
+
+# List all available rules
+behave-lint --list-rules
+
+# Explain a specific rule
+behave-lint --explain BC001
+```
+
+## Features
+
+- **31 built-in rules** across 6 categories: correctness, step
+  definitions, consistency, complexity, style, and pedantic.
+- **Auto-fix** — safe, deterministic fixes for common violations
+  (`--fix`). Unsafe fixes require `--unsafe-fixes`.
+- **5 output formats** — console (colored), JSON, SARIF, Markdown, and
+  GitHub Actions inline annotations.
+- **Zero-config** — sensible defaults work out of the box. Override
+  anything via `[tool.behave-lint]` in `pyproject.toml`.
+- **Plugin system** — write custom rules and reporters as Python
+  packages. Register via entry points.
+- **CI/CD ready** — deterministic output, clear exit codes, SARIF
+  integration with GitHub Code Scanning.
+- **Fast** — sub-second on typical projects through caching and
+  parallel execution.
+
+## Rules
+
+| Category | Prefix | Rules | Default Severity |
+|----------|--------|-------|------------------|
+| [Correctness](docs/rules/correctness.md) | BC | 6 | Error |
+| [Step Definitions](docs/rules/step-definitions.md) | BD | 5 | Warning |
+| [Consistency](docs/rules/consistency.md) | BK | 5 | Warning / Info |
+| [Complexity](docs/rules/complexity.md) | BX | 5 | Warning |
+| [Style](docs/rules/style.md) | BS | 5 | Warning |
+| [Pedantic](docs/rules/pedantic.md) | BP | 5 | Info |
+
+### Auto-fixable rules
+
+| Rule | Fix | Safety |
+|------|-----|--------|
+| BC004 | Replace invalid tag characters with `_` | Safe |
+| BD004 | Convert `{param}` → `<param>` | Safe |
+| BD005 | Remove trailing punctuation from steps | Safe |
+| BS001 | Convert tags to `snake_case` | Safe |
+
+## Configuration
+
+Configure behave-lint in your `pyproject.toml`:
+
+```toml
+[tool.behave-lint]
+select = ["BC001", "BC002", "BS001"]
+ignore = ["BP001", "BP002"]
+fail-on = "warning"
+exclude = ["features/wip/"]
+
+[tool.behave-lint.severity]
+BK001 = "info"
+
+[tool.behave-lint.rules]
+BX001 = { max-steps = 8 }
+BP003 = { min-length = 5 }
+```
+
+**Precedence** (lowest → highest):
+
+1. Built-in defaults
+2. `pyproject.toml` `[tool.behave-lint]`
+3. Environment variables (`BEHAVE_LINT_*`)
+4. CLI flags
+
+See the [Configuration guide](docs/usage/configuration.md) for all
+options.
+
+## CI/CD integration
+
+### GitHub Actions with SARIF
+
+```yaml
+- run: pip install behave-lint
+- run: behave-lint features/ --sarif --output-file behave-lint.sarif
+- uses: github/codeql-action/upload-sarif@v3
+  with:
+    sarif_file: behave-lint.sarif
+```
+
+### Inline annotations
+
+```yaml
+- run: behave-lint features/ --output github
+```
+
+See the [CI/CD guide](docs/guides/ci-cd.md) for full workflows.
+
+## Output formats
+
+| Format | Flag | Use case |
+|--------|------|----------|
+| Console | `--output console` | Local development (default) |
+| JSON | `--json` | CI pipelines, custom tooling |
+| SARIF | `--sarif` | GitHub Code Scanning |
+| Markdown | `--output markdown` | PR comments, reports |
+| GitHub | `--output github` | Inline PR annotations |
+
+See the [Output Formats reference](docs/usage/output-formats.md) for
+schema details.
+
+## Examples
+
+Runnable example projects in the [`examples/`](examples/) directory:
+
+| Example | Description |
+|---------|-------------|
+| [basic-usage](examples/basic-usage/) | Minimal project with configuration |
+| [auto-fix](examples/auto-fix/) | Before/after demo of `--fix` |
+| [ci-cd](examples/ci-cd/) | GitHub Actions with SARIF upload |
+| [custom-rules](examples/custom-rules/) | Custom rule plugin with entry points |
+
+## Documentation
+
+### User guide
+
+- [Installation](docs/getting-started/installation.md)
+- [Quick Start](docs/getting-started/quick-start.md)
+- [CLI Reference](docs/usage/cli-reference.md)
+- [Configuration](docs/usage/configuration.md)
+- [Output Formats](docs/usage/output-formats.md)
+- [Auto-Fix](docs/usage/auto-fix.md)
+
+### Rules
+
+- [Rules Overview](docs/rules/index.md)
+- [Correctness (BC)](docs/rules/correctness.md)
+- [Step Definitions (BD)](docs/rules/step-definitions.md)
+- [Consistency (BK)](docs/rules/consistency.md)
+- [Complexity (BX)](docs/rules/complexity.md)
+- [Style (BS)](docs/rules/style.md)
+- [Pedantic (BP)](docs/rules/pedantic.md)
+
+### Guides
+
+- [CI/CD Integration](docs/guides/ci-cd.md)
+- [Pre-commit Hook](docs/guides/pre-commit.md)
+- [Custom Rules](docs/guides/custom-rules.md)
+- [Plugin Development](docs/guides/plugin-development.md)
+
+### Design documents
+
+- [Vision](ref/VISION.md) — project vision and mission
+- [Specification](ref/SPECIFICATION.md) — full feature specification
+- [Architecture](ref/ARCHITECTURE.md) — internal architecture
+- [API](ref/API.md) — public API specification
+- [Rule Engine Design](ref/RULE_ENGINE.md) — rule lifecycle and execution
+- [Rule Taxonomy](ref/RULE_TAXONOMY.md) — rule categories and metadata
+- [Configuration System](ref/CONFIGURATION_SYSTEM.md) — configuration schema
+- [Implementation Roadmap](ref/IMPLEMENTATION_ROADMAP.md) — milestone plan
+
+## Development
+
+```bash
+git clone https://github.com/MathiasPaulenko/behave-lint.git
+cd behave-lint
+uv sync
+uv run pre-commit install
+
+# Run tests
+uv run pytest
+
+# Lint
+uv run ruff check src/ tests/
+
+# Type check
+uv run mypy src/
+
+# Build docs
+uv run mkdocs build --strict
+```
+
+See [CONTRIBUTING.md](docs/CONTRIBUTING.md) for detailed contribution
+guidelines, coding standards, and PR workflow.
+
+## License
+
+[MIT](LICENSE)

behave_lint-1.0.0/behave_lint/__init__.py

@@ -0,0 +1,43 @@
+"""behave-lint — A fast, opinionated, extensible linter for Gherkin .feature files.
+
+This package provides static analysis for Behave BDD projects, consuming
+behave-model as its single source of truth.
+
+Public API is defined in API.md. Only names explicitly exported here are
+considered stable and publicly supported.
+"""
+
+from __future__ import annotations
+
+from behave_lint.configuration.loader import load_config
+from behave_lint.models import (
+    AutoFixCapability,
+    Category,
+    Config,
+    Diagnostic,
+    FixCost,
+    LintResult,
+    LintSummary,
+    PerformanceImpact,
+    RuleExample,
+    RuleMetadata,
+    Severity,
+)
+
+__version__ = "1.0.0"
+
+__all__ = [
+    "AutoFixCapability",
+    "Category",
+    "Config",
+    "Diagnostic",
+    "FixCost",
+    "LintResult",
+    "LintSummary",
+    "PerformanceImpact",
+    "RuleExample",
+    "RuleMetadata",
+    "Severity",
+    "__version__",
+    "load_config",
+]

behave_lint-1.0.0/behave_lint/__main__.py

@@ -0,0 +1,8 @@
+"""Entry point for ``python -m behave_lint``."""
+
+from __future__ import annotations
+
+from behave_lint.cli import main
+
+if __name__ == "__main__":
+    main()

behave_lint-1.0.0/behave_lint/autofix/__init__.py

@@ -0,0 +1,18 @@
+"""Auto-Fix Coordinator — fix collection, conflict detection, application.
+
+Application layer — component C18.
+
+See COMPONENT_DESIGN.md Section 5 and RULE_ENGINE.md Section 9.
+"""
+
+from __future__ import annotations
+
+from behave_lint.autofix.coordinator import FixCoordinator
+from behave_lint.autofix.models import FixEdit, FixRecord, FixResult
+
+__all__ = [
+    "FixCoordinator",
+    "FixEdit",
+    "FixRecord",
+    "FixResult",
+]