Add codespell support (config, GH action to detect new typos) + make it fix some typos (#1648)

17 files changed, 55 insertions, 23 deletions

diff --git a/.codespellrc b/.codespellrc
new file mode 100644
index 000000000..5e3e02437
--- /dev/null
+++ b/.codespellrc
@@ -0,0 +1,9 @@
+[codespell]
+# Ref: https://github.com/codespell-project/codespell#using-a-config-file
+skip = .git*,*.svg,*.css,.codespellrc,locales,pnpm-lock.yaml,i18n,config.ts,extensions.json
+check-hidden = true
+# Case sensitive names, or phrases (typically non-English), to ignore
+# Python style regex. \b is a match at a word boundary
+ignore-regex = \b(Manuel|Sie diesen|Sie den|l'authentification)\b
+# Case insensitive comma separated list of words to ignore
+# ignore-words-list =
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
new file mode 100644
index 000000000..feadb9a34
--- /dev/null
+++ b/.github/workflows/codespell.yml
@@ -0,0 +1,23 @@
+# Codespell configuration is within .codespellrc
+---
+name: Codespell
+
+on:
+  push:
+    branches: [develop]
+  pull_request:
+    branches: [develop]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 05b163a61..6a88c9aa6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -192,7 +192,7 @@
 - Fix default accent color to Ferdium gradient
 - Fix reload after resume and add idle time setting
 - Don't replace custom icon when service updates
-- Workaroud for in-app Password Recovery
+- Workaround for in-app Password Recovery
 - Fix navigation toolbar buttons not being clickable
 - Fix drag-n-drop not working if the service name is shown
 - Fix ribbon menu style on windows
@@ -225,7 +225,7 @@
 - Resurrect the electron-process-manager for Ferdium
 - Hide sidebar buttons toggled behind a hamburger menu
 - Add monochromatic Service icons option with Dim adjustment
-- Add new service-level option where the user can choose whether to open links in Ferdium or in the default browser. Currently implimented only for discord, skype, steamchat and zoom.
+- Add new service-level option where the user can choose whether to open links in Ferdium or in the default browser. Currently implemented only for discord, skype, steamchat and zoom.
 
 ### Services
 
diff --git a/docs/MIGRATION.md b/docs/MIGRATION.md
index bb1ca315d..a3a02db11 100644
--- a/docs/MIGRATION.md
+++ b/docs/MIGRATION.md
@@ -12,7 +12,7 @@ The main advantage of using Ferdi with an account is that you have your configur
 
 ## Using Ferdi without an account i.e. Accountless
 
-Accountless instances have all the same functionality as account-based ones with the exception of multi-machine syncronization. If you don't intend to use this app on multiple machines with regularly changing settings and lists of services, there's no benefit to having an online account. Having a backup of your `export.ferdi-data` whenever you make changes to your setup, provides a similarly secure (albeit slower and manual alternative) to automatic syncing that doesn't rely on a server's constant availability.
+Accountless instances have all the same functionality as account-based ones with the exception of multi-machine synchronization. If you don't intend to use this app on multiple machines with regularly changing settings and lists of services, there's no benefit to having an online account. Having a backup of your `export.ferdi-data` whenever you make changes to your setup, provides a similarly secure (albeit slower and manual alternative) to automatic syncing that doesn't rely on a server's constant availability.
 
 ## Exporting
 
diff --git a/docs/dbus/org.ferdium.Ferdium.xml b/docs/dbus/org.ferdium.Ferdium.xml
index 0ee395328..47da8ee89 100644
--- a/docs/dbus/org.ferdium.Ferdium.xml
+++ b/docs/dbus/org.ferdium.Ferdium.xml
@@ -22,7 +22,7 @@
     <!--
       ToggleMute:
 
-      Toggles the muted state of notifcations.
+      Toggles the muted state of notifications.
 
       Use the #org.ferdium.Ferdium.Muted property to get or set the current
       muted state.
diff --git a/scripts/migration/migrate-unix.sh b/scripts/migration/migrate-unix.sh
index c51227f33..4175d7720 100755
--- a/scripts/migration/migrate-unix.sh
+++ b/scripts/migration/migrate-unix.sh
@@ -49,7 +49,7 @@ if [ -d "$FERDIUM_PATH" ]; then
 fi
 
 if mv -vf "$FERDI_PATH" "$FERDIUM_PATH"; then
-  echo "Files exported succesfully"
+  echo "Files exported successfully"
 else
   echo "ERROR!"
   echo "No user data was found to be exported. Exiting..."
diff --git a/src/@types/mobx-form.types.ts b/src/@types/mobx-form.types.ts
index 67b0aa3ec..c9d226674 100644
--- a/src/@types/mobx-form.types.ts
+++ b/src/@types/mobx-form.types.ts
@@ -16,7 +16,7 @@ interface Listeners {
 
 export interface Field extends Listeners {
   id?: string;
-  type?: string; // todo specifiy probably
+  type?: string; // todo specify probably
   name?: string;
   value?: any;
   label?: string;
diff --git a/src/components/settings/releaseNotes/ReleaseNotesDashboard.tsx b/src/components/settings/releaseNotes/ReleaseNotesDashboard.tsx
index 1afc17491..e874b4469 100644
--- a/src/components/settings/releaseNotes/ReleaseNotesDashboard.tsx
+++ b/src/components/settings/releaseNotes/ReleaseNotesDashboard.tsx
@@ -16,12 +16,12 @@ const messages = defineMessages({
   connectionError: {
     id: 'settings.releasenotes.connectionError',
     defaultMessage:
-      'An error occured when connecting to Github, please try again later.',
+      'An error occurred when connecting to Github, please try again later.',
   },
   connectionErrorPageMissing: {
     id: 'settings.releasenotes.connectionErrorPageMissing',
     defaultMessage:
-      'An error occured when connecting to Github, the page you are looking for is missing.',
+      'An error occurred when connecting to Github, the page you are looking for is missing.',
   },
 });
 
diff --git a/src/components/settings/settings/EditSettingsForm.tsx b/src/components/settings/settings/EditSettingsForm.tsx
index 598158e20..7e6a89f99 100644
--- a/src/components/settings/settings/EditSettingsForm.tsx
+++ b/src/components/settings/settings/EditSettingsForm.tsx
@@ -88,7 +88,7 @@ const messages = defineMessages({
   lockInfo: {
     id: 'settings.app.lockInfo',
     defaultMessage:
-      'Password Lock allows you to keep your messages protected.\nUsing Password Lock, you will be prompted to enter your password everytime you start Ferdium or lock Ferdium yourself using the lock symbol in the bottom left corner or the shortcut {lockShortcut}.',
+      'Password Lock allows you to keep your messages protected.\nUsing Password Lock, you will be prompted to enter your password every time you start Ferdium or lock Ferdium yourself using the lock symbol in the bottom left corner or the shortcut {lockShortcut}.',
   },
   scheduledDNDTimeInfo: {
     id: 'settings.app.scheduledDNDTimeInfo',
@@ -185,7 +185,7 @@ const messages = defineMessages({
   spellCheckerLanguageInfo: {
     id: 'settings.app.spellCheckerLanguageInfo',
     defaultMessage:
-      "Ferdium uses your Mac's build-in spellchecker to check for typos. If you want to change the languages the spellchecker checks for, you can do so in your Mac's System Preferences.",
+      "Ferdium uses your Mac's built-in spellchecker to check for typos. If you want to change the languages the spellchecker checks for, you can do so in your Mac's System Preferences.",
   },
   subheadlineCache: {
     id: 'settings.app.subheadlineCache',
diff --git a/src/features/publishDebugInfo/Component.tsx b/src/features/publishDebugInfo/Component.tsx
index 8b38ba5af..c837ede4f 100644
--- a/src/features/publishDebugInfo/Component.tsx
+++ b/src/features/publishDebugInfo/Component.tsx
@@ -48,7 +48,7 @@ const messages = defineMessages({
   },
   published: {
     id: 'feature.publishDebugInfo.published',
-    defaultMessage: 'Your debug log was published and is now availible at',
+    defaultMessage: 'Your debug log was published and is now available at',
   },
 });
 
diff --git a/src/features/quickSwitch/Component.tsx b/src/features/quickSwitch/Component.tsx
index a5c102386..4a48b1e6c 100644
--- a/src/features/quickSwitch/Component.tsx
+++ b/src/features/quickSwitch/Component.tsx
@@ -140,7 +140,7 @@ class QuickSwitchModal extends Component<IProps, IState> {
       this.state.search &&
       compact(invoke(this.state.search, 'match', /^[\da-z]/i)).length > 0
     ) {
-      // Apply simple search algorythm to list of all services
+      // Apply simple search algorithm to list of all services
       services = this.props.stores!.services.allDisplayed;
       services = services.filter(
         service =>
diff --git a/src/helpers/translation-helpers.ts b/src/helpers/translation-helpers.ts
index 2e8f6b260..105a0ccfc 100644
--- a/src/helpers/translation-helpers.ts
+++ b/src/helpers/translation-helpers.ts
@@ -8,7 +8,7 @@ export async function translateTo(
 ): Promise<{ text: string; error: boolean }> {
   const errorText =
     // TODO: Need to support i18n
-    'FERDIUM ERROR: An error occured. Please select less text to translate or try again later.';
+    'FERDIUM ERROR: An error occurred. Please select less text to translate or try again later.';
 
   if (translatorEngine === 'Google') {
     const translationResult = await translateGoogle(text, {
diff --git a/src/helpers/update-helpers.ts b/src/helpers/update-helpers.ts
index 3e548c69b..a6a2162a7 100644
--- a/src/helpers/update-helpers.ts
+++ b/src/helpers/update-helpers.ts
@@ -29,12 +29,12 @@ const messages = defineMessages({
   connectionError: {
     id: 'settings.releasenotes.connectionError',
     defaultMessage:
-      'An error occured when connecting to Github, please try again later.',
+      'An error occurred when connecting to Github, please try again later.',
   },
   connectionErrorPageMissing: {
     id: 'settings.releasenotes.connectionErrorPageMissing',
     defaultMessage:
-      'An error occured when connecting to Github, the page you are looking for is missing.',
+      'An error occurred when connecting to Github, the page you are looking for is missing.',
   },
 });
 
diff --git a/src/i18n/locales/en-US.json b/src/i18n/locales/en-US.json
index 90a45e83c..1f7eff3e9 100644
--- a/src/i18n/locales/en-US.json
+++ b/src/i18n/locales/en-US.json
@@ -16,7 +16,7 @@
   "feature.publishDebugInfo.info": "Publishing your debug information helps us find issues and errors in Ferdium. By publishing your debug information you accept Ferdium Debugger's privacy policy and terms of service",
   "feature.publishDebugInfo.privacy": "Privacy policy",
   "feature.publishDebugInfo.publish": "Accept and publish",
-  "feature.publishDebugInfo.published": "Your debug log was published and is now availible at",
+  "feature.publishDebugInfo.published": "Your debug log was published and is now available at",
   "feature.publishDebugInfo.terms": "Terms of service",
   "feature.publishDebugInfo.title": "Publish debug information",
   "feature.quickSwitch.info": "Select a service with TAB, ↑ and ↓. Open a service with ENTER.",
@@ -281,7 +281,7 @@
   "settings.app.hibernateInfo": "By default, Ferdium will keep all your services open and loaded in the background so they are ready when you want to use them. Service Hibernation will unload your services after a specified amount. This is useful to save RAM or keeping services from slowing down your computer.",
   "settings.app.inactivityLockInfo": "Minutes of inactivity, after which Ferdium should automatically lock. Use 0 to disable",
   "settings.app.infoOpenCertificatesFolder": "To install a certificate, click the button below to open the certificates folder and copy it into the folder. After that you can refresh the service (CTRL/CMD + R). To remove/uninstall, simply delete the certificate file and restart Ferdium.",
-  "settings.app.lockInfo": "Password Lock allows you to keep your messages protected.\nUsing Password Lock, you will be prompted to enter your password everytime you start Ferdium or lock Ferdium yourself using the lock symbol in the bottom left corner or the shortcut {lockShortcut}.",
+  "settings.app.lockInfo": "Password Lock allows you to keep your messages protected.\nUsing Password Lock, you will be prompted to enter your password every time you start Ferdium or lock Ferdium yourself using the lock symbol in the bottom left corner or the shortcut {lockShortcut}.",
   "settings.app.lockedPassword": "Password",
   "settings.app.lockedPasswordInfo": "Please make sure to set a password you'll remember.\nIf you loose this password, you will have to reinstall Ferdium.",
   "settings.app.overallTheme": "Overall Theme",
@@ -302,7 +302,7 @@
   "settings.app.sentryInfo": "Sending telemetry data allows us to find errors in Ferdium - we will not send any personal information like your message data!",
   "settings.app.serverHelp": "Connected to server at {serverURL}",
   "settings.app.servicesUpdateStatusUpToDate": "Your services are up-to-date",
-  "settings.app.spellCheckerLanguageInfo": "Ferdium uses your Mac's build-in spellchecker to check for typos. If you want to change the languages the spellchecker checks for, you can do so in your Mac's System Preferences.",
+  "settings.app.spellCheckerLanguageInfo": "Ferdium uses your Mac's built-in spellchecker to check for typos. If you want to change the languages the spellchecker checks for, you can do so in your Mac's System Preferences.",
   "settings.app.subheadlineCache": "Cache",
   "settings.app.subheadlineFerdiumProfile": "Ferdium Profile",
   "settings.app.todoServerInfo": "This server will be used for the \"Ferdium Todo\" feature.",
@@ -334,8 +334,8 @@
   "settings.recipes.missingService": "Missing a service?",
   "settings.recipes.nothingFound": "Sorry, but no service matched your search term - but you can still probably add it using the \"Custom Website\" option. Please note that the website might show more services that have been added to Ferdium since the version that you are currently on. To get those new services, please consider upgrading to a newer version of Ferdium.",
   "settings.recipes.servicesSuccessfulAddedInfo": "Service successfully added",
-  "settings.releasenotes.connectionError": "An error occured when connecting to Github, please try again later.",
-  "settings.releasenotes.connectionErrorPageMissing": "An error occured when connecting to Github, the page you are looking for is missing.",
+  "settings.releasenotes.connectionError": "An error occurred when connecting to Github, please try again later.",
+  "settings.releasenotes.connectionErrorPageMissing": "An error occurred when connecting to Github, the page you are looking for is missing.",
   "settings.releasenotes.headline": "Release Notes",
   "settings.searchService": "Search service",
   "settings.service.error.goBack": "Back to services",
diff --git a/src/internal-server/resources/views/transfer.edge b/src/internal-server/resources/views/transfer.edge
index e793d1c30..f1d7b7332 100644
--- a/src/internal-server/resources/views/transfer.edge
+++ b/src/internal-server/resources/views/transfer.edge
@@ -4,7 +4,7 @@
 <h2>Import/Export data from another Ferdium server</h2>
 @if(success === true)
     <div class="alert" style="background-color:#28C76F;">
-        Sucessfully imported your account data
+        Successfully imported your account data
     </div>
 @endif
 
diff --git a/src/internal-server/start/routes.js b/src/internal-server/start/routes.js
index 2dbd0713e..b8d463945 100644
--- a/src/internal-server/start/routes.js
+++ b/src/internal-server/start/routes.js
@@ -64,7 +64,7 @@ Route.get('health', ({ response }) =>
 
 // API is grouped under '/v1/' route
 Route.group(() => {
-  // User authentification
+  // User authentication
   Route.post('auth/signup', 'UserController.signup');
   Route.post('auth/login', 'UserController.login');
 
diff --git a/src/webview/contextMenuBuilder.ts b/src/webview/contextMenuBuilder.ts
index 155e533e9..dd39560da 100644
--- a/src/webview/contextMenuBuilder.ts
+++ b/src/webview/contextMenuBuilder.ts
@@ -2,7 +2,7 @@
  * Context Menu builder.
  *
  * Based on "electron-spellchecker"'s  ContextMenuBuilder but customized for Ferdium
- * and for usage with Electron's build-in spellchecker
+ * and for usage with Electron's built-in spellchecker
  *
  * Source: https://github.com/electron-userland/electron-spellchecker/blob/master/src/context-menu-builder.js
  */