datapages AGENTS.md

Code Style

• Follow standard Go conventions (Effective Go).
• Comment as described in code comments.
• Use require from testify for test assertions, use assert only where it makes sense.
• Use table-driven map-based (to ensure random input ordering) tests where applicable with concise name tests as map keys.

Commands

• Lint: mage lint
• Format: mage fmt
• Tidy all Go modules: mage modTidy
• Test (runs lint first): mage test
• Coverage of the generator and of the code it generates: mage coverage
• Build CLI and examples: mage build
• Generate templ files: mage genTempl
• Generate datapages code: mage genDatapages
• Generate all (templ + datapages + docs): mage gen
• Check that all generated code is current: mage checkGen
• Run go fix on all modules: mage goFix
• Run everything: mage all

Project Structure

Internal, used by the CLI and build tooling:

• internal/parser/ - parses the application model from a Go source package.
  • model/ - the data model.
  • validate/ - naming convention validation.
  • errsuggest/ - "did you mean" suggestions for parser errors.
  • internal/ - method kinds, parameter validation, struct inspection, templ linting, type predicates, URL paths.
  • testdata/ - one self-contained module per fixture. Prefix err_ for expected-error cases.
• internal/generator/ - code generation from the parsed model. internal/generator/README.md explains its tests.
• internal/acceptance/ - one module per case: the application, its committed generated code and tests asserting behaviour over HTTP. internal/acceptance/README.md explains how they run and how to record a defect the framework has not fixed yet.
• internal/gotypes/ - go/types predicates and renderings that know nothing about Datapages. Shared by the parser and the generator.
• internal/routepattern/ - net/http ServeMux route pattern parsing.
• internal/structtag/ - the path, query, json and reflectsignal tags.
• internal/subject/ - broker subject rules: the token rule and which subjects an event claims.
• internal/serverscan/ - finds the app package and the target package from the datapages.NewServer calls. AST only, so it reads a main.go naming a package the first run has not written yet.
• internal/templatingbench/ - the templating benchmarks FAQ.md quotes.
• internal/cmd/ - CLI command implementations, package cmd.
• internal/tools/render-pages/ - renders docs/index.html.
• internal/docs-src/ - templ source and CSS for the docs page.
• docs/ - generated GitHub Pages output.
• magefiles/ - build targets.