Comments (3)
@jdkato thank you, that guidance was super helpful. Not only did I cure all misspellings of Node.js, but about a dozen other words that we specifically use.
I would like to submit a PR that could help clarify the usage of accept.txt
and reject.txt
in https://vale.sh/docs/topics/vocab/#file-format. The key phrase of "little need for overlap" was a 💡 moment for me. I'd like to add a fourth bullet point.
- Entries in `accept.txt` and `reject.txt` should need little overlap, if any. For example, if you add `JavaScript` to `accept.txt`, then you do not need to add an overlapping regular expression entry of `[Jj]avascript` in `reject.txt`. Vale will enforce correct casing by virtue of the entry's presence in `accept.txt`.
Thoughts?
from vale.
A few points:
- There should be very little need for overlap between
accept.txt
andreject.txt
: If, for example, you have "JavaScript" or "Plone" inaccept.txt
, you do not need to list any case variations of these terms inreject.txt
. Vale will enforce the usage of terms exactly as they appear inaccept.txt
, so something like "javascript" will be an error. - You should be as specific as possible with terms in
reject.txt
(especially when dealing with word boundaries): If you want to use "Node.js" but disallow the use of "js", you can write something like[^.]js
inreject.txt
.
Looking at your files, I would doing something along the lines of this:
[Aa]sync
[Bb]ackend
JavaScript
Node
npm
nvm
Pastanaga
Plone
Razzle
RichText
Volto
Vue
Zope
(accept.txt
)
api
[^.]js
[Nn]odejs
(reject.txt
)
from vale.
Feel free to submit a PR, the docs repo is here: https://github.com/errata-ai/vale.sh
from vale.
Related Issues (20)
- snapcraft.io package oudated HOT 8
- Vale 3 not working with AsciiDoc and diagrams (PlantUML, Mermaid) HOT 1
- Support custom comment patterns (e.g., MDX) HOT 2
- Equals condition doens't work HOT 1
- Bug with Asciidoc image macros HOT 2
- Vale not taking config file from `doc/.vale.ini` HOT 3
- Make Vale's format support extensible HOT 1
- Document style sharing across projects HOT 2
- How to add per-project spelling ignore list HOT 1
- Part of speech identification seems buggy HOT 2
- Spelling with hunspell-nl dictionary results in error E201 Invalid value
- Help test Vale's new Chrome extension! HOT 16
- 404 when attempting to download chrome extension
- Chrome extension: Unable to connect HOT 9
- terms in reject.txt not working HOT 4
- Support qdoc markup
- Use tree-sitter libraries for parsing HOT 5
- Words separated by spaces in exceptions list still being flagged as errors
- Titles with 'To' (with T in caps) reported as error when following title-style capitlization HOT 3
- Styles path not found after following initial setup documentation HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from vale.