Changelog

All notable changes are documented here. Format: Keep a Changelog. Versioning: Semantic Versioning.

[0.1.0b2] — 2026-05-13

Breaking release on the road to 1.0. The rule set is cut down to four, the TOML schema to nine keys, and the DSL now mirrors the TOML keys 1:1.

Full DSL parity — tree_structure, dependencies, and no_circular_imports are available as fluent methods on ServiceRuleSet.
TOML-free entry points — PyArchRules.from_services({...}) and PyArchRules.from_spec(spec) build an instance without a [tool.pyarchrules] table.
service_isolation — project-level isolate_services = true plus per-service shared = true enforces cross-service import boundaries (TOML-only).
tree_ignore — glob patterns of directory basenames to skip in strict / exact mode. Available in TOML and DSL.
JSON output — pyarchrules check --format json writes a stable {summary, violations} document to stdout.
New check flags — --config, --service, --rule (repeatable), --warnings-as-errors / -W.
New command — pyarchrules show-config dumps the resolved config as JSON.
file and line on RuleViolation; internal_dependencies violations now include line numbers.
__version__ exposed on the pyarchrules package.
Exception hierarchy — PyArchError → ConfigError, ValidationError, ServiceNotFoundError.
Faster scans — AST results cached per file; internal walks use os.scandir and prune common noise dirs (.venv, .tox, node_modules, build, dist, .mypy_cache, …).

Only 4 rules ship: tree_structure, dependencies, no_circular_imports, service_isolation.
TOML schema is 9 keys: isolate_services, path, shared, tree, tree_mode, tree_allow_files, tree_ignore, dependencies, no_circular_imports.
Exit codes are contractual: 0 ok, 1 violations, 2 config error. The --strict / --no-strict toggle is gone; use -W to upgrade warnings.
Invalid dependencies strings raise ConfigError at load time. Overlapping rule pairs are now reported as warnings instead.
Duplicate entries in tree raise ConfigError.
Removed project keys: root, validate_paths.
Removed per-service keys: allowed_service_dependencies, no_wildcard_imports, no_private_imports, allowed_external_libs, forbidden_external_libs.
Service shorthand removed: services.x = "src/x" is no longer accepted — use the table form.

DSL rules: must_contain_folders, must_contain_files, files_must_match_pattern, no_files_in_folder, max_depth, no_wildcard_imports, no_private_imports, no_relative_imports_in, allowed_external_libs, forbidden_external_libs, layer_must_not_import, files_must_be_snake_case, classes_must_match_pattern, no_test_files_in. Most overlap with Ruff or pytest discovery — replace accordingly.
Linter rule: allowed_service_dependencies — deferred to v1.x.
Heavy dependencies: pydantic and loguru.

DependenciesRule now correctly resolves relative imports (from .domain import x).
Rules no longer print to a side channel via loguru while ConsoleViolationReporter also prints — single output path now.

Beta — public API is stabilising, minor breaking changes may still occur.

tree_mode — replaces tree_strict / tree_recursive with a single enum: "exists" (default), "strict", "exact"
tree_mode = "strict" — validates structure one-to-one at every level covered by tree, from root down to the deepest declared path; leaf directories are not inspected internally
tree_mode = "exact" — same as strict plus recursively checks inside every leaf directory; full one-to-one match of the entire tree
tree_allow_files — still supported alongside tree_mode; loose files are always tolerated in strict/exact modes by default
Invalid tree_mode value raises a clear PyArchError with the list of valid options
Documentation updated: configuration.md, use-cases.md, getting-started.md now use tree_mode throughout

tree_strict and tree_recursive boolean flags replaced by tree_mode (breaking change)
init-project no longer generates deprecated project_name and description fields
project_name and description removed from known project keys — configs that still contain them will now raise an "unknown key" error
no_args_is_help = true on the CLI app — invoking pyarchrules with no arguments now shows the same output as --help

tree_strict previously did not check the service root level, so undeclared siblings at the top level were silently ignored — now fixed in "strict" and "exact" modes

Beta — first public beta release.

New DSL rules: allowed_external_libs, forbidden_external_libs, no_test_files_in, no_files_in_folder, max_depth, files_must_match_pattern, files_must_be_snake_case, classes_must_match_pattern, no_relative_imports_in, no_circular_imports, layer_must_not_import, no_private_imports, no_wildcard_imports
ServiceIsolationRule — enforces isolate_services at the project level; services marked shared = true are exempt
AllowedServiceDependenciesRule — validates allowed_service_dependencies per service
LinterRegistry and BaseRegistry for rule registration
MkDocs documentation site deployed to mspitb.github.io/pyarchrules
GitHub Actions workflow for automatic docs deployment on push to main
Unknown keys in [tool.pyarchrules] and per-service config now raise a descriptive PyArchError

pyproject.toml dependencies relaxed from exact pins (==) to minimum bounds (>=) for better compatibility with user environments
Removed zensical from dev dependencies

ConsoleViolationReporter log format now includes a trailing newline to prevent messages from appearing on the same line

Alpha — API may change before 1.0.

Initial private release.