diff --git a/spelling/README.md b/spelling/README.md index fbab88f..2efb941 100644 --- a/spelling/README.md +++ b/spelling/README.md @@ -46,13 +46,16 @@ Vale too. ## ToDo -### Linea +### Overrides + +Attempted to overcome false positives with: + +1. /styles/ignore which references the Consensys-common/ignore.txt text file (which should override Vale.Spelling) +2. With styles/Consensys/Overridesyaml which is a dummy extend of "existence" to allow use of an exceptions +list {I am not convinced this is working and its not a ssot method as it will need to repeat the ignore items +for Vale.Spelling} + -1. We seem to be using proper noun for Coordinator but not for prover -2. Proper Linea Voyage -### General -2. Will links be false positives, e.g. Can linting for " CLI" work to avoid false positives for links? -3. Can we use reject [here to prevent links being put in this format, is it covered another way? diff --git a/spelling/styles/Consensys/CaseSensitive-Substitution.yaml b/spelling/styles/Consensys/CaseSensitive-Substitution.yaml new file mode 100644 index 0000000..ada5b9c --- /dev/null +++ b/spelling/styles/Consensys/CaseSensitive-Substitution.yaml @@ -0,0 +1,13 @@ +extends: substitution +message: For system-specific term, consider %s instead of "%s" +ignorecase: false +level: warn +action: + name: replace +swap: + # Linea Coordinator system component probably proper noun + coordinator: Coordinator + # Linea Prover system component probably proper noun + prover: Prover + # Linea Voyage + voyage: Voyage