Search for flagWords based on regular expression

[gituserjava]

It would be great if words in flagWords can be defined using a regular expression. In our use case, a word can exist in string and as a yaml field in a yaml file. We should raise error only if word is incorrect in yaml field. Example below.

company:
  - companyId:
      name: This is companyId of the company
      type: Manufacturing
  - route:
      name: This is distribution route
      type: Transport

cspell.yaml

flagWords:
- companyId: companyIdentifier

In the above yaml, I want error to be thrown only for yaml field name companyId on line 2 but not on line 3 because we are more concerned in spelling errors in yaml field and not the descriptions.

Please advise.

[nschonni]

Sounds like you're looking for a YAML schema validator, not a spell checker https://stackoverflow.com/questions/5060086/yaml-schema-validation

[gituserjava]

No schema validation does not help because I have different use case as well. Let’s say I want to flag all words (lastModifiedBy, recentlyModifiedBy, lastModifiedByUserId) that containsModifiedBy, how would I do that? Sometimes these words could be the descriptions which are in plain text. In the above case I want to flag such words and give alternate word. Instead of specifying each word under flag words, it would be great if flagWords supports regular expressions.

[Jason3S]

@gituserjava,

Since you are running cspell as part of your service, this is a feature you can easily implement in your server side code.

[gituserjava]

@Jason3S , are you saying use one word modified as flag word and filter out the unwanted errors and return only the errors that we are interested?