vale-rules
CLAUDE.md11 starsChanged 11 months agoApache-2.0View on GitHub
When modifying Vale rules in this repo, use the --no-global flag to ensure Vale uses the local styles/ directory instead of the globally installed rules: Without this flag, Vale may load rules from ~/Library/Application Support/vale/styles/Elastic/ (macOS) instead of your local changes. Vale rules use YAML. Key rule types in this repo: Releases can be created in two ways: The workflow will create the tag and release automatically. The GitHub Actions workflow creates a release with the elastic-vale.zip package.
- Commits and pushes
The file
We split this CLAUDE.md into the rules it gives an agent
1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 5
When modifying Vale rules in this repo, use the --no-global flag to ensure Vale uses the local styles/ directory instead of the globally …
≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Development notes
Testing local rule changes
When modifying Vale rules in this repo, use the --no-global flag to ensure Vale uses the local styles/ directory instead of the globally installed rules:
vale --config .vale.ini --no-global <file>Without this flag, Vale may load rules from ~/Library/Application Support/vale/styles/Elastic/ (macOS) instead of your local changes.
Rule file format
Vale rules use YAML. Key rule types in this repo:
conditional— Checks that when pattern A appears, pattern B must also exist (e.g., acronym definitions).existence— Flags matches of a pattern (e.g., banned words).substitution— Suggests replacements for matched patterns.consistency— Ensures consistent usage between two alternatives.
Releasing
Releases can be created in two ways:
Option 1: Manual workflow dispatch (recommended)
- Go to the Actions tab in GitHub
- Click "Run workflow"
- Enter the version number (e.g.,
v1.0.x) - Click "Run workflow"
The workflow will create the tag and release automatically.
Option 2: Push a tag manually
git tag v1.0.x
git push origin v1.0.xThe GitHub Actions workflow creates a release with the elastic-vale.zip package.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.