plating 2025-08-18
Garnish-to-plating rename and full codebase restructuring
177 files · 22,738+ · 9,969-

Garnish to plating package rename

decouple internal
8 files changed
  • __init__.py New plating package init replacing garnish
  • _version.py Version module for the plating package
  • __init__.py Adorner subpackage init (renamed from dresser)
  • adorner.py Adorner implementation (renamed from dresser)
  • api.py Adorner API (renamed from dresser API)
  • finder.py Adorner finder for discovering undocumented components
  • __init__.py Old garnish package init (retained alongside new plating)
  • cli.py Old garnish CLI (replaced by modular plating CLI)
  • Renamed the entire src/garnish/ package to src/plating/, including all submodules decouple internal
    4 files
    • __init__.py
    • _version.py
    • plating.py
    • errors.py
  • Renamed “dresser” concept to “adorner” (src/plating/adorner/) – the system that creates documentation bundles for undocumented components decouple internal
    4 files
    • __init__.py
    • adorner.py
    • api.py
    • finder.py
  • Renamed .garnish bundle directories to .plating bundle directories decouple internal
    4 files
    • adorner.tmpl.md
    • basic.py
    • filtered.py
    • readme.tmpl.md
  • Updated all test files to reference plating instead of garnish (e.g., test_dresser.py removed, test_adorner.py added) qualify internal
    3 files
    • test_adorner.py
    • test_plating_bundle.py
    • test_plating_discovery.py

Modular CLI restructuring

instantiate architectural
11 files changed
  • __init__.py CLI package init
  • main.py CLI main entry point
  • adorn.py Adorn CLI command
  • info.py Info CLI command
  • plate.py Plate CLI command
  • stats.py Stats CLI command
  • validate.py Validate CLI command
  • auto_detect.py Auto-detection helper for CLI
  • examples.py Examples display helper
  • output.py Output formatting helper
  • pyproject.py Pyproject.toml parsing utility
  • Replaced monolithic src/garnish/cli.py (312 lines) with a modular CLI structure under src/plating/cli/ decouple behavioral
    2 files
    • __init__.py
    • main.py
  • New CLI commands: adorn, info, plate, stats, validate – each in its own module under cli/commands/ instantiate behavioral
    5 files
    • adorn.py
    • info.py
    • plate.py
    • stats.py
    • validate.py
  • Added CLI helper modules for auto-detection, examples display, output formatting, and pyproject.toml parsing baseline errata
    4 files
    • auto_detect.py
    • examples.py
    • output.py
    • pyproject.py

New subsystems

instantiate internal
15 files changed
  • grouped.py Grouped documentation compilation
  • single.py Single-component documentation compilation
  • processor.py Schema extraction processor
  • formatters.py Schema output formatters
  • helpers.py Schema helper utilities
  • engine.py Template engine core
  • filters.py Template filters
  • functions.py Template functions
  • generator.py Template generator
  • metadata.py Template metadata handling
  • processor.py Template processor
  • finder.py Component discovery finder
  • defaults.py Default configuration values
  • runtime.py Runtime configuration
  • nav_generator.py MkDocs navigation generator
  • Compiler system (src/plating/compiler/): Added grouped.py and single.py for single-component and grouped documentation compilation instantiate internal
    2 files
    • grouped.py
    • single.py
  • Schema system (src/plating/schema/): New processor.py, formatters.py, helpers.py for extracting and formatting Terraform provider schemas interface errata
    3 files
    • processor.py
    • formatters.py
    • helpers.py
  • Templating system (src/plating/templating/): Refactored template engine, filters, functions, generator, metadata handling, and processor into dedicated modules decouple internal
    6 files
    • engine.py
    • filters.py
    • functions.py
    • generator.py
    • metadata.py
    • processor.py
  • Discovery system (src/plating/discovery/): Component discovery via finder.py decouple internal
    1 file
    • finder.py
  • Config system (src/plating/config/): Runtime configuration and defaults baseline internal
    2 files
    • defaults.py
    • runtime.py
  • MkDocs integration (src/plating/mkdocs/): Navigation generator for MkDocs documentation sites decouple internal
    1 file
    • nav_generator.py

New core modules

decouple behavioral
12 files changed
  • types.py Type definitions for the plating system
  • decorators.py Decorator utilities
  • registry.py Component registry
  • error_handling.py Error handling utilities
  • errors.py Error hierarchy
  • markdown_validator.py Markdown output validation
  • example_compiler.py Example code compilation
  • base.py Bundle base class
  • function.py Function bundle
  • doc_generator.py Documentation generator
  • index_merger.py Index merger utility
  • project_utils.py Project-level utilities
  • src/plating/types.py: Type definitions (452 lines) for the plating system decouple internal
    1 file
    • types.py
  • src/plating/decorators.py: Decorator utilities (258 lines) decouple internal
    1 file
    • decorators.py
  • src/plating/registry.py: Component registry (259 lines) decouple internal
    1 file
    • registry.py
  • src/plating/error_handling.py and src/plating/errors.py: Comprehensive error hierarchy decouple internal
    2 files
    • error_handling.py
    • errors.py
  • src/plating/markdown_validator.py: Markdown output validation decouple behavioral
    1 file
    • markdown_validator.py
  • src/plating/example_compiler.py: Example code compilation decouple internal
    1 file
    • example_compiler.py
  • src/plating/bundles/: Bundle abstractions (base.py, function.py) decouple internal
    2 files
    • base.py
    • function.py
  • src/plating/core/: Core utilities including doc_generator.py, index_merger.py, project_utils.py decouple internal
    3 files
    • doc_generator.py
    • index_merger.py
    • project_utils.py

Documentation overhaul

instantiate behavioral
11 files changed
  • mkdocs.yml MkDocs site configuration
  • api-reference.md API reference documentation
  • cli-reference.md CLI reference documentation
  • index.md Getting started guide
  • quick-start.md Quick start guide
  • examples.md Usage examples
  • performance.md Performance guide
  • troubleshooting.md Troubleshooting guide
  • authoring-bundles.md Bundle authoring guide
  • registry-pattern.md Registry pattern documentation
  • capabilities.md Capabilities reference
  • Removed old architecture docs (docs/architecture/01-07) specify internal
    7 files
    • 01-overview.md
    • 02-conformance-testing-strategy.md
    • 03-rpc-matrix-specification.md
    • 04-garnish-asset-bundle-system.md
    • 05-wire-protocol-details.md
    • 06-polyglot-cli-strategy.md
    • 07-stock-service-design.md
  • Added MkDocs configuration (mkdocs.yml) instantiate internal
    1 file
    • mkdocs.yml
  • New comprehensive docs: API reference, CLI reference, getting started guide, quick start, examples, performance guide, troubleshooting, bundle authoring, registry pattern streamline behavioral
    9 files
    • api-reference.md
    • cli-reference.md
    • index.md
    • quick-start.md
    • examples.md
    • performance.md
    • troubleshooting.md
    • authoring-bundles.md
    • registry-pattern.md
  • Archived historical API docs specify behavioral
    1 file
    • capabilities.md

Testing

qualify behavioral
14 files changed
  • test_adorner.py Adorner unit tests
  • test_capability_grouping.py Capability grouping tests
  • test_cli_integration.py CLI integration tests
  • test_foundation_integration.py Foundation integration tests
  • test_grouped_compiler.py Grouped compiler tests
  • test_guide_discovery.py Guide discovery tests
  • test_index_merger.py Index merger tests
  • test_mkdocs_nav_generator.py MkDocs nav generator tests
  • test_modern_api.py Modern API tests
  • test_plating_bundle.py Plating bundle tests
  • test_plating_discovery.py Plating discovery tests
  • test_schema.py Schema tests
  • test_subcategory_frontmatter.py Subcategory frontmatter tests
  • test_full_plate_workflow.py Full plate workflow integration test
  • Added 15+ new test files covering adorner, capability grouping, CLI integration, foundation integration, grouped compiler, guide discovery, index merger, MkDocs nav generation, modern API, plating bundles, plating discovery, schema, and subcategory frontmatter qualify behavioral
    13 files
    • test_adorner.py
    • test_capability_grouping.py
    • test_cli_integration.py
    • test_foundation_integration.py
    • test_grouped_compiler.py
    • test_guide_discovery.py
    • test_index_merger.py
    • test_mkdocs_nav_generator.py
    • test_modern_api.py
    • test_plating_bundle.py
    • test_plating_discovery.py
    • test_schema.py
    • test_subcategory_frontmatter.py
  • Removed old garnish-era tests (test_dresser.py, test_end_to_end.py, test_garnish_bundle.py, test_integration.py, test_plater.py) qualify internal
    5 files
    • test_dresser.py
    • test_end_to_end.py
    • test_garnish_bundle.py
    • test_integration.py
    • test_plater.py
  • Added integration test directory with test_full_plate_workflow.py qualify internal
    1 file
    • test_full_plate_workflow.py

Build and CI

baseline internal
4 files changed
  • ci.yml CI pipeline workflow
  • release.yml Release workflow
  • VERSION Version file
  • pyproject.toml Project metadata and dependencies
  • Added .github/workflows/ci.yml (138 lines) for CI pipeline baseline internal
    1 file
    • ci.yml
  • Added conform.py for conformance testing qualify internal
    1 file
    • conform.py
  • Added VERSION file baseline internal
    1 file
    • VERSION
  • Updated pyproject.toml with new dependencies and project metadata baseline internal
    1 file
    • pyproject.toml
  • Removed old shell setup scripts (env.ps1, env.sh, setup.sh) baseline internal
    3 files
    • env.ps1
    • env.sh
    • setup.sh
changelog → 2025-08-20 plating →