Add check spelling (#180)

* Spelling (#78) * spelling: acquired Signed-off-by: Josh Soref <[email protected]> * spelling: application Signed-off-by: Josh Soref <[email protected]> * spelling: async Signed-off-by: Josh Soref <[email protected]> * spelling: better Signed-off-by: Josh Soref <[email protected]> * spelling: close Signed-off-by: Josh Soref <[email protected]> * spelling: documented Signed-off-by: Josh Soref <[email protected]> * spelling: implements Signed-off-by: Josh Soref <[email protected]> * spelling: independent Signed-off-by: Josh Soref <[email protected]> * spelling: maximize Signed-off-by: Josh Soref <[email protected]> * spelling: received Signed-off-by: Josh Soref <[email protected]> * spelling: switch Signed-off-by: Josh Soref <[email protected]> * spelling: transient Signed-off-by: Josh Soref <[email protected]> * spelling: triggered Signed-off-by: Josh Soref <[email protected]> * spelling: unsightly Signed-off-by: Josh Soref <[email protected]> --------- Signed-off-by: Josh Soref <[email protected]> Co-authored-by: Josh Soref <[email protected]> Co-authored-by: probonopd <[email protected]> * spelling: anymore Signed-off-by: Josh Soref <[email protected]> * spelling: application Signed-off-by: Josh Soref <[email protected]> * spelling: belong Signed-off-by: Josh Soref <[email protected]> * spelling: better Signed-off-by: Josh Soref <[email protected]> * spelling: candidate Signed-off-by: Josh Soref <[email protected]> * spelling: cannot Signed-off-by: Josh Soref <[email protected]> * spelling: deprecation Signed-off-by: Josh Soref <[email protected]> * spelling: following Signed-off-by: Josh Soref <[email protected]> * spelling: implemented Signed-off-by: Josh Soref <[email protected]> * spelling: instead Signed-off-by: Josh Soref <[email protected]> * spelling: interesting Signed-off-by: Josh Soref <[email protected]> * spelling: performance Signed-off-by: Josh Soref <[email protected]> * spelling: pluginsinterface Signed-off-by: Josh Soref <[email protected]> * spelling: popups Signed-off-by: Josh Soref <[email protected]> * spelling: probono Signed-off-by: Josh Soref <[email protected]> * spelling: qalculate Signed-off-by: Josh Soref <[email protected]> * spelling: question Signed-off-by: Josh Soref <[email protected]> * spelling: quickly Signed-off-by: Josh Soref <[email protected]> * spelling: searchstring Signed-off-by: Josh Soref <[email protected]> * spelling: seems Signed-off-by: Josh Soref <[email protected]> * spelling: switch Signed-off-by: Josh Soref <[email protected]> * spelling: triggered Signed-off-by: Josh Soref <[email protected]> * spelling: use case Signed-off-by: Josh Soref <[email protected]> * spelling: visible Signed-off-by: Josh Soref <[email protected]> * Add check-spelling --------- Signed-off-by: Josh Soref <[email protected]> Signed-off-by: Josh Soref <[email protected]> Co-authored-by: Josh Soref <[email protected]> Co-authored-by: probonopd <[email protected]>
helloSystem · Nov 19, 2023 · a4137cd · a4137cd
1 parent 4cd29be
commit a4137cd
Show file tree

Hide file tree

Showing 35 changed files with 1,506 additions and 51 deletions.
diff --git a/.github/actions/spelling/README.md b/.github/actions/spelling/README.md
@@ -0,0 +1,17 @@
+# check-spelling/check-spelling configuration
+
+File | Purpose | Format | Info
+-|-|-|-
+[dictionary.txt](dictionary.txt) | Replacement dictionary (creating this file will override the default dictionary) | one word per line | [dictionary](https://github.com/check-spelling/check-spelling/wiki/Configuration#dictionary)
+[allow.txt](allow.txt) | Add words to the dictionary | one word per line (only letters and `'`s allowed) | [allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow)
+[reject.txt](reject.txt) | Remove words from the dictionary (after allow) | grep pattern matching whole dictionary words | [reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-reject)
+[excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes)
+[only.txt](only.txt) | Only check matching files (applied after excludes) | perl regular expression | [only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-only)
+[patterns.txt](patterns.txt) | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
+[candidate.patterns](candidate.patterns) | Patterns that might be worth adding to [patterns.txt](patterns.txt) | perl regular expression with optional comment block introductions (all matches will be suggested) | [candidates](https://github.com/check-spelling/check-spelling/wiki/Feature:-Suggest-patterns)
+[line_forbidden.patterns](line_forbidden.patterns) | Patterns to flag in checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
+[expect.txt](expect.txt) | Expected words that aren't in the dictionary | one word per line (sorted, alphabetically) | [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect)
+[advice.md](advice.md) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice)
+
+Note: you can replace any of these files with a directory by the same name (minus the suffix)
+and then include multiple files inside that directory (with that suffix) to merge multiple files together.
diff --git a/.github/actions/spelling/advice.md b/.github/actions/spelling/advice.md
@@ -0,0 +1,31 @@
+<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
+<details><summary>If the flagged items are :exploding_head: false positives</summary>
+
+If items relate to a ...
+* binary file (or some other file you wouldn't want to check at all).
+
+  Please add a file path to the `excludes.txt` file matching the containing file.
+
+  File paths are Perl 5 Regular Expressions - you can [test](
+https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
+
+  `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
+../tree/HEAD/README.md) (on whichever branch you're using).
+
+* well-formed pattern.
+
+  If you can write a [pattern](
+https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns
+) that would match it,
+  try adding it to the `patterns.txt` file.
+
+  Patterns are Perl 5 Regular Expressions - you can [test](
+https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
+
+  Note that patterns can't match multiline strings.
+
+</details>
+
+<!-- adoption information-->
+:steam_locomotive: If you're seeing this message and your PR is from a branch that doesn't have check-spelling,
+please merge to your PR's base branch to get the version configured for your repository.
diff --git a/.github/actions/spelling/allow.txt b/.github/actions/spelling/allow.txt
@@ -0,0 +1,53 @@
+actionsearch
+appmenu
+appmenumodel
+appmenuwidget
+batterywidget
+blurwindow
+CMake
+cmake
+controlwidget
+cpp
+datetime
+datetimewidget
+dbusmenu
+dbusmenuimporter
+dbusmenushortcut
+dbusmenutypes
+dbustypes
+extensionwidget
+github
+https
+kde
+lineediteventfilter
+logout
+mainpanel
+mainwindow
+menubar
+menuimporter
+menuimporteradaptor
+pluginmanager
+pluginsinterface
+popupwindow
+pri
+qml
+qrc
+qtlocalpeer
+qtlockedfile
+qtsingleapplication
+qtsinglecoreapplication
+README
+src
+ssh
+statusnotifier
+statusnotifierbutton
+statusnotifieriteminterface
+statusnotifierwatcher
+statusnotifierwidget
+ubuntu
+unix
+utils
+volumewidget
+workarounds
+xml
+yml