Basic usage
Let's use an example. Say we want to enforce specific terminology in our documentation.
Add a rule
.floe/rules/terminology.md
Make sure to always use the following terminology instead of these alternatives:
- `main` instead of `master`
- "Floe" instead of "Floe.dev"
# ...Add the rule to a ruleset
.floe/config.json
{
"$schema": "https://unpkg.com/@floe/config@0.1.0-alpha.5/schema.json",
"reviews": {
"maxFileEvaluations": 5,
"maxDiffEvaluations": 20
},
"rulesets": {
"docs": {
"include": ["**/*.mdx"],
"rules": {
"terminology": "error"
}
}
}
}Profit!
We can now start using the CLI to review our changes.
Review unstaged changes
# This is the same as running `floe review diff HEAD`
floe review diffReview the last commit and fix it
floe review diff HEAD~1 --fixReview an existing file
floe review files some/path/to/file.md