14 lines
748 B
Markdown
14 lines
748 B
Markdown
# Reportist plugin instructions
|
|
|
|
For a new plugin, read `docs/plugins.md` and `docs/build-cli.md` first.
|
|
|
|
- Keep each plugin's source interpretation and Typst document model inside
|
|
`plugins/<kind>/`. There is no shared report-shaped IR.
|
|
- Share visual primitives through `visual/`; do not copy styles into plugins.
|
|
- Make `build.sh` the public route and keep the plugin usable from a standalone
|
|
Reportist checkout. Use `tools/render-common.sh` for shell output rules.
|
|
- Put data checks and layout in Typst; leave file traversal, staging, hashes,
|
|
overwrite protection, and publication to shell/Python.
|
|
- Add focused plugin tests and preserve approved PDF output. If macro sources
|
|
use the plugin, also run the macro integration/parity suite.
|