Changelog¶

All notable changes to this project will be documented here. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[Unreleased]¶

load_feature_text() and load_feature_file() in behave_format.loader: parse feature text while restoring what behave's parser discards — comments, original Gherkin keywords, and docstring content types
line_length now wraps long tag lines onto continuation lines
Config auto-discovery walks upward from each target path (and from the current directory for --stdin); --config still overrides
--check mode now reports each file that would be reformatted
--stdin supports --diff

Table cells containing \| are re-escaped on output; previously the formatter emitted invalid Gherkin that could not be re-parsed
Comments are no longer deleted from formatted files
Non-English features keep their original keywords (Característica, Escenario, Regla, ...) instead of being rewritten with English keywords under a # language: directive that made output unparseable
Docstring content types ("""json, """text/plain, ...) are preserved
Step text whitespace is no longer collapsed inside "...", '...' and <placeholder> literals (changed the arguments step definitions would match)
Feature/scenario/rule descriptions keep their interior spacing
Directory mode parse errors now exit with code 2 (previously swallowed)
Files are written with LF endings deterministically (previously followed os.linesep, producing CRLF on Windows) and atomically
format_feature now honors sort_scenarios like format_project
sort_tags = false no longer sorts project.global_tags anyway
Ragged tables pad missing cells instead of truncating extra ones
Duplicate tags are removed
Empty lines inside docstrings no longer emit trailing whitespace
--indent rejects values below 1; invalid config values exit with code 2 instead of a traceback
.venv, node_modules and other tooling directories are skipped when formatting a directory recursively
Removed dead pipeline/rules.py rule registry

Table column widths are computed on escaped cell text and use display width for CJK/emoji characters

python -m behave_format support via __main__.py
--stdin flag: read from stdin, write formatted output to stdout (editor integration)
--indent flag: override indentation from CLI without editing pyproject.toml
--version flag showing behave-format <version>
Settings.with_indent() method for immutable indent override
behave-format as a local pre-commit hook in .pre-commit-config.yaml
CI, Docs, PyPI, Python versions, and License badges in README

Comments now preserved in output for features, rules, scenarios, scenario outlines, and steps
# language: directive preserved for non-English features
CLI error handling: file-not-found and parse errors now exit with code 2 instead of crashing
format_feature now applies align stage for pipeline consistency with format_project
_align_table signature bug fixed (examples_table kwarg mismatch)
render_feature and render_project now include trailing newline for consistency with CLI output

See CHANGELOG.md on GitHub for the full changelog.