Add check spelling by jsoref · Pull Request #180 · helloSystem/Menu

jsoref · 2023-11-19T08:56:05Z

note that check-spelling has gotten a bit smarter since the previous PR.

Here,

it's configured to use SARIF for reporting where possible
it's configured to check file names
there's a longer list of forbidden patterns (generally grammatical faults, e.g. any more.)
error reporting is available as a step summary (it's possible to use a comment, but that's generally discouraged by GitHub)
dependabot is set up to warn if dictionary changes will break as part of an upgrade
for PRs within a repository other than this one, check-spelling will offer to update the expect file directly

probonopd · 2023-11-19T11:03:09Z

Package 'xdamage', required by 'virtual:world', not found is probably unrelated to your change, most likely something changed in FreeBSD packaging.

probonopd · 2023-11-19T11:20:02Z

Hello @jsoref can you please send a PR againt the main branch? Thanks!

* spelling: acquired Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: application Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: async Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: better Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: close Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: documented Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: implements Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: independent Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: maximize Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: received Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: switch Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: transient Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: triggered Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> * spelling: unsightly Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> --------- Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> Co-authored-by: Josh Soref <jsoref@users.noreply.github.com> Co-authored-by: probonopd <probonopd@users.noreply.github.com>

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

jsoref · 2023-11-19T12:32:25Z

 find_package(dbusmenu-qt5 REQUIRED)
 find_package(KF5GlobalAccel REQUIRED)
-pkg_check_modules(QCALCULATE REQUIRED libqalculate)
+pkg_check_modules(QALCULATE REQUIRED libqalculate)


this of course isn't required, but it seemed reasonable to use the same spelling as the module

jsoref · 2023-11-19T12:35:36Z

-        for (QAction *findActivateeCanidcate : m_searchMenu->actions())
-            if (!findActivateeCanidcate->isSeparator()) {
-                m_searchMenu->setActiveAction(findActivateeCanidcate);
+        for (QAction *findCandidateAction : m_searchMenu->actions())
+            if (!findCandidateAction->isSeparator()) {
+                m_searchMenu->setActiveAction(findCandidateAction);


this was a manual change of sorts. There were two tokens in this variable that weren't in the dictionary, it seemed to make sense to avoid the word Active as findActive could be confusing -- given the short scope, I opted to drop the token entirely in favor of action (I contemplated menuitem but I wasn't certain it was always going to be a menuitem, so I went with the type).

jsoref · 2023-11-19T12:38:58Z

You should look over this file at least once, as items here will be treated as part of the dictionary, so it'd be bad if a misspelled item were included.

Most of the items that I've included here were used in file paths -- check-spelling wanted to identify a misspelled filename, but it wouldn't do that if it decided that filenames aren't usually dictionary words, so including items was necessary to shift the balance from "mostly not dictionary words" to "mostly dictionary words".

jsoref · 2023-11-19T12:40:01Z

+extensionwidget
+github
+https
+kde


note that unlike expect, an entry here doesn't cover other case variants (so, KDE will likely be in expect.txt -- it could be moved here).

jsoref · 2023-11-19T12:41:44Z

+\.zip$
+^\.github/actions/spelling/
+^\Q.github/workflows/spelling.yml\E$
+^\Qplugin-statusnotifier/statusnotifier.cpp\E$


I retained this from earlier runs, but notably, Statusnotifier in this file might be better written as StatusNotifier -- I opted not to think about that because I should be sleeping.

jsoref · 2023-11-19T12:42:43Z

+^\Qplugin-statusnotifier/statusnotifier.cpp\E$
+^\Qplugin-statusnotifier/statusnotifier.json\E$
+^\Qsrc/lineediteventfilter.cpp\E$
+_(?!en)..(?:_\w+|)\.ts$


this line is designed to skip all translation files that aren't the English translation files. I wrote it for the original PR, and a spot check seems to indicate it did the right thing. (This version of check-spelling will tell you which files it's checking in the log, so you can check its work...)

jsoref · 2023-11-19T12:45:03Z

As with allow.txt, it's worth reading this file over to make sure there aren't any surprises. I've done a bunch of passes, so I think the list is reasonable, but it's late, so I could have made a mistake...

jsoref · 2023-11-19T12:47:32Z

+GITHUB_TOKEN: .*$
+
+# IServiceProvider / isAThing
+(?:(?<=[a-z])|\b)(?:[IQ]|isA)(?=(?:[A-Z][a-z]{2,})+(?:[^a-z]|\b))
+
+# libraries
+libx
+\blib(?=[a-qs-yz])
+
+LIVEstep
+
+# subsidiaries
+\(-ies\)


These are custom entries specific to this repository (the items preceding came from candidates from spell-check-this and the items following came from patterns).

probonopd · 2023-11-19T20:11:12Z

Thank you very much for your dedciation @jsoref. I truly appreciate it 👍

jsoref and others added 26 commits November 19, 2023 06:41

spelling: anymore

d9be231

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

spelling: application

823977f

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

spelling: belong

439185b

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

spelling: better

e65b268

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

spelling: candidate

a2e4176

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

spelling: cannot

a68150b

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

spelling: deprecation

fb42ab5

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

spelling: following

8677a5e

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

spelling: implemented

3aad4f7

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

spelling: instead

9ff81f5

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

spelling: interesting

9e06e0b

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

spelling: performance

358fe37

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

spelling: pluginsinterface

037c468

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

spelling: popups

59054ef

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

spelling: probono

8ebd4d2

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

spelling: qalculate

4a56e0b

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

spelling: question

1433027

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

spelling: quickly

c0452e1

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

spelling: searchstring

a2be2ea

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

spelling: seems

0a53975

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

spelling: switch

08d2dfc

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

spelling: triggered

85a60b3

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

spelling: use case

d6b0e36

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

spelling: visible

84a51e4

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

Add check-spelling

27927f2

jsoref force-pushed the add-check-spelling branch from 72d3dec to 27927f2 Compare November 19, 2023 12:29

jsoref changed the base branch from actionsearch to main November 19, 2023 12:29

jsoref commented Nov 19, 2023

View reviewed changes

probonopd merged commit a4137cd into helloSystem:main Nov 19, 2023

jsoref deleted the add-check-spelling branch November 19, 2023 21:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add check spelling#180

Add check spelling#180
probonopd merged 26 commits intohelloSystem:mainfrom
jsoref:add-check-spelling

jsoref commented Nov 19, 2023

Uh oh!

probonopd commented Nov 19, 2023

Uh oh!

probonopd commented Nov 19, 2023

Uh oh!

jsoref Nov 19, 2023

Uh oh!

jsoref Nov 19, 2023

Uh oh!

jsoref Nov 19, 2023

Uh oh!

jsoref Nov 19, 2023

Uh oh!

jsoref Nov 19, 2023

Uh oh!

jsoref Nov 19, 2023

Uh oh!

jsoref Nov 19, 2023

Uh oh!

jsoref Nov 19, 2023

Uh oh!

probonopd commented Nov 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

jsoref commented Nov 19, 2023

Uh oh!

probonopd commented Nov 19, 2023

Uh oh!

probonopd commented Nov 19, 2023

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!

probonopd commented Nov 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants