Configuration
simplint reads simplint.toml at the project root. Each key is optional. The first line gives your editor the schema:
#:schema https://raw.githubusercontent.com/antimemes/simplint/main/crates/simplint/simplint.schema.json
profile = "strict" # "strict" or "basic"
words = ["gantry", "sprocket"]
word-lists = ["words.txt", "https://example.com/team-words.txt"]
default-word-lists = true
ignore = ["vendor/", "*.generated.go"]
[rules]
"6.3" = "warning" # "error", "warning" or "off"
[languages.rust] # for the files of one language
words = ["monomorphize"]
word-lists = ["rust-words.txt"]
default-word-lists = true
[languages.rust.rules]
"1.6" = "off"
| Key | Effect |
|---|---|
profile | the severity of each rule, see Rules |
rules | the severity of one rule |
words | the technical names and verbs of the project, see Words |
word-lists | files, URLs and bundled lists of words |
default-word-lists | use the bundled lists (default: true) |
ignore | paths that simplint does not examine, in the syntax of .gitignore |
languages.<name> | the same keys for the files of one language, see Languages |