Skip to main content

Module rules

Module rules 

Source
Expand description

The tier-one ruleset: what a reclaimable directory looks like, as data.

The rules themselves live in rules.toml, which is compiled into the binary and can be extended or replaced by a user file. Nothing in this module encodes a single ecosystem, so adding one is a config edit rather than a release.

Structs§

Rule
One marker-anchored rule: the evidence that a project is of some kind, and the directories that kind of project generates.
Ruleset
A parsed, validated and compiled set of rules.

Enums§

Anchor
Where the markers for a rule are looked for, relative to the directory being judged.
Kind
What a reclaimable thing is, from a closed vocabulary ordered by what it costs to lose.
MarkersRequired
Whether one marker is enough, or all of them are needed.
RuleError
Why a ruleset could not be loaded.