behave-format 1.0.0__tar.gz

behave_format-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - run: pip install ruff
+      - run: ruff check behave_format/ tests/
+      - run: ruff format --check behave_format/ tests/
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - run: python -m pytest tests/ --cov=behave_format --cov-report=xml --cov-report=term
+      - uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false
+
+  packaging:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - run: pip install build twine
+      - run: python -m build
+      - run: python -m twine check dist/*

behave_format-1.0.0/.github/workflows/docs.yml

@@ -0,0 +1,53 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - "README.md"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install MkDocs
+        run: pip install mkdocs mkdocs-material
+
+      - name: Build site
+        run: mkdocs build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    continue-on-error: true
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

behave_format-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,86 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - run: python -m pytest tests/ --cov=behave_format --cov-report=term
+
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build dependencies
+        run: pip install build twine
+
+      - name: Build distributions
+        run: python -m build
+
+      - name: Check distributions
+        run: python -m twine check dist/*
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    continue-on-error: true
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true
+          files: dist/*

behave_format-1.0.0/.gitignore

@@ -0,0 +1,20 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+*.egg
+dist/
+build/
+.eggs/
+*.so
+.tox/
+.coverage
+.coverage.*
+htmlcov/
+.pytest_cache/
+.ruff_cache/
+*.whl
+*.tar.gz
+.venv/
+venv/
+env/

behave_format-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.5.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

behave_format-1.0.0/CHANGELOG.md

@@ -0,0 +1,24 @@
+# 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).
+
+## [Unreleased]
+
+## [1.0.0] - 2025-07-02
+
+### Added
+
+- Initial release of behave-format
+- Opinionated, deterministic formatter for Behave `.feature` files
+- Consumes `behave-model.Project` as input (no direct Gherkin parsing)
+- Formatting pipeline: normalize → sort → align → print
+- Tags sorted alphabetically by default
+- Table column alignment
+- Whitespace normalization (trailing spaces, indentation)
+- CLI with `--check` (CI mode), `--diff`, and write modes
+- Configuration via `pyproject.toml` under `[tool.behave-format]`
+- Golden file tests, idempotency tests, CLI tests, performance tests
+- GitHub Actions CI workflow (lint, test, coverage, packaging)

behave_format-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mathias Paulenko
+
+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_format-1.0.0/Makefile

@@ -0,0 +1,37 @@
+.PHONY: install dev test test-verbose lint format coverage build clean docs docs-serve
+
+install:
+	pip install -e .
+
+dev:
+	pip install -e ".[dev]"
+
+test:
+	pytest tests/ -q
+
+test-verbose:
+	pytest tests/ -v --tb=short
+
+lint:
+	ruff check behave_format/ tests/
+	ruff format --check behave_format/ tests/
+
+format:
+	ruff format behave_format/ tests/
+	ruff check --fix behave_format/ tests/
+
+coverage:
+	pytest tests/ --cov=behave_format --cov-report=term-missing --cov-report=html
+
+build:
+	python -m build
+
+docs:
+	mkdocs build
+
+docs-serve:
+	mkdocs serve
+
+clean:
+	rm -rf build/ dist/ *.egg-info/ .coverage .pytest_cache/ htmlcov/ .tox/ .ruff_cache/
+	find . -type d -name __pycache__ -exec rm -rf {} +

behave_format-1.0.0/PKG-INFO

@@ -0,0 +1,280 @@
+Metadata-Version: 2.4
+Name: behave-format
+Version: 1.0.0
+Summary: The opinionated formatter for Behave .feature files
+Project-URL: Homepage, https://github.com/MathiasPaulenko/behave-format
+Project-URL: Repository, https://github.com/MathiasPaulenko/behave-format
+Project-URL: Issues, https://github.com/MathiasPaulenko/behave-format/issues
+Project-URL: Changelog, https://github.com/MathiasPaulenko/behave-format/blob/main/CHANGELOG.md
+Author: Mathias Paulenko
+License-Expression: MIT
+License-File: LICENSE
+Keywords: bdd,behave,cucumber,format,formatter,gherkin,testing
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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 :: Libraries
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.11
+Requires-Dist: behave-model>=0.1.0
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
+Requires-Dist: mkdocs>=1.6; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# behave-format
+
+> The opinionated formatter for Behave `.feature` files.
+
+[Black](https://github.com/psf/black) is for Python. [gofmt](https://go.dev/blog/gofmt) is for Go. **behave-format** is for Gherkin.
+
+---
+
+## Overview
+
+`behave-format` is a deterministic, opinionated formatter for Behave `.feature` files. It consumes the canonical domain model from [behave-model](https://github.com/MathiasPaulenko/behave-model) and produces clean, consistent, beautifully formatted output.
+
+**Key principle:** behave-format does NOT parse Gherkin. It does NOT lint. It does NOT validate. It ONLY transforms a `behave-model.Project` into formatted `.feature` files.
+
+```text
+.feature files → behave-model (domain model) → behave-format → formatted .feature files
+```
+
+## Features
+
+- **Opinionated** — minimal configuration, sensible defaults
+- **Deterministic** — same input always produces same output
+- **Idempotent** — `format(format(x)) == format(x)`
+- **Fast** — handles thousands of feature files efficiently
+- **CI-friendly** — `--check` mode with exit code 1 when formatting is needed
+- **Safe** — never changes semantics (names, step text, table values, docstrings)
+
+## Installation
+
+```bash
+pip install behave-format
+```
+
+## Quick Start
+
+### CLI
+
+```bash
+# Format files in place (default)
+behave-format features/
+
+# Check mode (CI) — exit 1 if formatting is needed
+behave-format --check features/
+
+# Diff mode — show differences without writing
+behave-format --diff features/
+```
+
+### Python API
+
+```python
+from behave_model import load_project
+from behave_format import format_project, render_project, Settings
+
+project = load_project("features/")
+
+# Format the project model in place
+format_project(project)
+
+# Or render to text
+text = render_project(project, Settings())
+```
+
+## Formatting Rules
+
+### Tags
+
+Tags are sorted alphabetically by default:
+
+```gherkin
+@api @smoke
+```
+
+### Features
+
+- One blank line before each Feature
+- Clean title formatting
+
+### Scenarios
+
+- One blank line before each Scenario
+- Two-space indentation for steps
+
+```gherkin
+  Given user exists
+  When user logs in
+  Then dashboard is shown
+```
+
+### Tables
+
+Tables are always aligned:
+
+Before:
+
+```gherkin
+|user|password|
+|john|123|
+```
+
+After:
+
+```gherkin
+| user | password |
+| john | 123      |
+```
+
+### Blank Lines
+
+- No trailing blank lines
+- No multiple consecutive empty lines
+- Consistent spacing between blocks
+
+### Indentation
+
+- Spaces only (no tabs)
+- Default: 2 spaces
+
+## Configuration
+
+Minimal configuration via `pyproject.toml`:
+
+```toml
+[tool.behave-format]
+indent = 2
+sort_tags = true
+sort_features = false
+sort_scenarios = false
+line_length = 120
+```
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `indent` | `2` | Number of spaces for indentation |
+| `sort_tags` | `true` | Sort tags alphabetically |
+| `sort_features` | `false` | Sort features by name |
+| `sort_scenarios` | `false` | Sort scenarios by name |
+| `line_length` | `120` | Maximum line length (reference) |
+
+## Before / After
+
+### Before
+
+```gherkin
+@smoke @auth
+Feature: Login
+  As a user
+  I want to log in
+
+  Background:
+    Given a database connection
+
+  @happy
+  Scenario: Successful login
+    Given the user is on the login page
+    When the user enters "admin" and "password"
+    Then the user should be logged in
+```
+
+### After
+
+```gherkin
+@auth @smoke
+Feature: Login
+  As a user
+  I want to log in
+
+  Background:
+    Given a database connection
+
+  @happy
+  Scenario: Successful login
+    Given the user is on the login page
+    When the user enters "admin" and "password"
+    Then the user should be logged in
+```
+
+## Architecture
+
+```text
+behave_format/
+├── config/
+│   └── settings.py        # Settings dataclass + pyproject.toml loader
+├── pipeline/
+│   ├── normalize.py       # Whitespace, indentation, tag normalization
+│   ├── sort.py            # Sort tags, features, scenarios
+│   ├── align.py           # Table alignment, trailing whitespace
+│   ├── rules.py           # Formatting rules registry
+│   └── formatter.py       # Main orchestrator (format_project)
+├── printer/
+│   ├── feature_printer.py
+│   ├── scenario_printer.py
+│   ├── step_printer.py
+│   ├── table_printer.py
+│   └── tag_printer.py
+└── cli/
+    └── main.py            # CLI entry point
+```
+
+## Pipeline
+
+1. **Normalize** — clean whitespace, standardize indentation, normalize tags
+2. **Sort** — order tags (alphabetically by default), optionally features and scenarios
+3. **Align** — align table columns, remove trailing spaces
+4. **Print** — convert `behave-model` → `.feature` text (deterministic)
+
+## Safety
+
+The formatter NEVER changes semantics:
+
+- Feature names: preserved
+- Scenario names: preserved
+- Step text: preserved (only whitespace normalized)
+- DocString content: preserved
+- Table values: preserved (only alignment changes)
+- Comments content: preserved
+
+## Integration
+
+`behave-format` integrates naturally with the Behave ecosystem:
+
+- [behave-model](https://github.com/MathiasPaulenko/behave-model) — single source of truth
+- [behave-lint](https://github.com/MathiasPaulenko/behave-lint) — linting
+- [behave-modern-json-report](https://github.com/MathiasPaulenko/behave-modern-json-report)
+- [behave-modern-report](https://github.com/MathiasPaulenko/behave-modern-report)
+- [behave-markdown-report](https://github.com/MathiasPaulenko/behave-markdown-report)
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest tests/ -v
+ruff check .
+ruff format --check .
+```
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Run `ruff check .` and `pytest tests/` before submitting
+4. Open a Pull Request
+
+## License
+
+MIT