Best way to ignore spelling for multi-word phrases?

[cjcarpen]

We'd like to ignore spelling for exact multi-word phrases, with our use case being product names. From my testing, it appears that the spelling rules (either with a custom spelling style or using Vocab lists) support only a single word per entry in the ignore/accept files.

For example, say there's a product name "Yellow Bananaz". We don't want "bananaz" or "Bananaz" to be allowed outside of this exact phrase. How do we configure Vale to ignore specific multi-word phrases for spelling?

[jdkato]

You're correct that, with Vale, spell check is a single-word operation. That said, if I'm understanding correctly, there are two objectives here:

1. You don't want "Bananaz" to raise a spelling error.
2. You do want something like "Blue Bananaz" (essentially, anything that isn't exactly "Yellow Bananaz") to raise a style error.

If this is indeed the case, I would create a custom spelling-based rule that excludes the relevant parts of products names:

extends: spelling
message: "Did you really mean '%s'?"
level: error
filters:
  - '[Bb]ananaz'

And then create another rule, perhaps Products.yml, that enforces the correct use of product names:

---
extends: substitution
message: "Use '%s' instead of '%s'"
level: error
ignorecase: false
swap:
  # This will catch cases like "Blue Bananaz", "Yellow bananaz", etc.
  '(?:[^\s]*) ?[Bb]ananaz': Yellow Bananaz

[r4fterman]

Hi @jdkato,
I am also trying to get phrases working and unfortunately the current documentation gives the impression that single word and phrases aresupported for acception/rejection in a vocabulary. The Overview mentions 2x "phrase" as a supported thing. But this seems to be incorrect.

I recommend to correct this.

Regards, Roman

[jdkato]

Hi @jdkato,

I am also trying to get phrases working and unfortunately the current documentation gives the impression that single word and phrases aresupported for acception/rejection in a vocabulary. The Overview mentions 2x "phrase" as a supported thing. But this seems to be incorrect.

I recommend to correct this.

Regards, Roman

Vocabularies do support phrases (multi-word tokens).

What are you trying to do exactly?

[r4fterman]

I am placing phrases in the accept.txt under my custom Vocab but it is not leading to whitelist for such phrases.

I have my

stlye/Vocab/myvocab/accept.txt

foo bar giz

.vale.ini

...
Vocab = myvocab

BasedOnStyles = mystyle
...

I also use my custom style with Spelling.yml as I need to include a different dictionary:

style/mystyle/Spelling.yml

# Uses a de_DE dictionary
extends: spelling
message: "Did you really mean '%s'?"
level: error
dicpath: dics
dictionaries:
  - de_DE

When I run vale it still reports:

122:27 error Did you really mean 'foo'? MyStyle.Spelling
122:39 error Did you really mean 'bar'? MyStyle.Spelling
122:44 error Did you really mean 'giz'? MyStyle.Spelling

Might be that my Spelling.yml is not correct. As with the build-in Vale spelling rule it seems to work.

[jdkato]

If you're only using a vocabulary as an exception list for spell check, you can add the words individually:

foo 
bar 
giz

(in this case, you may also want to turn off Vale.Terms.)

Otherwise, you can leave foo bar giz in accept.txt. And add the individual words directly to your spelling rule.

[destlerVI]

Hi @jdkato,
I have a similar question:
I am trying to add multi-word phrases as exceptions: for my substitution.
I did not manage to do so and wanted to ask if it is possible.
If not, what could be a workaround? Would having a Vocabulary containing this phrase stop my substitution from throwing a warning?
BR Daniel