Refresh check-spelling#9632

jsoref · 2025-12-11T15:34:50Z

This mostly updates the check-spelling metadata.

It also prepares for the next version (applying newer dictionaries that I hope to eventually switch to).

In general, I'd recommend reviewing starting with changes to expect.txt -- new entries should be considered, they probably indicate changes to patterns or dictionaries. I haven't thought too carefully about all of them, but I'll highlight some.

I'm also tossing in a change to the yarn-install behavior because the workflow in github currently burns >30s installing stuff that it won't use.

jsoref · 2025-12-11T15:35:33Z

.github/actions/spelling/excludes.txt

 ^pkg/rancher-desktop/assets/scripts/logrotate-k3s$
 ^pkg/rancher-desktop/assets/scripts/logrotate-lima-guestagent$
 ^pkg/rancher-desktop/sudo-prompt/
+^pkg/rancher-desktop/utils/processOutputInterpreters/__tests__/assets/trivy-image-postgres


There are a pair of files that had a bunch of things that check-spelling doesn't like, but they're clearly designed as inputs to a test based on real world values, so fixing them doesn't make sense.

jsoref · 2025-12-11T15:36:22Z

.github/actions/spelling/expect.txt

-ipaddr
-IPAM
+IPlugin
 iptable


I removed a pattern for this because it was the only case covered and it didn't seem worth it for me to carry along the cost while checking all lines in all files.

jsoref · 2025-12-11T15:37:12Z

.github/actions/spelling/expect.txt

 XVar
-xvfb
 xwininfo
+xyzzy


I'm not quite sure what changed that resulted in this being seen.

jsoref · 2025-12-11T15:38:36Z

.github/actions/spelling/patterns.txt

+
+# hit-count: 2 file-count: 1
+# iSCSI iqn (approximate regex)
+\biqn\.[0-9]{4}-[0-9]{2}(?:[\.-][a-z][a-z0-9]*)*\b:[\w.]+


This is slightly extended from the base pattern

jsoref · 2025-12-11T15:39:26Z

.github/actions/yarn-install/action.yaml

+inputs:
+skip-electron:
+description: Skip Electron
+default: ''
+required: false
+skip-go:
+description: Skip Go
+default: ''
+required: false
+skip-python:
+description: Skip Python
+default: ''
+required: false


As noted, these changes allow check-spelling to bootstrap 30s faster

And we can probably use them in other workflows too. 👍
(No need to make that change in this PR, of course.)

jsoref · 2025-12-11T16:01:50Z

pkg/rancher-desktop/config/types.js

 FEATURE: 'management.cattle.io.feature',
 GROUP: 'management.cattle.io.group',
-KONTANIER_DRIVER: 'management.cattle.io.kontainerdriver',
+KONTAINER_DRIVER: 'management.cattle.io.kontainerdriver',


And this will probably get clobbered next time we re-import the file from dashboard (we never use this).

jsoref · 2025-12-11T16:02:34Z

scripts/spelling.sh

 check_file_names: 1
 post_comment: 0
 use_magic_file: 1
+ ignore-next-line: spell-checker:disable-next-line


this won't do anything yet. It should be supported in the next version

jsoref · 2025-12-11T16:03:04Z

src/go/nerdctl-stub/main_shared.go

 // builderCacheProcessor implements the details for handling the argument for
 // `nerdctl builder build --cache-from=...` and
-// `nerdctl builder builder --cache-to=...`
+// `nerdctl builder build --cache-to=...`


notable. check-spelling didn't like this, but I don't think nerdctl did either...

jsoref · 2025-12-11T16:04:10Z

package-spelling.json

@@ -0,0 +1,26 @@
+{


This file is used by the workflow (it has no dependencies).
I may end up providing a version of this in the check-spelling repository, as it seems reasonably close to something people might want.... I still need to think about how this should work.

This is basically there so yarn installdoesn't actually do much, right?
Is that needed, or can we get away with skipping .github/actions/yarn-install/action.yaml? (Just do setup-node without caching + corepack enable)

I have no idea. I didn't write the workflow bits that use it. I figured I could safely skip the bits I found I could skip, but I wasn't really sure whether it was a policy that yarn-install be used everywhere or....
-- I probably should have asked.

It was just there because we got tired of copying bits and pieces across different workflows (especially when we added things that were needed). In this case, I think it's fine to not use it.

jsoref · 2025-12-11T16:04:28Z

yarn-spelling.lock

@@ -0,0 +1,12 @@
+# This file is generated by running "yarn install" inside your project.


This corresponds to the package-spelling.json file.

mook-as

I'll need to double check if we can skip the whole alternate package.json thing and just not run yarn install for check-spelling… otherwise it's mainly pretty trivial things.

You may want to just skip the files we import from dashboard though, or make PRs upstream.

I'll approve or request changes depending on how my experiments with package.json go.

mook-as · 2025-12-11T20:05:26Z

.github/actions/spelling/candidate.patterns

 \bgitlab\.[^/\s"]*/(?:[^/\s"]+/){2}commits?/[0-9a-f]+\b

+# #includes
+^\s*#include\s*(?:<.*?>|".*?")


Hmm, it would be nice if the patterns could be limited to specific file paths, so #includes only for *.h/*.c/*.hpp/*.cpp/*.cc. Same with uses: only in .github/**/*.yaml.

Yeah... It's a thing that comes up occasionally, but then I'd have to make the file format much more complicated.

.github/actions/spelling/line_forbidden.patterns

mook-as · 2025-12-11T20:40:33Z

.github/actions/spelling/line_forbidden.patterns

+\b2006-02-01\b
+
+# Should probably have a trailing `.`
+\s([a-z]\.){2,}[a-z]\s


I don't see this being hit a lot (a.b.c instead of a.b.c., where all of those things are single-letters), but okay

I think the main complaint is a.k.a which should be a.k.a.. I'm not sure how often it'll be hit in general or in any particular repository, but, GitHub has 280k+ hits, so it's definitely worth including in the baseline.

mook-as · 2025-12-11T20:47:57Z

.github/actions/spelling/line_forbidden.patterns


-# s.b. macOS or Mac OS X or ...
+# Should be `Jira`
+\bJIRA\b


Unless you're tracking things you are doing to manage Jira within itself. This should be \bJIRA\b(?!-\d+) or something along those lines, to avoid flagging JIRA-12345.

Thanks. I've fixed it in check-spelling/spell-check-this@9d03041 for the baseline.

mook-as · 2025-12-11T20:53:24Z

.github/actions/spelling/patterns.txt

-# hit-count: 739 file-count: 6
-# base64 encoded content, possibly wrapped in mime
-(?:^|[\s=;:?])[-a-zA-Z=;:/0-9+]{50,}(?:[\s=;:?]|$)
+NO_VOWELS:\s+'.+'


rancher-desktop/pkg/rancher-desktop/utils/string.js
Line 112 in f26afea
NO_VOWELS: 'bcdfghjklmnpqrstvwxz2456789',
That's from dashboard and we don't really care.

README.md

mook-as · 2025-12-11T22:01:56Z

pkg/rancher-desktop/config/types.js

 FEATURE: 'management.cattle.io.feature',
 GROUP: 'management.cattle.io.group',
-KONTANIER_DRIVER: 'management.cattle.io.kontainerdriver',
+KONTAINER_DRIVER: 'management.cattle.io.kontainerdriver',


And this will probably get clobbered next time we re-import the file from dashboard (we never use this).

mook-as · 2025-12-11T22:02:41Z

pkg/rancher-desktop/components/SortableTable/index.vue

All the changes will probably be clobbered next time we re-import from dashboard.
You may be interested in pushing this to https://github.com/rancher/dashboard (specifically https://github.com/rancher/dashboard/blob/master/shell/components/SortableTable/index.vue ) but definitely extra; feel free to ignore.

Hmm, I sent them PRs in 2022. I suppose I could again....

mook-as · 2025-12-11T22:05:24Z

pkg/rancher-desktop/assets/translations/en-us.yaml

Note that we (for the most part) don't actually use and translations; all of the changes here are for dashboard strings.

mook-as · 2025-12-11T22:06:00Z

pkg/rancher-desktop/assets/styles/global/_tooltip.scss

-// This removes it from the layout of ButtondropDown (so it doesn't render huge for SSR) but
-// still allows it to maintain it's dimensions for v-tooltip to calculate the appropriate position.
+// This removes it from the layout of ButtonDropDown (so it doesn't render huge for SSR) but
+// still allows it to maintain its dimensions for v-tooltip to calculate the appropriate position.


I have no idea either, it's been here since the initial PoC stages. I suspect the rules aren't really doing anything useful.

mook-as

Poked about it for a bit, and I think I prefer not having an extra package.json lying around.

My experiment was 6e5b6a7

The core is basically:

yq --inplace '.dependencies ={} | .devDependencies ={}' package.json rm -f yarn.lock corepack enable yarn yarn install --no-immutable --mode=skip-build

All that together is <5s, so that should be fine? It just ends up installing nothing (other than yarn itself), and skips the postinstall script to avoid failures. Installing cpanminus takes about 20s, and the spell check itself is about a minute.

Co-authored-by: Mark Yen <[email protected]> Signed-off-by: Josh Soref <[email protected]>

Signed-off-by: Josh Soref <[email protected]>

https://cert-manager.io/docs/installation/helm/#installing-from-the-oci-registry Signed-off-by: Josh Soref <[email protected]>

Signed-off-by: Josh Soref <[email protected]>

Co-authored-by: Mark Yen <[email protected]> Signed-off-by: Josh Soref <[email protected]>

mook-as

Thanks for bearing with me on all the nit picks!

I'll note that this does not bump the version of check-spelling we use:

rancher-desktop/pkg/rancher-desktop/assets/dependencies.yaml

Line 28 in 9e3eb27

check-spelling: 0.0.25

But that's probably a function of not having a release yet, and that's perfectly fine.

jsoref commented Dec 11, 2025
View reviewed changes

jsoref force-pushed the refresh-check-spelling branch 2 times, most recently from 9479f52 to 8836427Compare December 11, 2025 16:42

mook-as reviewed Dec 11, 2025
View reviewed changes

jsorefand others added 25 commits December 11, 2025 19:30

link: latest development AppImage builds
a2cd682
Co-authored-by: Mark Yen <[email protected]> Signed-off-by: Josh Soref <[email protected]>

link: GitHub application settings
f98c055
Signed-off-by: Josh Soref <[email protected]>

link: applications settings
c23ac64
Signed-off-by: Josh Soref <[email protected]>

link: creating an Integration Key for PagerDuty
26791a7
Signed-off-by: Josh Soref <[email protected]>

link: creating Incoming Webhooks for Slack
70fee0b
Signed-off-by: Josh Soref <[email protected]>

Use oci://quay.io/jetstack/charts/cert-manager
a1c6169
https://cert-manager.io/docs/installation/helm/#installing-from-the-oci-registry Signed-off-by: Josh Soref <[email protected]>

spelling: ; otherwise,
b5e8442
Signed-off-by: Josh Soref <[email protected]>

spelling: rdctl info will generate when run
bb1d851
Signed-off-by: Josh Soref <[email protected]>

spelling: a
d8d3b59
Signed-off-by: Josh Soref <[email protected]>

spelling: above
e159efa
Signed-off-by: Josh Soref <[email protected]>

spelling: an
6e87c57
Signed-off-by: Josh Soref <[email protected]>

spelling: as
4ba3ca5
Signed-off-by: Josh Soref <[email protected]>

spelling: build
7189798
Signed-off-by: Josh Soref <[email protected]>

spelling: buttondropdown
0ebc78e
Signed-off-by: Josh Soref <[email protected]>

spelling: cannot
8440b0d
Signed-off-by: Josh Soref <[email protected]>

spelling: certificate
77044f0
Signed-off-by: Josh Soref <[email protected]>

spelling: ctx
fe20411
Signed-off-by: Josh Soref <[email protected]>

spelling: ctxs
3972630
Signed-off-by: Josh Soref <[email protected]>

spelling: forwards
545251e
Signed-off-by: Josh Soref <[email protected]>

spelling: https://...,
5d7182f
Signed-off-by: Josh Soref <[email protected]>

spelling: id
9d4e67e
Signed-off-by: Josh Soref <[email protected]>

spelling: initial
2c21528
Signed-off-by: Josh Soref <[email protected]>

spelling: into which the result should be written
84b94c3
Signed-off-by: Josh Soref <[email protected]>

spelling: is greater
5d416b8
Signed-off-by: Josh Soref <[email protected]>

spelling: issue,
68464ab
Signed-off-by: Josh Soref <[email protected]>

jsorefand others added 18 commits December 11, 2025 19:30

spelling: its
7e86e90
Signed-off-by: Josh Soref <[email protected]>

spelling: kontainer
968f762
Signed-off-by: Josh Soref <[email protected]>

spelling: listened to by the listener
a6f6a9c
Signed-off-by: Josh Soref <[email protected]>

spelling: log in
4d75302
Signed-off-by: Josh Soref <[email protected]>

spelling: marshal
ceb00f7
Signed-off-by: Josh Soref <[email protected]>

spelling: otherwise,
79277e5
Signed-off-by: Josh Soref <[email protected]>

spelling: prepopulated
c368693
Signed-off-by: Josh Soref <[email protected]>

spelling: resources
8d216f3
Signed-off-by: Josh Soref <[email protected]>

spelling: set up
e5b9572
Signed-off-by: Josh Soref <[email protected]>

spelling: stream
e9182e3
Signed-off-by: Josh Soref <[email protected]>

spelling: that
2efdc68
Signed-off-by: Josh Soref <[email protected]>

spelling: the client that
2553a5e
Signed-off-by: Josh Soref <[email protected]>

spelling: the forwarded
64afa5a
Signed-off-by: Josh Soref <[email protected]>

spelling: this bool controls showing loading state in the dom;
2a21ab5
Signed-off-by: Josh Soref <[email protected]>

spelling: v99-bottles-of-beer-on-the-wall
edbb0cf
Signed-off-by: Josh Soref <[email protected]>

spelling: whether or not
fc70ebe
Signed-off-by: Josh Soref <[email protected]>

Refresh check-spelling
6b949b2
Signed-off-by: Josh Soref <[email protected]>

Spelling: Speed up check-spelling workflow
f509117
Co-authored-by: Mark Yen <[email protected]> Signed-off-by: Josh Soref <[email protected]>

jsoref force-pushed the refresh-check-spelling branch from 3a466cd to f509117Compare December 12, 2025 01:06

mook-as approved these changes Dec 12, 2025
View reviewed changes

mook-as enabled auto-merge December 12, 2025 01:24

mook-as merged commit aff2928 into rancher-sandbox:mainDec 12, 2025
19 checks passed

jsoref deleted the refresh-check-spelling branch December 12, 2025 03:52

		@@ -0,0 +1,12 @@
		# This file is generated by running "yarn install" inside your project.

Refresh check-spelling#9632

Refresh check-spelling #9632

Uh oh!

Conversation

jsoref commented Dec 11, 2025

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!

mook-as left a comment

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!

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!

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!

mook-as left a comment

Choose a reason for hiding this comment

Uh oh!

mook-as left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants