Hackage :: [Package]

gachi-scaffold: Declarative multi-package workspace scaffolding engine for Gachi

[ development, library, unclassified ] [ Propose Tags ] [ Report a vulnerability ]

Declarative multi-package workspace scaffolding engine for Gachi. Generates Hackage-compliant multi-package repositories, cabal configurations, physical verification gates, git hooks, and documentation skeletons.

[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0, 0.1.0.1
Change log CHANGELOG.md
Dependencies base (>=4.14 && <5), containers (>=0.6 && <0.9), directory (>=1.3 && <1.4), filepath (>=1.4 && <1.6), gachi-core (>=0.1 && <0.2), gachi-schema (>=0.1 && <0.2), polytropos-core (>=0.1 && <0.2), text (>=2.0 && <2.2) [details]
Tested with ghc ==9.10.3, ghc ==9.12.4, ghc ==9.14.1
License EUPL-1.2
Author Nadia Yvette Chambers
Maintainer nadia.yvette.chambers@ik.me
Uploaded by nyc at 2026-11-03T16:16:46Z
Category Development
Home page https://github.com/NadiaYvette/gachi
Bug tracker https://github.com/NadiaYvette/gachi/issues
Source repo head: git clone https://github.com/NadiaYvette/gachi(packages/gachi-scaffold)
Distributions
Reverse Dependencies 3 direct, 1 indirect [details]
Downloads 5 total (5 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for gachi-scaffold-0.1.0.1

[back to package description]

gachi-scaffold

Declarative Multi-Package Workspace Scaffolding Engine for Gachi

gachi-scaffold generates complete, turn-key Haskell workspaces adhering strictly to the canonical ecosystem standardization matrix (~/src/PLAN.md ยง1 and Note [Ecosystem Standardization Invariants] [ref:note-ecosystem-standardization]).

Overview

Given a declarative Project specification from gachi-schema (loaded from Dhall or instantiated in Haskell), gachi-scaffold synthesizes the entire canonical repository skeleton:

  1. Multi-Package Hierarchy:

    • Modular package directories (packages/<name>/src, packages/<name>/test)
    • Fully configured Cabal 3.0 package manifests (packages/<name>/<name>.cabal)
    • Initial Haskell modules with comprehensive Haddock documentation, passing the \(\ge 50\%\) comment density gate out of the box
    • Standard Hspec test suites (packages/<name>/test/Main.hs)

  2. Root Toolchain & Build Assets:

    • Multi-package cabal.project pinning GHC (9.14.1) and Cabal (3.18)
    • Developer configuration template cabal.project.local.example
    • Strict HLint configuration .hlint.yaml enforcing zero-hint cleanliness
    • Git commit message template .gitmessage with Sarutahiko AI attribution rules
    • Git hooks .githooks/commit-msg (RFC 2822 trailer validation) and .githooks/pre-commit (tagref and linkcheck validation)

  3. Canonical Documentation Corpus:

    • System design note docs/notes/<PROJECT>_DESIGN.md
    • Corpus inventory docs/INDEX.md
    • Interactive getting started guide docs/TUTORIAL.md
    • Token-conservation guide docs/NEWBIE_GUIDE.md
    • Architectural governance guide docs/MAINTAINER_GUIDE.md
    • Documentation policy docs/notes/DOC_STRATEGY.md
    • Commit attribution guidelines docs/notes/COMMIT_ATTRIBUTION.md

  4. Turnkey Verification Suite (bin/):

    • 5-gate physical verification script bin/<project>-verify
    • Mechanical Tagref cross-reference validator bin/<project>-tagref
    • Markdown relative link & anchor validator bin/<project>-linkcheck
    • In-code comment density audit harness bin/<project>-cloc
    • Symbol tag indexer bin/generate-tags

  5. Operational Governance & Agent Guidance:

    • Strategic roadmap PLAN.md and active frontier STATE.md
    • Agent advisory context AGENTS.md and CLAUDE.md pointer
    • Subdivided operational rules under .agents/rules/

Invariants & Notes

  • Note [Ecosystem Standardization Invariants] [ref:note-ecosystem-standardization]: Every generated repository skeleton must satisfy all 5 physical verification gates immediately upon creation without human intervention.
  • Note [Dhall Parameterized Skeleton Templating] [ref:note-dhall-skeleton-templating]: All template rendering functions are pure, deterministic functions of the underlying Project schema.

License

EUPL-1.2 (European Union Public Licence 1.2).