Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Configuration

memelint reads memelint.toml at the project root. Each key is optional. The first line gives your editor the schema:

#:schema https://raw.githubusercontent.com/antimemes/memelint/main/crates/memelint/memelint.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"
KeyEffect
profilethe severity of each rule, see Rules
rulesthe severity of one rule
wordsthe technical names and verbs of the project, see Words
word-listsfiles, URLs and bundled lists of words
default-word-listsuse the bundled lists (default: true)
ignorepaths that memelint does not examine, in the syntax of .gitignore
languages.<name>the same keys for the files of one language, see Languages