mirror of
https://github.com/curl/curl.git
synced 2026-05-17 02:06:21 +03:00
GHA/checksrc: expand spellcheck, fix issues found
- codespell: break logic out into its own runnable script. Allowing to run it on local machines. - codespell: install via `pip`, bump to latest version. - codespell: show version number in CI log. - codespell: drop no longer needed word exception: `msdos`. - codespell: include all curl source tree, except `packages` and `winbuild`. Drop an obsolete file exclusion. - add new spellchecker job using the `typos` tool. It includes the codespell dictionary and a couple more. Use linuxbrew to install it. This takes 10 seconds, while installing via `cargo` from source would take over a minute. - codespell: introduce an inline ignore filter compatible with `cspell` Make `typos` recognize it, too. Move single exceptions inline. Fix new typos found. Also rename variables and words to keep spellchecking exceptions at minumum. This involves touching some tests. Also switch base64 strings to `%b64[]` to avoid false positives. Ref: https://github.com/crate-ci/typos/blob/master/docs/reference.md Ref: https://github.com/codespell-project/codespell?tab=readme-ov-file#inline-ignore Ref: https://github.com/codespell-project/codespell/issues/1212#issuecomment-1721152455 Ref: https://cspell.org/docs/Configuration/document-settings Closes #17905
This commit is contained in:
parent
792a61e204
commit
0260e8465a
81 changed files with 279 additions and 206 deletions
27
.github/scripts/codespell-ignore.txt
vendored
27
.github/scripts/codespell-ignore.txt
vendored
|
|
@ -1,16 +1,21 @@
|
|||
# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
||||
#
|
||||
# SPDX-License-Identifier: curl
|
||||
anonymou
|
||||
aNULL
|
||||
bu
|
||||
clen
|
||||
te
|
||||
wont
|
||||
statics
|
||||
nome
|
||||
wast
|
||||
numer
|
||||
anull
|
||||
CNA
|
||||
hel
|
||||
htpt
|
||||
inout
|
||||
msdos
|
||||
ba
|
||||
fo
|
||||
ede
|
||||
PASE
|
||||
passwor
|
||||
perfec
|
||||
proxys
|
||||
seh
|
||||
ser
|
||||
strat
|
||||
te
|
||||
UE
|
||||
WONT
|
||||
|
|
|
|||
20
.github/scripts/codespell.sh
vendored
Executable file
20
.github/scripts/codespell.sh
vendored
Executable file
|
|
@ -0,0 +1,20 @@
|
|||
#!/bin/sh
|
||||
# Copyright (C) Viktor Szakats
|
||||
#
|
||||
# SPDX-License-Identifier: curl
|
||||
|
||||
set -eu
|
||||
|
||||
cd "$(dirname "${0}")"/../..
|
||||
|
||||
# shellcheck disable=SC2046
|
||||
codespell \
|
||||
--skip '.github/scripts/spellcheck.words' \
|
||||
--skip '.github/scripts/typos.toml' \
|
||||
--skip 'docs/THANKS' \
|
||||
--skip 'packages/*' \
|
||||
--skip 'scripts/wcurl' \
|
||||
--skip 'winbuild/*' \
|
||||
--ignore-regex '.*spellchecker:disable-line' \
|
||||
--ignore-words '.github/scripts/codespell-ignore.txt' \
|
||||
$(git ls-files)
|
||||
14
.github/scripts/typos.sh
vendored
Executable file
14
.github/scripts/typos.sh
vendored
Executable file
|
|
@ -0,0 +1,14 @@
|
|||
#!/bin/sh
|
||||
# Copyright (C) Viktor Szakats
|
||||
#
|
||||
# SPDX-License-Identifier: curl
|
||||
|
||||
set -eu
|
||||
|
||||
cd "$(dirname "${0}")"/../..
|
||||
|
||||
git ls-files | typos \
|
||||
--isolated \
|
||||
--force-exclude \
|
||||
--config '.github/scripts/typos.toml' \
|
||||
--file-list -
|
||||
29
.github/scripts/typos.toml
vendored
Normal file
29
.github/scripts/typos.toml
vendored
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
||||
#
|
||||
# SPDX-License-Identifier: curl
|
||||
|
||||
[default]
|
||||
extend-ignore-identifiers-re = [
|
||||
"^(ba|pn|PN|UE)$",
|
||||
"^(CNA|ser)$",
|
||||
"^(ECT0|ECT1|HELO|htpt|PASE)$",
|
||||
"^[A-Za-z0-9_-]*(EDE|GOST)[A-Z0-9_-]*$", # ciphers
|
||||
"^0x[0-9a-fA-F]+FUL$", # unsigned long hex literals ending with 'F'
|
||||
"^[0-9a-zA-Z+]{64,}$", # possibly base64
|
||||
"^(Januar|eyeballers|HELO_smtp|kno22|MkTypLibCompatible|optin|passin|perfec|__SecURE|SMTP_HELO|v_alue)$",
|
||||
"^(clen|req_clen|smtp_perform_helo|smtp_state_helo_resp|_stati64)$",
|
||||
]
|
||||
|
||||
extend-ignore-re = [
|
||||
".*spellchecker:disable-line",
|
||||
]
|
||||
|
||||
[files]
|
||||
extend-exclude = [
|
||||
".github/scripts/codespell-ignore.txt",
|
||||
".github/scripts/spellcheck.words",
|
||||
"docs/THANKS",
|
||||
"packages/*",
|
||||
"scripts/wcurl",
|
||||
"winbuild/*",
|
||||
]
|
||||
Loading…
Add table
Add a link
Reference in a new issue