Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run crate-ci/typos in CI #51704

Merged
merged 45 commits into from
Oct 24, 2023
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
dc102e2
Try using typos in CI
LilithHafner Oct 14, 2023
fe586bb
Apply suggestions from code review
DilumAluthge Oct 14, 2023
83926ab
Apply suggestions from code review
DilumAluthge Oct 14, 2023
18e1522
Apply suggestions from code review
DilumAluthge Oct 14, 2023
2c7b9b4
Set a 5-minute timeout (Apply suggestions from code review)
DilumAluthge Oct 14, 2023
4e25d37
Switch back to `permissions: {}` (Apply suggestions from code review)
DilumAluthge Oct 14, 2023
f15c6ae
Try a hint on failure
LilithHafner Oct 14, 2023
e1e17a2
Move the hint to a more prominent location
LilithHafner Oct 14, 2023
7a0c98c
Add parentheses
LilithHafner Oct 14, 2023
5306441
Add draft typos.toml
Oct 14, 2023
bc36c53
Irony at its peak
LilithHafner Oct 14, 2023
5d2881d
Merge branch 'master' into lh/spell
LilithHafner Oct 16, 2023
03334fa
add typo
Oct 16, 2023
5b18d98
use home-rolled typos
Oct 16, 2023
e426c1a
give access to github.token (still with no permissions?)
Oct 16, 2023
45a4651
also fetch base ref
Oct 16, 2023
0f7e924
move fetch to typos step
Oct 16, 2023
d292968
debug
Oct 16, 2023
0a07f59
try to remove the list of false positives
Oct 16, 2023
5265529
edit a file that already has false positives in it
Oct 16, 2023
23a2de6
use set-diff (python instead of bash to get O(n))
Oct 16, 2023
c70961e
indentation
Oct 16, 2023
5778a1e
debug
Oct 16, 2023
6f18b0c
use newlines instead of null bytes
Oct 16, 2023
680bd4b
user default delim?
Oct 16, 2023
f1cfdbf
add do -i
Oct 16, 2023
619ec8e
replace 'do -i' with '|| true'
Oct 16, 2023
ce44b04
use exit code
Oct 16, 2023
c2bc0ad
cleanup and formatting
Oct 16, 2023
e3c6a96
remove intentional typos from README.md (should make check green)
Oct 16, 2023
73fd900
remove non-typo additions to src/jlapi.c
Oct 16, 2023
df9fbb5
rename job
Oct 16, 2023
6d7c946
more rename
Oct 16, 2023
d4dbcc7
don't pass around massive arguments to avoid error
Oct 16, 2023
80fa72d
add typo
Oct 16, 2023
43f9a82
fix typo in python code
Oct 16, 2023
0ac4f99
fix another pyhton bug
Oct 16, 2023
35408ae
add non-typo change to file with existing false-positives
Oct 16, 2023
a871c2c
ignore typos that are 5 or fewer characters long
Oct 16, 2023
3bc928c
add a longer typo to README.md
Oct 16, 2023
df7c059
add news
Oct 17, 2023
9f87862
stop ignoring short typos, instead annotate but let CI pass
Oct 17, 2023
38d8272
put back typos.toml ignoring typos of length less than or euqal to 4
Oct 17, 2023
06751de
remove intentional typos
Oct 21, 2023
9117815
Merge branch 'master' into lh/spell
LilithHafner Oct 21, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/SpellCheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Spell Check

permissions: {}
DilumAluthge marked this conversation as resolved.
Show resolved Hide resolved

on: [pull_request]

jobs:
typos-check:
name: (add false positives to typos.toml)
runs-on: ubuntu-latest
DilumAluthge marked this conversation as resolved.
Show resolved Hide resolved
timeout-minutes: 5
steps:
- name: Checkout the JuliaLang/julia repository
uses: actions/checkout@v4
DilumAluthge marked this conversation as resolved.
Show resolved Hide resolved
with:
persist-credentials: false
- name: Check spelling with typos
uses: crate-ci/typos@master
96 changes: 96 additions & 0 deletions typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# Hello and Welcome to typos.toml!

## Policy
# tldr: Don't let CI bully you. Use whatever varaible names you want.
#
# The spell check CI feature exists to help detect accidental typos, not to constrain the
# language we use in this repo. If you want to use a word or a variable name or somesuch
# that the CI check is not happy with, go right ahead, just make sure to add the appropriate
# entry to this file to tell the CI check that you didn't make a mistake. As a reviewier, if
# you think that a variable name is bad, go right ahead and tell the author that, just don't
# cite the CI check as a reason, that's not what the check is for.

## How to
# tldr: Add the whole identifier right below [default.extend-identifiers]
#
# There are two magor sections in this file, [default.extend-identifiers] (near the top) and
# [default.extend-words] (near the bottom). If the false positive is a full identifier like
# `mrs_claus` or `breal`, add it to [default.extend-identifiers] and that specific
# identifier will no longer be flagged as a typo. If, on the other hand, it is a word that
# appeasrs inside multiple a multi-word identifiers, like `ser` which is used in
# `jl_lookup_ser_tag`, `ser_tag`, `ser_version`, etc. then insrted of adding each of those
# identifiers individually, simply add it to the [default.extend-words] section. Identifiers
# are case sensitive and words are not.

[default.extend-identifiers]
mrs_claus = "mrs_claus"
womens = "womens"
breal = "breal"
Breal = "Breal"
Numer = "Numer"
splitted = "splitted"
affinitized = "affinitized"
key_smove = "key_smove"
readed_zero = "readed_zero"
check_inconsistentcy = "check_inconsistentcy"
L_OP_CALLL = "L_OP_CALLL"
OP_CALLL = "OP_CALLL"

# strings in test directories
Facilisi = "Facilisi"
vailable = "vailable"

# typos that are programmatically observable
supress_output = "supress_output"
hashs_seed = "hashs_seed"

[default.extend-words]
ba = "ba"
egal = "egal"
parm = "parm"
modul = "modul"
nd = "nd"
strat = "strat"
WRONLY = "WRONLY"
thisy = "thisy"
vally = "vally"
Ot = "Ot"
clos = "clos"
applys = "applys"
findn = "findn"
mis = "mis"
seh = "seh"
ue = "ue"
Missings = "Missings"
SOM = "SOM"
sais = "sais"
Merly = "Merly"
Filetimes = "Filetimes"
HSA = "HSA"
Strategems = "Strategems"
anumber = "anumber"
uupper = "uupper"
shttp = "shttp"
ser = "ser"
somes = "somes"
sav = "sav"
egals = "egals"
OLT = "OLT"
eyt = "eyt"
matc = "matc"
nam = "nam"
alls = "alls"
noe = "noe"

# strings in tests directories
fo = "fo"
Uest = "Uest"
Dows = "Dows"
LilithHafner marked this conversation as resolved.
Show resolved Hide resolved
aquire = "aquire"

# typos that are programmatically observable
compileable = "compileable"
overlayed = "overlayed"

[default]
extend-ignore-identifiers-re = ["^[a-zA-Z][a-zA-Z]?[a-zA-Z]?[a-zA-Z]?$"]
Loading