Skip to content

Commit

Permalink
.typos.toml: add false positive typos config
Browse files Browse the repository at this point in the history
Problem: The current typos workflow check only checks a select
number of files because there are so many false positives in
flux-core.

Solution: Add a .typos.toml configuration file to eliminate false
positives so we can run the typo check on all of flux-core.  The
config file either skips files with lots of false positives or
lists common false positives we wish to ignore.

Fixes #5075
  • Loading branch information
chu11 committed Apr 21, 2023
1 parent 587876c commit 76a5ad9
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# do not check code copied into the project
# do not check sha code, lots of hashing false positives
# do not check testing data
[files]
extend-exclude = [
"config/*",
"src/common/libev/*",
"src/common/libccan/*",
"src/common/liblsd/*",
"src/common/libtomlc99/*",
"src/bindings/python/flux/utils/parsedatetime/*",
"t/sharness.sh",
"src/common/libutil/sha1.c",
"src/common/libutil/test/sha1.c",
"t/hwloc-data/*",
]

[default.extend-words]
# in hwloc output
hsi = "hsi"
# commonly used names/variables that aren't typos
fo = "fo"
ba = "ba"
inout = "inout"
trun = "trun"
fullset = "fullset"
mone = "mone"

0 comments on commit 76a5ad9

Please sign in to comment.