What is the difference between words and ignoreWords

[xnivaxhzne]

It is mentioned here that

words - a list of words to be considered correct.
ignoreWords - a list of words to be ignored (even if they are in the flagWords).

I don't get the difference bw those two. doesn't both do the same thing?

[Jason3S]

@kavinkuma6,

The logic of when a word is considered OK:

1. Is the word in ignoreWords? Yes, then it is OK.
2. Is the word in flagWords? Yes, then it is NOT OK.
3. Is the word in words? Yes, then it is OK.
4. Otherwise it is NOT OK.

CSpell allows for multiple configure files.

Example: Say an organization want to use the British spelling of colour and to discourage the American color. But, there is a subfolder where color should be allowed.

\cspell.config.yaml
   words: [colour]
   flagWords: [color]
\README.md
   colour - is OK.
   color - is NOT OK.
\subfolder
   cspell.config.yaml
      ignoreWords: [color]
   README.md
      colour - is OK.
      color - is OK.

[xnivaxhzne]

Thank you @Jason3S for replying back.

So to summarize, ignoreWords job is to override the flagWords set in some parent directory by ignoring it and allow the word.

[Jason3S]

Also, terms found in ignoreWords won't be shown in the suggestions.

[xnivaxhzne]

Thank you @Jason3S