Skip to content

Commit

Permalink
initiates a substitution set, updates readme
Browse files Browse the repository at this point in the history
  • Loading branch information
m4sterbunny committed Sep 17, 2024
1 parent 0063c19 commit c18209c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 6 deletions.
15 changes: 9 additions & 6 deletions spelling/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?


13 changes: 13 additions & 0 deletions spelling/styles/Consensys/CaseSensitive-Substitution.yaml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit c18209c

Please sign in to comment.