Giter VIP home page Giter VIP logo

Comments (3)

stevepiercy avatar stevepiercy commented on June 25, 2024 1

@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.

jdkato avatar jdkato commented on June 25, 2024

A few points:

  • There should be very little need for overlap between accept.txt and reject.txt: If, for example, you have "JavaScript" or "Plone" in accept.txt, you do not need to list any case variations of these terms in reject.txt. Vale will enforce the usage of terms exactly as they appear in accept.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 in reject.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.

jdkato avatar jdkato commented on June 25, 2024

Feel free to submit a PR, the docs repo is here: https://github.com/errata-ai/vale.sh

from vale.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.