mirror of
https://github.com/bitcoin/bips.git
synced 2026-04-06 16:16:45 +00:00
ci: add typo checking
typos is a powerful source code spell checker. Adds a CI job that runs on every PR and push to master (but can also be run manually with workflow_dispatch) that checks for typos. Adds a config file .typos.toml that deals with false positives and only checks for top-level/one-level .mediawiki and .md files.
This commit is contained in:
44
.typos.toml
Normal file
44
.typos.toml
Normal file
@@ -0,0 +1,44 @@
|
||||
[default]
|
||||
extend-ignore-re = [
|
||||
# NOTE: use here for regex patterns
|
||||
"xpub.*",
|
||||
"xprv.*",
|
||||
"3.*", # address
|
||||
"5.*", # address
|
||||
"private_key .*",
|
||||
"privkey .*",
|
||||
"tt.*", # <tt> tags
|
||||
"code.*", # <code> tags
|
||||
"\\w*<sub>", # prefix for <sub> tags
|
||||
"OP_SUCCESSx|\\d+",
|
||||
"pay.*",
|
||||
"ser.*",
|
||||
"prefix.*",
|
||||
"value: .*",
|
||||
]
|
||||
|
||||
[default.extend-words]
|
||||
# NOTE: use here for false-positives
|
||||
anc = "anc"
|
||||
PSBT = "PSBT"
|
||||
ser = "ser"
|
||||
# Names
|
||||
Atack = "Atack"
|
||||
Meni = "Meni"
|
||||
Ono = "Ono"
|
||||
|
||||
[files]
|
||||
extend-exclude = [
|
||||
"/*/*.csv",
|
||||
"/*.d*",
|
||||
"/*/*.d*",
|
||||
"/*/*.go",
|
||||
"/*/*.json",
|
||||
"/*/*/*.json",
|
||||
"/*/*.mod",
|
||||
"/*/*.proto",
|
||||
"/*/*.py",
|
||||
"scripts",
|
||||
"/*/*.s*",
|
||||
"/*/*.t*",
|
||||
]
|
||||
Reference in New Issue
Block a user