Refresh check spelling by jsoref · Pull Request #10106 · rancher-sandbox/rancher-desktop

jsoref · 2026-04-07T17:11:49Z

Follow up to: rddepman: bump check-spelling from 0.0.25 to 0.0.26 #10101 (comment)

This takes advantage of a new feature in v0.0.26: config.json for defining configuration using json instead of in workflows.

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

Roughly: https://github.com/check-spelling/spell-check-this/tree/976261d7b7184b67231c8668f2b35438496ca44f Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

jsoref · 2026-04-07T17:13:44Z

.github/actions/spelling/allow.txt

@@ -1,4 +1,5 @@
 emoji
+esc'd


Resolves: rddepman: bump check-spelling from 0.0.25 to 0.0.26 #10101 (comment)

I'm still working on properly fixing it -- I've added some initial code to help with this and will write a test (but probably not today)

jsoref · 2026-04-07T17:15:30Z

.github/actions/spelling/config.json

@@ -0,0 +1,29 @@
+{


This file can contain configuration as long as it's delegated by $INPUTS via load-config-from.pr-base-keys.

jsoref · 2026-04-07T17:17:15Z

.github/workflows/spelling.yml

+        sudo apt-get update
+        sudo apt-get install -y cpanminus


This is enables act to run check-spelling per https://gitea.com/actions-oss/act-cli/issues/32#issuecomment-1075706

(DOCKER_HOST=unix:///Users/$USER/.rd/docker.sock act --container-daemon-socket - -j spelling 2>&1)

Ah, they don't have the equivalent of DEBIAN_FRONTEND=noninteractive set (and whatever else that causes auto-detect to fall over)? Having that actually in the commit message would be nice, but that's sort of cherry on top here.

jsoref · 2026-04-07T17:17:38Z

scripts/spelling.sh

-        git clone --branch "$version" --depth 1 "$repo" "$checkout" >&2
+        git -c advice.detachedHead=false clone --branch "$version" --depth 1 "$repo" "$checkout" >&2
    else
        git -C "$checkout" fetch origin "$version" >&2
-        git -C "$checkout" checkout "$version" >&2
+        git -c advice.detachedHead=false -C "$checkout" checkout "$version" >&2


This reduces some noise at the start.

jsoref · 2026-04-07T17:18:06Z

scripts/spelling.sh


 INPUTS=$(yq --output-format=json <<EOF
    suppress_push_for_open_pull_request: 1
-    checkout: true


This isn't necessary as the workflow checks out the repository (or the repository exists because someone has it and is running this script).

Yeah, I think I just copied it from the workflow without thinking too hard.

jsoref · 2026-04-07T17:22:38Z

scripts/spelling.sh

-        cspell:dart/dart.txt
+    load-config-from: |
+      {
+        "pr-base-keys": [


I'm not actually sure this is the right choice for this repository. I need to think about this a bit more... I think that the equivalent might actually be to use pr-trusted-keys.

The current code spelling.sh basically uses whatever is in this file which is effectively the merge head as opposed to the base...

Anyway, this change is more to talk about whether it would be desirable to use the JSON config which v0.0.26 has or rely on yq to produce json.

Yeah, I think pr-trusted-keys makes more sense to us, because we don't allow any permissions in this workflow anyway so it should be no different; it just makes making PRs changing check-spelling configuration easier.

I don't think using the external JSON file is materially better (because we still need the bulk of the config in this file); if we can move all of it over there, then it would make more sense, instead of having configuration in two places instead. (Having just one line to load the other file, of course, is an exception.) Otherwise we already could have the whole thing in a different file, and only patch in use_sarif via jq/yq. Of course, if using the external file makes things much easier for version bumps, that's a good reason to do that; but in that case, please document why (in a GitHub PR comment is fine).

(P.S. the documentation needs an update now that v0.0.26 is out.)

jsoref · 2026-04-07T17:25:24Z

.github/actions/spelling/line_forbidden.patterns

-# Homoglyph (Cyrillic) should be `A`/`B`/`C`/`E`/`H`/`I`/`I`/`J`/`K`/`M`/`O`/`P`/`S`/`T`/`Y`
-# It's possible that your content is intentionally mixing Cyrillic and Latin scripts, but if it isn't, you definitely want to correct this.
-(?<=[A-Z]{2})[АВСЕНІӀЈКМОРЅТУ]|[АВСЕНІӀЈКМОРЅТУ](?=[A-Z]+(?:\b|[a-z]+)|[a-z]+(?:[^a-z]|$))
-
-# Homoglyph (Cyrillic) should be `a`/`b`/`c`/`e`/`o`/`p`/`x`/`y`
-# It's possible that your content is intentionally mixing Cyrillic and Latin scripts, but if it isn't, you definitely want to correct this.
-[авсеорху](?=[A-Za-z]{2,})|(?<=[A-Za-z]{2})[авсеорху]|(?<=[A-Za-z])[авсеорху](?=[A-Za-z])
-


check-spelling will now complain about the presence of homoglyphs where letters should be if they substitute for a word in the dictionary.

If you're worried about individual homoglyphs, you'd still want this, in which case it'd make sense to pull in two more rules: https://github.com/check-spelling/spell-check-this/blob/6bdcf01505c96f16f6016cc97fd6a045baca8577/.github/actions/spelling/line_forbidden.patterns#L1006-L1010

Yeah, we're not particularly worried about homoglyphs (more than typical). Saw that in the release notes, but didn't realize we already had something here. Thanks!

mook-as · 2026-04-07T17:33:32Z

.github/actions/spelling/line_forbidden.patterns

-# Homoglyph (Cyrillic) should be `A`/`B`/`C`/`E`/`H`/`I`/`I`/`J`/`K`/`M`/`O`/`P`/`S`/`T`/`Y`
-# It's possible that your content is intentionally mixing Cyrillic and Latin scripts, but if it isn't, you definitely want to correct this.
-(?<=[A-Z]{2})[АВСЕНІӀЈКМОРЅТУ]|[АВСЕНІӀЈКМОРЅТУ](?=[A-Z]+(?:\b|[a-z]+)|[a-z]+(?:[^a-z]|$))
-
-# Homoglyph (Cyrillic) should be `a`/`b`/`c`/`e`/`o`/`p`/`x`/`y`
-# It's possible that your content is intentionally mixing Cyrillic and Latin scripts, but if it isn't, you definitely want to correct this.
-[авсеорху](?=[A-Za-z]{2,})|(?<=[A-Za-z]{2})[авсеорху]|(?<=[A-Za-z])[авсеорху](?=[A-Za-z])
-


Yeah, we're not particularly worried about homoglyphs (more than typical). Saw that in the release notes, but didn't realize we already had something here. Thanks!

mook-as · 2026-04-07T17:37:10Z

.github/workflows/spelling.yml

+        sudo apt-get update
+        sudo apt-get install -y cpanminus


Ah, they don't have the equivalent of DEBIAN_FRONTEND=noninteractive set (and whatever else that causes auto-detect to fall over)? Having that actually in the commit message would be nice, but that's sort of cherry on top here.

mook-as · 2026-04-07T17:38:28Z

scripts/spelling.sh


 INPUTS=$(yq --output-format=json <<EOF
    suppress_push_for_open_pull_request: 1
-    checkout: true


Yeah, I think I just copied it from the workflow without thinking too hard.

mook-as · 2026-04-07T17:46:53Z

scripts/spelling.sh

-        cspell:dart/dart.txt
+    load-config-from: |
+      {
+        "pr-base-keys": [


Yeah, I think pr-trusted-keys makes more sense to us, because we don't allow any permissions in this workflow anyway so it should be no different; it just makes making PRs changing check-spelling configuration easier.

I don't think using the external JSON file is materially better (because we still need the bulk of the config in this file); if we can move all of it over there, then it would make more sense, instead of having configuration in two places instead. (Having just one line to load the other file, of course, is an exception.) Otherwise we already could have the whole thing in a different file, and only patch in use_sarif via jq/yq. Of course, if using the external file makes things much easier for version bumps, that's a good reason to do that; but in that case, please document why (in a GitHub PR comment is fine).

(P.S. the documentation needs an update now that v0.0.26 is out.)

jsoref added 7 commits April 7, 2026 13:12

CI: Fix running spelling workflow with act

530cf24

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

CI: Silence detached head warning

ec71580

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

CI: Add escaped to dictionary

3f8cf7d

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

CI: Move some config to spelling/config.json

57d1d04

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: missing

e5054a5

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: uppercase

1d93f29

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

Refresh spell-check-this

a12c271

Roughly: https://github.com/check-spelling/spell-check-this/tree/976261d7b7184b67231c8668f2b35438496ca44f Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

jsoref force-pushed the refresh-check-spelling branch from 1b8eab1 to a12c271 Compare April 7, 2026 17:13

jsoref commented Apr 7, 2026

View reviewed changes

jsoref marked this pull request as ready for review April 7, 2026 17:25

mook-as requested changes Apr 7, 2026

View reviewed changes

Conversation

jsoref commented Apr 7, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants