smelt-cli 0.3.0__tar.gz → 0.4.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/.pre-commit-hooks.yaml +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/CHANGELOG.md +76 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/CONTRIBUTING.md +6 -6
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/Cargo.lock +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/Cargo.toml +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/PKG-INFO +17 -14
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/README.md +16 -13
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/README.md +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/adoption.md +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/agent-workflow.md +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/cli.md +29 -3
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/configuration.md +112 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/integrations.md +14 -8
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/proposals/config-structure.md +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/README.md +3 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT104.md +3 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT109.md +2 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT305.md +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT306.md +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT313.md +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT316.md +1 -1
- smelt_cli-0.4.0/docs/rules/SMT321.md +36 -0
- smelt_cli-0.4.0/docs/rules/SMT322.md +41 -0
- smelt_cli-0.4.0/docs/rules/SMT323.md +42 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT424.md +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT426.md +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT901.md +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/structure.md +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/upgrading.md +68 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/pyproject.toml +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/scripts/benchmark_checks.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/scripts/benchmark_hooks.py +4 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/scripts/smoke_distribution.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/context.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/exports.py +4 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/facade_usage.py +76 -13
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/imports.py +8 -6
- smelt_cli-0.4.0/smelt/analysis/lazy_exports.py +390 -0
- smelt_cli-0.4.0/smelt/analysis/navigation.py +374 -0
- smelt_cli-0.4.0/smelt/analysis/none_default_rewrite.py +110 -0
- smelt_cli-0.4.0/smelt/analysis/none_defaults.py +150 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/ordering.py +102 -11
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/python_version.py +5 -3
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/test_outcomes.py +37 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/test_timing.py +17 -4
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/cli/app.py +22 -7
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/cli/commands/adopt.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/cli/commands/check.py +40 -10
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/cli/commands/info.py +15 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/cli/support.py +1 -1
- smelt_cli-0.4.0/smelt/config/composition.py +175 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/config/errors.py +3 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/config/loader.py +41 -12
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/config/models.py +18 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/config/schema.py +10 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/config/validation.py +6 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/diagnostics/groups.py +59 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/diagnostics/render/text.py +38 -4
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/docs.py +3 -3
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/briefing.py +13 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/cache.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/check.py +49 -7
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/coverage.py +7 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/evaluation.py +16 -3
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/file_checks.py +4 -4
- smelt_cli-0.4.0/smelt/engine/none_default_fixes.py +70 -0
- smelt_cli-0.4.0/smelt/engine/ordering_fixes.py +80 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/result_cache.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/rule_settings.py +4 -4
- smelt_cli-0.4.0/smelt/engine/source_fixes.py +80 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/staged.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/base.py +8 -6
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/catalog.json +45 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/common.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/dependencies/composition_root.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/dependencies/cycles.py +90 -14
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/dependencies/facades.py +19 -3
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/dependencies/fanout.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/dependencies/features.py +3 -3
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/dependencies/interfaces.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/dependencies/layers.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/dependencies/third_party.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/meta.py +4 -3
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/registry.py +8 -5
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/structure/assignments.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/structure/contracts.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/structure/coverage.py +4 -4
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/structure/enum_values.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/structure/headers.py +5 -5
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/structure/import_style.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/structure/layout.py +4 -4
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/structure/members.py +4 -3
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/structure/module_symbols.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/structure/naming.py +74 -3
- smelt_cli-0.4.0/smelt/rules/structure/navigation.py +183 -0
- smelt_cli-0.4.0/smelt/rules/structure/none_defaults.py +47 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/structure/ordering.py +3 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/structure/package_imports.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/structure/type_dispatch.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/testing/awaits.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/testing/cases.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/testing/location.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/testing/mocking.py +4 -4
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/testing/outcomes.py +14 -6
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/testing/private_access.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/testing/public_attributes.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/testing/public_functions.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/testing/timing.py +10 -4
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt.schema.json +262 -80
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt.yml +2 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_context.py +8 -8
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_contracts.py +4 -4
- smelt_cli-0.4.0/tests/analysis/test_lazy_exports.py +150 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_module_symbols.py +2 -2
- smelt_cli-0.4.0/tests/analysis/test_none_default_rewrite.py +36 -0
- smelt_cli-0.4.0/tests/analysis/test_none_defaults.py +22 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_ordering_rewrite.py +43 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_parsing.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_python_version.py +4 -4
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_retained.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_test_helpers.py +1 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/cli/test_app.py +325 -103
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/cli/test_session.py +38 -4
- smelt_cli-0.4.0/tests/config/test_composition.py +209 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/config/test_loader.py +13 -10
- smelt_cli-0.4.0/tests/diagnostics/test_groups.py +288 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/engine/test_briefing.py +38 -13
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/engine/test_cache.py +49 -19
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/engine/test_changes.py +45 -18
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/engine/test_check.py +28 -4
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/engine/test_coverage.py +29 -5
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/engine/test_evaluation.py +45 -6
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/engine/test_file_checks.py +6 -6
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/engine/test_inference.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/engine/test_native_git.py +1 -1
- smelt_cli-0.4.0/tests/engine/test_none_default_fixes.py +164 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/engine/test_ordering_fixes.py +4 -4
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/engine/test_paths.py +5 -5
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/engine/test_rule_settings.py +3 -3
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/engine/test_schema.py +9 -0
- smelt_cli-0.4.0/tests/engine/test_source_fixes.py +26 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/engine/test_staged.py +129 -29
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/helpers.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/dependencies/test_composition_root.py +6 -6
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/dependencies/test_cycles.py +130 -8
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/dependencies/test_facades.py +164 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/dependencies/test_fanout.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/dependencies/test_features.py +13 -13
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/dependencies/test_interfaces.py +4 -4
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/dependencies/test_layers.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/dependencies/test_third_party.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/structure/test_assignments.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/structure/test_contracts.py +8 -8
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/structure/test_coverage.py +13 -17
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/structure/test_enum_values.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/structure/test_headers.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/structure/test_import_style.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/structure/test_layout.py +6 -6
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/structure/test_members.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/structure/test_module_symbols.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/structure/test_naming.py +207 -6
- smelt_cli-0.4.0/tests/rules/structure/test_navigation.py +362 -0
- smelt_cli-0.4.0/tests/rules/structure/test_none_defaults.py +182 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/structure/test_ordering.py +10 -10
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/structure/test_package_imports.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/structure/test_type_dispatch.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/test_activation.py +6 -4
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/test_registry.py +8 -6
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/testing/test_awaits.py +5 -5
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/testing/test_cases.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/testing/test_location.py +5 -5
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/testing/test_mocking.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/testing/test_outcomes.py +64 -8
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/testing/test_private_access.py +7 -7
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/testing/test_public_attributes.py +2 -2
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/testing/test_public_functions.py +15 -15
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/testing/test_timing.py +9 -4
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/test_docs.py +1 -1
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/uv.lock +1 -1
- smelt_cli-0.3.0/smelt/engine/ordering_fixes.py +0 -132
- smelt_cli-0.3.0/tests/diagnostics/test_groups.py +0 -137
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/.editorconfig +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/.gitattributes +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/.github/dependabot.yml +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/.github/pull_request_template.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/.github/workflows/ci.yml +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/.github/workflows/release.yml +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/.gitignore +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/.pre-commit-config.yml +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/.python-version +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/architecture.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/benchmarks/incremental-followup-2026-10-31.json +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/benchmarks/native-checks-2026-10-31.json +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/benchmarks/native-git-retained-state-2026-10-31.json +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/benchmarks/precommit-performance-2026-10-30.json +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/benchmarks/review-feedback-2026-10-31.json +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/benchmarks/staged-checks-2026-10-30.json +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/benchmarks/staged-policy-cache-2026-10-31.json +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/facade-export-evaluation.json +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/review.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rule-selection.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT101.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT102.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT103.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT105.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT106.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT107.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT108.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT301.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT302.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT307.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT308.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT309.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT310.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT311.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT312.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT314.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT315.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT317.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT318.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT319.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT320.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT401.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT420.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT421.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT422.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT423.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT425.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT427.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT428.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT429.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT430.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT902.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/rules/SMT903.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/test-quality-evaluation.json +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/testing.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/docs/vision.md +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/native/git.rs +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/native/main.rs +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/native/worker.rs +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/scripts/benchmark_session.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/scripts/evaluate.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/scripts/generate.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/__main__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/annotations.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/cache.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/contracts.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/coverage.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/definition_blocks.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/enum_values.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/errors.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/files.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/function_usage.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/graphs.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/identity.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/import_cache.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/literals.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/member_state.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/members.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/module_symbols.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/ordering_rewrite.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/package_exports.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/parsing.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/retained.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/syntax.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/test_awaits.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/test_cases.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/test_deadlines.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/test_helpers.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/test_subprocesses.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/test_syntax.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/type_dispatch.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/analysis/workspace.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/cli/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/cli/commands/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/cli/commands/discover.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/cli/session.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/cli/session_slots.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/config/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/config/discovery.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/config/patterns.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/config/source.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/diagnostics/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/diagnostics/debt.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/diagnostics/dedupe.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/diagnostics/render/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/diagnostics/render/machine.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/diagnostics/report.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/diagnostics/suppressions.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/diagnostics/violation.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/changes.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/git_source.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/inference.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/mirror_inference.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/native_git.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/paths.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/schema.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/engine/workspace.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/model/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/model/architecture.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/py.typed +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/activation.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/dependencies/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/member_names.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/structure/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/smelt/rules/testing/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_annotations.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_enum_values.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_exports.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_identity.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_ordering.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_test_awaits.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_test_cases.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_test_deadlines.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_test_outcomes.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_test_syntax.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_test_timing.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_type_dispatch.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/analysis/test_workspace.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/cli/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/cli/test_session_slots.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/config/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/config/test_validation.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/diagnostics/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/diagnostics/render/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/diagnostics/render/conftest.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/diagnostics/render/test_machine.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/diagnostics/render/test_text.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/diagnostics/test_suppressions.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/engine/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/engine/test_mirror_inference.py +0 -0
- /smelt_cli-0.3.0/tests/fixtures/gateway/smelt.yaml → /smelt_cli-0.4.0/tests/fixtures/gateway/smelt.yml +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/bootstrap.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/features/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/features/billing/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/features/billing/application/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/features/billing/application/invoices.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/features/billing/domain/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/features/billing/domain/money.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/features/voice/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/features/voice/api/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/features/voice/api/routes.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/features/voice/application/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/features/voice/application/ports.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/features/voice/application/session.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/features/voice/domain/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/features/voice/domain/session.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/features/voice/infra/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/features/voice/infra/sql.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/main.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/shared/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/fixtures/gateway/src/gateway/shared/clock.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/model/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/model/test_architecture.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/dependencies/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/structure/__init__.py +0 -0
- {smelt_cli-0.3.0 → smelt_cli-0.4.0}/tests/rules/testing/__init__.py +0 -0
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
- id: smelt
|
|
2
2
|
name: smelt
|
|
3
|
-
description: Check Python architecture boundaries against smelt.
|
|
3
|
+
description: Check Python architecture boundaries against smelt.yml.
|
|
4
4
|
entry: smelt check
|
|
5
5
|
language: python
|
|
6
6
|
pass_filenames: false
|
|
7
|
-
|
|
7
|
+
always_run: true
|
|
8
8
|
require_serial: true
|
|
9
9
|
- id: smelt-staged
|
|
10
10
|
name: smelt (new staged findings)
|
|
@@ -7,6 +7,80 @@ current configuration and complete rule contracts, see the [README](README.md),
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [0.4.0] - 2026-11-01
|
|
11
|
+
|
|
12
|
+
Report schema 2, YAML version 1 and the default rule set remain unchanged.
|
|
13
|
+
Custom rules must update `BaseRule` imports to `Rule` and annotations for the
|
|
14
|
+
former `Rule` protocol to `RuleContract`. Update installation, hook and CI pins
|
|
15
|
+
together to `0.4.0` (`v0.4.0`) and refresh the editor schema. See the
|
|
16
|
+
[upgrade checklist](docs/upgrading.md#030-to-040).
|
|
17
|
+
|
|
18
|
+
- Use `.yml` consistently in configuration examples, fixtures and maintainer
|
|
19
|
+
scripts. `smelt init` now creates `smelt.yml`, which takes precedence when both
|
|
20
|
+
supported filenames exist. Existing `smelt.yaml` files still work. The published
|
|
21
|
+
`.pre-commit-hooks.yaml` manifest retains its required filename. Integration
|
|
22
|
+
instructions consistently use prek.
|
|
23
|
+
|
|
24
|
+
- Optional [SMT323](docs/rules/SMT323.md), enabled with
|
|
25
|
+
`rules: {no-base-class-prefix: error}`, rejects class definitions such as
|
|
26
|
+
`BaseRepository` and `_BaseRepository` in favor of responsibility-based names.
|
|
27
|
+
Imports, third-party inheritance, `Baseline` and `Base64` remain valid. Package
|
|
28
|
+
rule overrides can disable the convention; checks never rename symbols.
|
|
29
|
+
Smelt enables the convention for its own sources; the default set is unchanged.
|
|
30
|
+
- Smelt also enables the opt-in `deep-object-navigation` Law of Demeter review
|
|
31
|
+
for its own sources. Facade analysis receives its file inventory directly,
|
|
32
|
+
and filesystem/Python-target analysis receives its source store explicitly.
|
|
33
|
+
SMT322 recognizes statically evidenced module/data namespaces and known value
|
|
34
|
+
APIs, preserving unknown collaborator findings. Changes to imported record
|
|
35
|
+
definitions are considered on every check; no code is executed or rewritten.
|
|
36
|
+
Unproven namespaces remain advisory review candidates, with known receiver
|
|
37
|
+
types and the unresolved step included for agent API-contract review. A finding
|
|
38
|
+
alone does not require an architecture change.
|
|
39
|
+
- Rule implementations now inherit `smelt.rules.base.Rule` instead of `BaseRule`.
|
|
40
|
+
The former structural `Rule` protocol is named `RuleContract`; lazy rule
|
|
41
|
+
implementations retain the same interface. Update custom rule imports and
|
|
42
|
+
type annotations accordingly.
|
|
43
|
+
- Independent workspaces can share a local policy fragment with `extends` and
|
|
44
|
+
explicit child overrides. Mappings merge; lists replace, including `[]`.
|
|
45
|
+
Project paths remain relative to the selected workspace. `config show --sources`
|
|
46
|
+
explains effective inputs and origins; staged checks and cache dependencies
|
|
47
|
+
include all bases. Both published hooks now run on every commit, including
|
|
48
|
+
policy-only edits. See [shared configuration](docs/configuration.md#shared-local-policy).
|
|
49
|
+
|
|
50
|
+
- New opt-in [SMT322](docs/rules/SMT322.md) `deep-object-navigation` reviews
|
|
51
|
+
method calls reached through multiple stored instance attributes, such as
|
|
52
|
+
`self.browser.input.motor().aim()`. Enable with
|
|
53
|
+
`rules: {deep-object-navigation: hint}` or `--select SMT322`; package rule
|
|
54
|
+
overrides and inline suppressions preserve intentional navigation. Direct
|
|
55
|
+
collaborator calls, pure data reads and direct-collaborator fluent chains
|
|
56
|
+
remain quiet. This bounded syntax review has no automatic rewrite.
|
|
57
|
+
- [SMT901](docs/rules/SMT901.md) diagnoses unknown inline suppression identifiers,
|
|
58
|
+
including readable rule names where stable SMT codes are required. Known
|
|
59
|
+
inactive rules retain their narrowed-check behavior.
|
|
60
|
+
- [SMT426](docs/rules/SMT426.md) groups shared-helper operations by one repair in
|
|
61
|
+
text and adds deterministic `shared_helper` JSON groups. Individual findings,
|
|
62
|
+
identities, counts, suppressions and debt remain unchanged. [SMT424](docs/rules/SMT424.md)
|
|
63
|
+
explains known helper inference limits at the affected call sites.
|
|
64
|
+
- [SMT104](docs/rules/SMT104.md) adds the opt-in `cycles: [modules]` scope and
|
|
65
|
+
independent `type_checking_cycles: ignore`. Existing scopes are explicitly
|
|
66
|
+
labeled as aggregated; witnesses include edge phases. Default scopes stay unchanged.
|
|
67
|
+
- [SMT109](docs/rules/SMT109.md) accepts optional, statically verified
|
|
68
|
+
`structure.canonical_exports` ownership and distinguishes same-root/other-root
|
|
69
|
+
importers. Existing exports inform the review; frequency alone never expands API.
|
|
70
|
+
- Literal lazy-export tables with a matching guarded `import_module`/`getattr`
|
|
71
|
+
forwarder now contribute export identity and visibility evidence. Unsupported
|
|
72
|
+
dynamic handlers, escaped/mutated tables and type stubs alone remain unverified.
|
|
73
|
+
- [SMT313](docs/rules/SMT313.md) permits bounded ordering fixes around unrelated
|
|
74
|
+
nested-function dictionaries and `nonlocal` closure writes. Reflection on
|
|
75
|
+
unknown receivers or ordered namespaces retains its manual-review barrier.
|
|
76
|
+
|
|
77
|
+
- New opt-in [SMT321](docs/rules/SMT321.md) `implicit-optional-default`
|
|
78
|
+
reviews `parameter or fallback` for explicitly optional parameters with a
|
|
79
|
+
`None` default. Enable with `rules: {implicit-optional-default: warning}` or
|
|
80
|
+
`--select SMT321`. Use `--fix --unsafe-fixes` to replace it with an explicit
|
|
81
|
+
`is not None` conditional after reviewing intentional falsy defaults. Plain
|
|
82
|
+
`--fix` preserves existing truthiness behavior.
|
|
83
|
+
|
|
10
84
|
## [0.3.0] - 2026-11-01
|
|
11
85
|
|
|
12
86
|
### Upgrade first
|
|
@@ -424,7 +498,8 @@ smelt explain SMT313 --format json
|
|
|
424
498
|
- Import fanout, match suggestions and missing-assertion checks are review aids;
|
|
425
499
|
their default severities differ. Configure policy and severity deliberately.
|
|
426
500
|
|
|
427
|
-
[Unreleased]: https://github.com/mathisarends/smelt/compare/v0.
|
|
501
|
+
[Unreleased]: https://github.com/mathisarends/smelt/compare/v0.4.0...HEAD
|
|
502
|
+
[0.4.0]: https://github.com/mathisarends/smelt/compare/v0.3.0...v0.4.0
|
|
428
503
|
[0.3.0]: https://github.com/mathisarends/smelt/compare/v0.2.0...v0.3.0
|
|
429
504
|
[0.2.0]: https://github.com/mathisarends/smelt/compare/v0.1.6...v0.2.0
|
|
430
505
|
[0.1.6]: https://github.com/mathisarends/smelt/compare/v0.1.5...v0.1.6
|
|
@@ -95,7 +95,7 @@ Normal checks stay read-only. A new rule does not need a fixer or a new index.
|
|
|
95
95
|
|
|
96
96
|
## One rule, one catalog entry
|
|
97
97
|
|
|
98
|
-
New
|
|
98
|
+
New Rule subclasses are off by default. Choose activation alongside the rule:
|
|
99
99
|
|
|
100
100
|
Fixed-pattern source/test reviews are selected directly by a problem name in
|
|
101
101
|
`rules`; do not add `review_*`, `require_*` or other duplicate boolean switches.
|
|
@@ -122,7 +122,7 @@ also activate opt-in rules, while explicit off/ignore and strict coverage retain
|
|
|
122
122
|
their precedence. The generated catalog and CLI metadata derive activation from
|
|
123
123
|
the rule class; there is no second registration list of activation decisions.
|
|
124
124
|
|
|
125
|
-
Use `
|
|
125
|
+
Use `Rule`, a stable code, a unique kebab-case name, a category, explicit
|
|
126
126
|
`requires` and a complete `RuleDoc`. Allocate an unused code from the live catalog:
|
|
127
127
|
|
|
128
128
|
| Range | Category |
|
|
@@ -264,13 +264,13 @@ environment name must match the workflow exactly.
|
|
|
264
264
|
run `uv lock` and `cargo check` to refresh both lockfiles, and merge the release
|
|
265
265
|
preparation into `main` after CI passes. Each release needs a new PyPI version.
|
|
266
266
|
2. From an up-to-date, clean `main` checkout, create and push the corresponding tag.
|
|
267
|
-
For example, after merging version `0.
|
|
267
|
+
For example, after merging version `0.4.0`:
|
|
268
268
|
|
|
269
269
|
```bash
|
|
270
270
|
git switch main
|
|
271
271
|
git pull --ff-only
|
|
272
|
-
git tag v0.
|
|
273
|
-
git push origin v0.
|
|
272
|
+
git tag v0.4.0
|
|
273
|
+
git push origin v0.4.0
|
|
274
274
|
```
|
|
275
275
|
|
|
276
276
|
3. Follow the `Publish to PyPI` run in
|
|
@@ -288,7 +288,7 @@ environment name must match the workflow exactly.
|
|
|
288
288
|
Maintainers and coding agents with permission to push release tags can use this
|
|
289
289
|
procedure without local PyPI credentials. Ordinary branch pushes and pull requests
|
|
290
290
|
do not publish. Manual workflow runs must select an existing `v`-prefixed tag
|
|
291
|
-
(`gh workflow run release.yml --ref v0.
|
|
291
|
+
(`gh workflow run release.yml --ref v0.4.0`); branch runs skip publishing.
|
|
292
292
|
|
|
293
293
|
If the upload fails because account configuration is missing, finish that setup
|
|
294
294
|
and rerun the failed publishing job so it reuses the validated build artifacts.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: smelt-cli
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.4.0
|
|
4
4
|
Requires-Dist: grimp>=3.17
|
|
5
5
|
Requires-Dist: packaging>=24.2
|
|
6
6
|
Requires-Dist: pydantic>=2.13.5
|
|
@@ -17,8 +17,8 @@ Project-URL: Repository, https://github.com/mathisarends/smelt
|
|
|
17
17
|
|
|
18
18
|
Smelt is a static checker for Python codebases maintained by people and coding
|
|
19
19
|
agents. Describe your architecture and adopt source and test conventions in
|
|
20
|
-
`smelt.
|
|
21
|
-
locally, in
|
|
20
|
+
`smelt.yml`; Smelt turns those decisions into actionable checks that can run
|
|
21
|
+
locally, in prek hooks and in CI.
|
|
22
22
|
|
|
23
23
|
Use it both as **architecture as code** and as an executable style guide:
|
|
24
24
|
agents can inspect the policy before editing, check their changes, and iterate
|
|
@@ -32,23 +32,26 @@ on findings before the same project-wide checks run in CI.
|
|
|
32
32
|
| Package contracts | Required modules and public entry points; checks for imports of private implementation modules | [Package contracts](docs/structure.md) |
|
|
33
33
|
| Source conventions | Package-scoped import styles, module names and headers, public-first ordering, internal helpers, and selected readability checks | [Source conventions](docs/structure.md) |
|
|
34
34
|
| Test conventions | Mirrored test paths and opt-in reviews of outcomes, mocks, private access, async awaits, waits, and test-only public members | [Test policies](docs/testing.md) |
|
|
35
|
-
| Agent and CI workflows | Policy briefings, staged and changed checks, JSON, GitHub annotations, SARIF,
|
|
35
|
+
| Agent and CI workflows | Policy briefings, staged and changed checks, JSON, GitHub annotations, SARIF, prek and debt baselines | [Integrations](docs/integrations.md), [agent workflow](docs/agent-workflow.md), [CLI and reports](docs/cli.md), [adoption](docs/adoption.md) |
|
|
36
36
|
|
|
37
37
|
The [rule catalog](docs/rules/README.md) lists each check, its activation and
|
|
38
38
|
default severity. Most rules are opt-in; a declared architecture, package or
|
|
39
39
|
test policy activates the corresponding checks. See [rule activation](docs/rule-selection.md).
|
|
40
40
|
|
|
41
|
-
## What's new in 0.
|
|
41
|
+
## What's new in 0.4.0
|
|
42
42
|
|
|
43
|
-
-
|
|
44
|
-
and
|
|
45
|
-
-
|
|
46
|
-
|
|
47
|
-
- Get
|
|
48
|
-
|
|
43
|
+
- Share local policy across independent workspaces with `extends`, explicit
|
|
44
|
+
overrides and `config show --sources`.
|
|
45
|
+
- Adopt optional reviews for implicit optional defaults (**SMT321**), deep object
|
|
46
|
+
navigation (**SMT322**) and `Base`-prefixed class names (**SMT323**).
|
|
47
|
+
- Get clearer cycle witnesses, shared-helper findings and API ownership evidence;
|
|
48
|
+
unknown inline suppression identifiers now produce **SMT901**.
|
|
49
|
+
- `smelt init` creates `smelt.yml`; existing `smelt.yaml` files still work.
|
|
50
|
+
Custom rules must migrate `BaseRule` to `Rule` and the old protocol to
|
|
51
|
+
`RuleContract`. JSON schema 2 and the default rule set stay unchanged.
|
|
49
52
|
|
|
50
53
|
See the [upgrade guide](docs/upgrading.md) for required steps, copyable examples
|
|
51
|
-
and changes in findings, or the [changelog](CHANGELOG.md#
|
|
54
|
+
and changes in findings, or the [changelog](CHANGELOG.md#040---2026-11-01) for details.
|
|
52
55
|
|
|
53
56
|
## Quick start
|
|
54
57
|
|
|
@@ -63,7 +66,7 @@ uv tool install smelt-cli
|
|
|
63
66
|
From your project root:
|
|
64
67
|
|
|
65
68
|
```bash
|
|
66
|
-
smelt init --maintainability # draft smelt.
|
|
69
|
+
smelt init --maintainability # draft smelt.yml and select source/test checks
|
|
67
70
|
smelt check --show-hints --fail-on warning
|
|
68
71
|
smelt context <feature-or-path> # inspect the policy before making a change
|
|
69
72
|
smelt explain SMT101 # understand a finding and its configuration
|
|
@@ -94,7 +97,7 @@ discovered production file to have a role or a reasoned exclusion. Changed check
|
|
|
94
97
|
compare against `HEAD` by default, including uncommitted changes. For PRs,
|
|
95
98
|
`--changed --base origin/main` compares against the merge base. The
|
|
96
99
|
[integration guide](docs/integrations.md) includes a reusable agent instruction,
|
|
97
|
-
|
|
100
|
+
prek configuration, and GitHub Actions example. The [agent workflow](docs/agent-workflow.md)
|
|
98
101
|
explains staged checks, partial staging and caching.
|
|
99
102
|
|
|
100
103
|
## Scope
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
Smelt is a static checker for Python codebases maintained by people and coding
|
|
4
4
|
agents. Describe your architecture and adopt source and test conventions in
|
|
5
|
-
`smelt.
|
|
6
|
-
locally, in
|
|
5
|
+
`smelt.yml`; Smelt turns those decisions into actionable checks that can run
|
|
6
|
+
locally, in prek hooks and in CI.
|
|
7
7
|
|
|
8
8
|
Use it both as **architecture as code** and as an executable style guide:
|
|
9
9
|
agents can inspect the policy before editing, check their changes, and iterate
|
|
@@ -17,23 +17,26 @@ on findings before the same project-wide checks run in CI.
|
|
|
17
17
|
| Package contracts | Required modules and public entry points; checks for imports of private implementation modules | [Package contracts](docs/structure.md) |
|
|
18
18
|
| Source conventions | Package-scoped import styles, module names and headers, public-first ordering, internal helpers, and selected readability checks | [Source conventions](docs/structure.md) |
|
|
19
19
|
| Test conventions | Mirrored test paths and opt-in reviews of outcomes, mocks, private access, async awaits, waits, and test-only public members | [Test policies](docs/testing.md) |
|
|
20
|
-
| Agent and CI workflows | Policy briefings, staged and changed checks, JSON, GitHub annotations, SARIF,
|
|
20
|
+
| Agent and CI workflows | Policy briefings, staged and changed checks, JSON, GitHub annotations, SARIF, prek and debt baselines | [Integrations](docs/integrations.md), [agent workflow](docs/agent-workflow.md), [CLI and reports](docs/cli.md), [adoption](docs/adoption.md) |
|
|
21
21
|
|
|
22
22
|
The [rule catalog](docs/rules/README.md) lists each check, its activation and
|
|
23
23
|
default severity. Most rules are opt-in; a declared architecture, package or
|
|
24
24
|
test policy activates the corresponding checks. See [rule activation](docs/rule-selection.md).
|
|
25
25
|
|
|
26
|
-
## What's new in 0.
|
|
26
|
+
## What's new in 0.4.0
|
|
27
27
|
|
|
28
|
-
-
|
|
29
|
-
and
|
|
30
|
-
-
|
|
31
|
-
|
|
32
|
-
- Get
|
|
33
|
-
|
|
28
|
+
- Share local policy across independent workspaces with `extends`, explicit
|
|
29
|
+
overrides and `config show --sources`.
|
|
30
|
+
- Adopt optional reviews for implicit optional defaults (**SMT321**), deep object
|
|
31
|
+
navigation (**SMT322**) and `Base`-prefixed class names (**SMT323**).
|
|
32
|
+
- Get clearer cycle witnesses, shared-helper findings and API ownership evidence;
|
|
33
|
+
unknown inline suppression identifiers now produce **SMT901**.
|
|
34
|
+
- `smelt init` creates `smelt.yml`; existing `smelt.yaml` files still work.
|
|
35
|
+
Custom rules must migrate `BaseRule` to `Rule` and the old protocol to
|
|
36
|
+
`RuleContract`. JSON schema 2 and the default rule set stay unchanged.
|
|
34
37
|
|
|
35
38
|
See the [upgrade guide](docs/upgrading.md) for required steps, copyable examples
|
|
36
|
-
and changes in findings, or the [changelog](CHANGELOG.md#
|
|
39
|
+
and changes in findings, or the [changelog](CHANGELOG.md#040---2026-11-01) for details.
|
|
37
40
|
|
|
38
41
|
## Quick start
|
|
39
42
|
|
|
@@ -48,7 +51,7 @@ uv tool install smelt-cli
|
|
|
48
51
|
From your project root:
|
|
49
52
|
|
|
50
53
|
```bash
|
|
51
|
-
smelt init --maintainability # draft smelt.
|
|
54
|
+
smelt init --maintainability # draft smelt.yml and select source/test checks
|
|
52
55
|
smelt check --show-hints --fail-on warning
|
|
53
56
|
smelt context <feature-or-path> # inspect the policy before making a change
|
|
54
57
|
smelt explain SMT101 # understand a finding and its configuration
|
|
@@ -79,7 +82,7 @@ discovered production file to have a role or a reasoned exclusion. Changed check
|
|
|
79
82
|
compare against `HEAD` by default, including uncommitted changes. For PRs,
|
|
80
83
|
`--changed --base origin/main` compares against the merge base. The
|
|
81
84
|
[integration guide](docs/integrations.md) includes a reusable agent instruction,
|
|
82
|
-
|
|
85
|
+
prek configuration, and GitHub Actions example. The [agent workflow](docs/agent-workflow.md)
|
|
83
86
|
explains staged checks, partial staging and caching.
|
|
84
87
|
|
|
85
88
|
## Scope
|
|
@@ -13,7 +13,7 @@ guide for the decision or task at hand:
|
|
|
13
13
|
| Choose checks and understand what enables them | [Rule activation](rule-selection.md) and the [rule catalog](rules/README.md) |
|
|
14
14
|
| Interpret commands, changed checks and machine-readable reports | [CLI and reports](cli.md) |
|
|
15
15
|
| Introduce Smelt to an existing codebase | [Adoption and debt](adoption.md) |
|
|
16
|
-
| Set up an agent loop, prek
|
|
16
|
+
| Set up an agent loop, prek or CI | [Agents, hooks and CI](integrations.md) |
|
|
17
17
|
| Extend Smelt, run its checks or publish a release | [Contributing](../CONTRIBUTING.md) |
|
|
18
18
|
| Review staged agent changes, caching and performance | [Agent workflow](agent-workflow.md) |
|
|
19
19
|
| Understand project direction and known gaps | [Vision](vision.md) and [review backlog](review.md) |
|
|
@@ -15,7 +15,7 @@ stays in `violations`, so a group is one decision, not one more defect.
|
|
|
15
15
|
Accept what remains with a baseline:
|
|
16
16
|
|
|
17
17
|
`smelt debt` records today's violations in `.smelt/debt.json` and sets `debt:` in
|
|
18
|
-
`smelt.
|
|
18
|
+
`smelt.yml`. `smelt check` then fails only on new violations, and SMT903 reports entries
|
|
19
19
|
that were fixed and can leave the file (`smelt debt --prune`).
|
|
20
20
|
Existing debt files remain readable. Run `smelt debt --prune` once before editing imports
|
|
21
21
|
covered by an older baseline to upgrade their fingerprints; pruning accepts no new debt.
|
|
@@ -22,11 +22,11 @@ structure:
|
|
|
22
22
|
internal-public-member: warning
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
In the existing Smelt
|
|
25
|
+
In the existing Smelt prek repository entry, choose `id: smelt-staged`.
|
|
26
26
|
This hook runs `smelt check --staged --fail-on warning`, without passing filenames,
|
|
27
27
|
and always runs so deletions and configuration-only changes receive a check too.
|
|
28
28
|
The existing `smelt` hook retains full-project behavior. A manual invocation of the
|
|
29
|
-
staged hook, including `
|
|
29
|
+
staged hook, including `prek run --all-files`, still checks the Git index.
|
|
30
30
|
Use `smelt check` for the full working-tree inventory and CI.
|
|
31
31
|
|
|
32
32
|
Installing this native build from a Git checkout, including the hook's Python
|
|
@@ -11,9 +11,9 @@ See [rule activation and migration](rule-selection.md) and the
|
|
|
11
11
|
[full catalog](rules/README.md) for the decisions and precedence rules.
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
|
-
smelt init # draft smelt.
|
|
14
|
+
smelt init # draft smelt.yml from the code (also uv workspaces)
|
|
15
15
|
smelt init --maintainability # write individually named source/test review checks
|
|
16
|
-
smelt init --config other.
|
|
16
|
+
smelt init --config other.yml # write a config and editor schema in that directory
|
|
17
17
|
smelt check # whole project
|
|
18
18
|
smelt check --changed # only what the working tree introduced since HEAD
|
|
19
19
|
smelt check --staged --fail-on warning # review the actual commit, including new warnings
|
|
@@ -22,15 +22,27 @@ smelt check --changed --base origin/main --format json
|
|
|
22
22
|
smelt check --changed --format concise # one line per finding with repair advice
|
|
23
23
|
smelt check --strict-coverage # fail on omitted or unclassified production code
|
|
24
24
|
smelt check --show-coverage --format json # include the per-file policy inventory
|
|
25
|
+
smelt check --select SMT321 --fix --unsafe-fixes # use None-only defaults after review
|
|
25
26
|
smelt context user # what applies to a feature, module or path
|
|
26
27
|
smelt explain SMT101 # rationale, examples and config keys of a rule
|
|
27
28
|
smelt rules # full catalog with activation and severity
|
|
28
29
|
smelt debt # record today's violations as known debt
|
|
29
30
|
smelt debt --prune # drop debt entries that were fixed
|
|
30
31
|
smelt config show # the resolved config
|
|
31
|
-
smelt config
|
|
32
|
+
smelt config show --sources --format json # policy inputs and explicit value origins
|
|
33
|
+
smelt config schema # the JSON schema of smelt.yml
|
|
32
34
|
```
|
|
33
35
|
|
|
36
|
+
Normal checks are read-only. `--fix` applies permitted safe ordering fixes.
|
|
37
|
+
Opt-in [SMT321](rules/SMT321.md) reviews `parameter or fallback` for optional
|
|
38
|
+
parameters with a `None` default. Its rewrite to an explicit `is not None`
|
|
39
|
+
conditional also requires `--unsafe-fixes`: falsy values will be preserved and
|
|
40
|
+
custom truthiness will no longer be called. Use this only after reviewing intent.
|
|
41
|
+
Fixes respect selection, scope, suppressions and accepted debt, then check again.
|
|
42
|
+
JSON reports include `fixes.ordering` and `fixes.none_defaults` with modified
|
|
43
|
+
files, counts and skip reasons. `--unsafe-fixes` alone performs no writes;
|
|
44
|
+
`--staged` cannot be combined with `--fix`.
|
|
45
|
+
|
|
34
46
|
Exit codes: `0` clean, `1` violations at or above `--fail-on`, `2` config or usage error.
|
|
35
47
|
A config entry that points at nothing (a mistyped package, a missing test root) is a
|
|
36
48
|
config error, not a silently disabled rule.
|
|
@@ -69,6 +81,20 @@ them in run properties as `usageScopes`. Text omits empty detail fields.
|
|
|
69
81
|
Projects without architecture configuration have no policy-completeness banner
|
|
70
82
|
unless strict coverage is requested. Coverage checks and exit codes still apply.
|
|
71
83
|
|
|
84
|
+
Shared SMT426 helper findings add `shared_helper` groups with the helper identity,
|
|
85
|
+
the exact operation location, one repair and every affected test/call line. Text
|
|
86
|
+
and concise output show the repair once. JSON retains the individual findings;
|
|
87
|
+
totals, exit behavior, debt identities and suppression scope do not change.
|
|
88
|
+
Only visible, compatible findings form a group. Distinct operations in one helper
|
|
89
|
+
remain separate, including operations on the same physical line.
|
|
90
|
+
|
|
91
|
+
SMT424 includes `helper_review` call locations and known inference-limit reasons.
|
|
92
|
+
An imported body being unassessed does not mean it lacks assertions. Existing
|
|
93
|
+
`tests.assertion_helpers` can express a trusted assertion-helper contract; no
|
|
94
|
+
additional helper bodies are inferred. SMT104 includes `graph_kind` and
|
|
95
|
+
`witness_edges` with each selected import's phase. These are additive schema-2
|
|
96
|
+
fields; existing finding identities and default rule activation are preserved.
|
|
97
|
+
|
|
72
98
|
Valid configurations can also produce warnings, such as cyclic `may_depend_on`
|
|
73
99
|
policies. Reports retain these separately from rule violations in JSON
|
|
74
100
|
`configuration_diagnostics` (config path, key, severity and message) and SARIF
|
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
# Explicit rules and editor support
|
|
2
2
|
|
|
3
|
+
Use `smelt.yml` for project configuration; `smelt init` creates it by default.
|
|
4
|
+
Existing `smelt.yaml` files remain supported. When both filenames exist in the
|
|
5
|
+
same directory, Smelt selects `smelt.yml`; `--config` selects a file explicitly.
|
|
6
|
+
|
|
3
7
|
Configure a fixed check once, by the problem it identifies. Its value enables it
|
|
4
8
|
and sets its severity. There is no runtime preset or separate `review_*` switch.
|
|
5
9
|
The same names appear in YAML, CLI selection, `explain`, diagnostics and JSON.
|
|
@@ -47,8 +51,116 @@ These conventions do not assign architecture roles: `--strict-coverage` separate
|
|
|
47
51
|
requires every discovered production source to have an architecture policy or a
|
|
48
52
|
reasoned exclusion.
|
|
49
53
|
|
|
54
|
+
## Shared local policy
|
|
55
|
+
|
|
56
|
+
Independent workspaces can share explicit policy through one local `extends`
|
|
57
|
+
file. Each workspace still has its own configuration and `--config` invocation:
|
|
58
|
+
|
|
59
|
+
```yaml
|
|
60
|
+
# smelt.base.yml (a policy fragment; no project selection is required here)
|
|
61
|
+
version: 1
|
|
62
|
+
rules:
|
|
63
|
+
import-cycle: error
|
|
64
|
+
unbounded-test-wait: warning
|
|
65
|
+
suppressions:
|
|
66
|
+
require_reason: true
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
```yaml
|
|
70
|
+
# runtime/smelt.yml
|
|
71
|
+
extends: ../smelt.base.yml
|
|
72
|
+
project:
|
|
73
|
+
source_roots: [src]
|
|
74
|
+
test_roots: [tests]
|
|
75
|
+
coverage: strict
|
|
76
|
+
architecture:
|
|
77
|
+
features: {root: runtime_extension.features}
|
|
78
|
+
rules:
|
|
79
|
+
unbounded-test-wait: error
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Run `smelt check --config runtime/smelt.yml` from the repository root, or
|
|
83
|
+
`smelt check` from `runtime/`; both select the same project and paths.
|
|
84
|
+
|
|
85
|
+
- `extends` is one nonempty relative local file path, resolved from the file
|
|
86
|
+
containing it. A base may extend another base, up to 32 files. Missing files,
|
|
87
|
+
inheritance cycles, invalid YAML and duplicate YAML keys are configuration errors.
|
|
88
|
+
There is no remote loading, multiple inheritance or automatic cascading discovery.
|
|
89
|
+
- Mappings merge recursively. Explicit child values win. Lists replace the entire
|
|
90
|
+
inherited list, including `[]`; allowances, exclusions and ignores never append
|
|
91
|
+
silently. An empty mapping leaves inherited keys in place. Scalars and `null`
|
|
92
|
+
replace inherited values; the result must satisfy the field's type.
|
|
93
|
+
- Defaults, package discovery and cross-field validation run on the complete
|
|
94
|
+
effective configuration. A fragment need not declare `project` or `version`,
|
|
95
|
+
but the combined result must declare `version: 1` and `project`. The editor
|
|
96
|
+
schema permits fragments; Smelt checks required fields after composition.
|
|
97
|
+
- **All project paths use the selected workspace's directory**, including inherited
|
|
98
|
+
source/test roots, project exclusions, test globs, `ignore.paths` and `debt`.
|
|
99
|
+
For example, inherited `source_roots: [src]` means `runtime/src` above, even if
|
|
100
|
+
written in the repository-level base. Only the `extends` reference itself uses
|
|
101
|
+
its declaring file as the anchor. Dotted module patterns are unchanged.
|
|
102
|
+
- Override rules with the same key spelling as the base. Using both a rule name
|
|
103
|
+
and its SMT code in the effective map remains a duplicate-alias error.
|
|
104
|
+
Unknown rules, invalid severities and strict-coverage restrictions still fail.
|
|
105
|
+
|
|
106
|
+
`smelt config show` prints the complete effective policy. Add `--sources` to wrap
|
|
107
|
+
it with `config`, `sources` (base first, workspace last) and `origins` (explicit
|
|
108
|
+
YAML key locations mapped to absolute declaring-file paths). This works with
|
|
109
|
+
`--format json` or the default YAML; defaults and discovered package names have
|
|
110
|
+
no explicit origin. Inherited validation errors include the declaring file.
|
|
111
|
+
|
|
112
|
+
Every check reloads policy inputs before analysis reuse. Staged checks read every
|
|
113
|
+
base from the captured Git index, never from unstaged working files; bases must
|
|
114
|
+
therefore be staged and inside the repository. Editing a base invalidates dependent
|
|
115
|
+
staged results, including when the workspace YAML itself is unchanged. `--changed`
|
|
116
|
+
and `--staged` continue comparing old and new source under the same effective
|
|
117
|
+
current/index policy. Run a full check to inventory findings after changing policy.
|
|
118
|
+
An explicit check path naming any loaded base widens that workspace's check to
|
|
119
|
+
the whole project. It does not automatically run other workspace configurations.
|
|
120
|
+
The maintainer evaluation runner records every policy input's SHA256 in
|
|
121
|
+
`config_inputs` and rejects a comparison if a base changes during evaluation.
|
|
122
|
+
|
|
50
123
|
## Options and package exceptions
|
|
51
124
|
|
|
125
|
+
API ownership can be stated separately from export-frequency review:
|
|
126
|
+
|
|
127
|
+
```yaml
|
|
128
|
+
structure:
|
|
129
|
+
canonical_exports:
|
|
130
|
+
app.error.types.FeatureError: app.FeatureError
|
|
131
|
+
contracts:
|
|
132
|
+
errors:
|
|
133
|
+
match: app.error
|
|
134
|
+
export_at: 3
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
Both names must resolve to the same analyzed symbol through bounded static
|
|
138
|
+
re-export chains. The target must actually be public, including `__all__` when
|
|
139
|
+
declared. Missing, conflicting and unverifiable ownership is a config error,
|
|
140
|
+
even when SMT109 is not selected. Without an ownership declaration, existing
|
|
141
|
+
SMT109 behavior is retained. Declaring one owner prevents duplicate facade advice
|
|
142
|
+
for that symbol; it does not make other internal aliases public or exempt imports
|
|
143
|
+
from layers, package-public contracts or cycle checks. No callers or exports are
|
|
144
|
+
rewritten. Review the existing export paths before adding another API declaration.
|
|
145
|
+
|
|
146
|
+
Cycle analysis can separately select exact module edges and annotation participation:
|
|
147
|
+
|
|
148
|
+
```yaml
|
|
149
|
+
architecture:
|
|
150
|
+
imports:
|
|
151
|
+
cycles: [modules]
|
|
152
|
+
type_checking: include
|
|
153
|
+
type_checking_cycles: ignore
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
This retains annotation imports in dependency-boundary checks while excluding
|
|
157
|
+
them from cycle graphs. Defaults remain `cycles: [features, layers, siblings]`
|
|
158
|
+
and `type_checking_cycles: include`; `include` respects the global `type_checking`
|
|
159
|
+
setting. Existing scopes aggregate architecture nodes and can form cycles without
|
|
160
|
+
a connected concrete module cycle. Runtime witness
|
|
161
|
+
edges mean outside `TYPE_CHECKING`, including deferred imports, and do not prove
|
|
162
|
+
eager import-time failure.
|
|
163
|
+
|
|
52
164
|
Fixed patterns need no additional policy. Real parameters stay with their concept:
|
|
53
165
|
|
|
54
166
|
```yaml
|
|
@@ -36,7 +36,12 @@ available locally. CI should still run the full check. Use tests and a type
|
|
|
36
36
|
checker as appropriate for the change.
|
|
37
37
|
|
|
38
38
|
|
|
39
|
-
## prek
|
|
39
|
+
## prek hooks
|
|
40
|
+
|
|
41
|
+
Both published hooks run on every commit so edits to shared local policy files
|
|
42
|
+
are checked even when no Python or workspace config file changed. A base file
|
|
43
|
+
can affect unchanged modules. Keep `always_run: true` in local hook definitions
|
|
44
|
+
when using [shared configuration](configuration.md#shared-local-policy).
|
|
40
45
|
|
|
41
46
|
Install [prek](https://prek.j178.dev/installation/) and add the hook to
|
|
42
47
|
`.pre-commit-config.yml`:
|
|
@@ -49,7 +54,7 @@ repos:
|
|
|
49
54
|
name: smelt (new staged findings)
|
|
50
55
|
entry: smelt check --staged --fail-on warning
|
|
51
56
|
language: python
|
|
52
|
-
additional_dependencies: [smelt-cli==0.
|
|
57
|
+
additional_dependencies: [smelt-cli==0.4.0]
|
|
53
58
|
pass_filenames: false
|
|
54
59
|
always_run: true
|
|
55
60
|
require_serial: true
|
|
@@ -68,15 +73,16 @@ can modify files; inspect their changes, rerun and stage the result.
|
|
|
68
73
|
Projects already depending on Smelt can instead use a local `language: system`
|
|
69
74
|
hook with `entry: uv run --locked smelt check --staged --fail-on warning`.
|
|
70
75
|
To install from source, use `repo: https://github.com/mathisarends/smelt`,
|
|
71
|
-
`rev: v0.
|
|
76
|
+
`rev: v0.4.0` and `id: smelt-staged` (or `id: smelt` for full checks). This source
|
|
72
77
|
installation requires Rust 1.88+ and a platform linker. Use the release's
|
|
73
78
|
matching `v`-prefixed Git tag. See the [agent workflow](agent-workflow.md) for
|
|
74
79
|
cache behavior and limitations. Smelt's disposable `.smelt_cache/` creates its
|
|
75
80
|
own `.gitignore`; cache files should not enter commits.
|
|
76
81
|
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
82
|
+
prek uses the [pre-commit hook format](https://pre-commit.com/#creating-new-hooks).
|
|
83
|
+
The published `.pre-commit-hooks.yaml` manifest keeps the required filename;
|
|
84
|
+
project configuration uses `.pre-commit-config.yml`. Existing upstream pre-commit
|
|
85
|
+
integrations can continue using the same published hooks.
|
|
80
86
|
|
|
81
87
|
|
|
82
88
|
## GitHub Actions
|
|
@@ -88,9 +94,9 @@ Install prek in the CI environment before running it (or use `uvx prek run`).
|
|
|
88
94
|
```yaml
|
|
89
95
|
- uses: astral-sh/setup-uv@v7
|
|
90
96
|
- run: prek run --all-files --show-diff-on-failure
|
|
91
|
-
- run: uvx --from smelt-cli==0.
|
|
97
|
+
- run: uvx --from smelt-cli==0.4.0 smelt check --format github
|
|
92
98
|
# optional: code scanning
|
|
93
|
-
- run: uvx --from smelt-cli==0.
|
|
99
|
+
- run: uvx --from smelt-cli==0.4.0 smelt check --format sarif > smelt.sarif || true
|
|
94
100
|
- uses: github/codeql-action/upload-sarif@v3
|
|
95
101
|
with:
|
|
96
102
|
sarif_file: smelt.sarif
|
|
@@ -4,7 +4,7 @@ Status: draft, not implemented.
|
|
|
4
4
|
|
|
5
5
|
## Problem
|
|
6
6
|
|
|
7
|
-
`smelt.
|
|
7
|
+
`smelt.yml` v1 mixes three kinds of settings in the same sections:
|
|
8
8
|
|
|
9
9
|
| Kind | Question it answers | v1 keys today |
|
|
10
10
|
|---|---|---|
|
|
@@ -119,7 +119,7 @@ verify: []
|
|
|
119
119
|
- `version: 2` selects the new layout. `version: 1` keeps loading: the loader rewrites
|
|
120
120
|
it in memory using the table above and reports one deprecation warning per moved
|
|
121
121
|
key. This reuses the mechanism that already migrates `wiring` and `di_frameworks`.
|
|
122
|
-
- `smelt config migrate` rewrites `smelt.
|
|
122
|
+
- `smelt config migrate` rewrites `smelt.yml` to v2 in place, keeping comments where
|
|
123
123
|
possible (a round-trip YAML library such as ruamel.yaml would be a new dependency;
|
|
124
124
|
without it, comments are lost and the command says so).
|
|
125
125
|
- `smelt init` writes v2 from the first release that supports it.
|
|
@@ -29,6 +29,9 @@
|
|
|
29
29
|
| [SMT318](SMT318.md) | redundant-str-enum-value | structure | explicit | hint |
|
|
30
30
|
| [SMT319](SMT319.md) | prefer-package-import | structure | explicit | hint |
|
|
31
31
|
| [SMT320](SMT320.md) | internal-public-module-symbol | structure | explicit | warning |
|
|
32
|
+
| [SMT321](SMT321.md) | implicit-optional-default | structure | explicit | warning |
|
|
33
|
+
| [SMT322](SMT322.md) | deep-object-navigation | structure | explicit | hint |
|
|
34
|
+
| [SMT323](SMT323.md) | no-base-class-prefix | structure | explicit | error |
|
|
32
35
|
| [SMT401](SMT401.md) | test-location | tests | policy | error |
|
|
33
36
|
| [SMT420](SMT420.md) | private-test-access | tests | explicit | error |
|
|
34
37
|
| [SMT421](SMT421.md) | forbidden-test-mock | tests | policy | error |
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# SMT104 import-cycle
|
|
2
2
|
|
|
3
|
-
Import cycles between
|
|
3
|
+
Import cycles between architecture nodes or explicitly selected concrete modules.
|
|
4
4
|
|
|
5
5
|
- **Category:** dependencies
|
|
6
6
|
- **Activation:** explicit — Enable by rule setting or --select.
|
|
@@ -8,7 +8,7 @@ Import cycles between features, between layers, or between sibling modules.
|
|
|
8
8
|
|
|
9
9
|
## Why
|
|
10
10
|
|
|
11
|
-
Cycles mean two parts can only be understood, tested and changed together. They also cause import-order bugs at runtime, unless one edge is imported only under `if TYPE_CHECKING:`; such cycles are marked `(type checking only)`. Imports that other rules already forbid (SMT101, SMT102, SMT106) and outbound imports from declared wiring are left out, so a cycle report means the cycle is built entirely from ordinary allowed dependencies.
|
|
11
|
+
Cycles mean two parts can only be understood, tested and changed together. They also cause import-order bugs at runtime, unless one edge is imported only under `if TYPE_CHECKING:`; such cycles are marked `(type checking only)`. Imports that other rules already forbid (SMT101, SMT102, SMT106) and outbound imports from declared wiring are left out, so a cycle report means the cycle is built entirely from ordinary allowed dependencies. Existing features/layers/siblings scopes aggregate nodes and do not prove a connected concrete runtime module cycle. The opt-in modules scope uses exact resolved modules; its witness prefers runtime edges when a runtime cycle exists. witness_edges records each selected edge's runtime or type-checking phase. Runtime here means outside TYPE_CHECKING, including deferred imports; it does not prove eager import-time failure. type_checking_cycles: ignore excludes annotation edges from cycle analysis while other boundary checks can still include them. Defaults and existing finding identities are retained.
|
|
12
12
|
|
|
13
13
|
## Bad
|
|
14
14
|
|
|
@@ -34,5 +34,6 @@ Break one edge of the cycle: extract the shared piece into a module both can imp
|
|
|
34
34
|
|
|
35
35
|
- `architecture.imports.cycles`
|
|
36
36
|
- `architecture.imports.type_checking`
|
|
37
|
+
- `architecture.imports.type_checking_cycles`
|
|
37
38
|
|
|
38
39
|
Explain it in the terminal with `smelt explain SMT104`.
|