pay-respects/module-runtime-rules/README.md

21 lines
791 B
Markdown
Raw Normal View History

2025-02-12 17:22:00 +01:00
# Runtime Rules Module
2025-04-22 15:38:16 +02:00
Module for [pay-respects] which allows you to add rules at runtime.
2025-02-12 17:22:00 +01:00
2025-04-22 15:38:16 +02:00
Syntax is currently 100% compatible with [upstream's compile-time rules].
[pay-respects]: https://codeberg.org/iff/pay-respects
[upstream's compile-time rules]: https://codeberg.org/iff/pay-respects/src/branch/main/rules.md
2025-02-12 17:22:00 +01:00
Rules are searched in these directories:
- `XDG_CONFIG_HOME`, defaults to `$HOME/.config`.
- `XDG_CONFIG_DIRS`, defaults to `/etc/xdg`.
- `XDG_DATA_DIRS`, defaults to `/usr/local/share:/usr/share`.
2025-04-22 15:38:16 +02:00
The actual rule file should be placed under `pay-respects/rules/`, for example:
`~/.config/pay-respects/rules/cargo.toml`. To avoid parsing unnecessary rules,
the name of the file **MUST** match the command name.
An exception is `_PR_GENERAL.toml` that is always parsed.