Merge pull request #7 from arduino-libraries/ci-spell-check

Add CI workflow to check for commonly misspelled words

Author: aentinger

.codespellrc

@@ -0,0 +1,9 @@
+# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check/.codespellrc
+# See: https://github.com/codespell-project/codespell#using-a-config-file
+[codespell]
+# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
+ignore-words-list = ois,
+skip = ./.git,./.licenses,__pycache__,node_modules,./go.mod,./go.sum,./package-lock.json,./poetry.lock,./yarn.lock
+builtin = clear,informal,en-GB_to_en-US
+check-filenames =
+check-hidden =

.github/workflows/spell-check.yml

@@ -0,0 +1,22 @@
+name: Spell Check
+
+# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
+on:
+  push:
+  pull_request:
+  schedule:
+    # Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates.
+    - cron: "0 8 * * TUE"
+  workflow_dispatch:
+  repository_dispatch:
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Spell check
+        uses: codespell-project/actions-codespell@master

.idea/.gitignore

@@ -1,8 +1,10 @@
-= Combined Bosch BMI270 and BMM150 Library for Arduino =
+Combined Bosch BMI270 and BMM150 Library for Arduino
+====================================================
+[![Spell Check status](https://github.com/arduino-libraries/Arduino_BMI270_BMM150/actions/workflows/spell-check-task.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_BMI270_BMM150/actions/workflows/spell-check-task.yml)
 
 Allows you to read the accelerometer, magnetometer and gyroscope values from the combo BMI270+BMM150 IMU on your Arduino Nano 33 BLE Sense Rev2.
 
-== License ==
+### License
 
 Copyright (c) 2022 Arduino SA. All rights reserved.
 

.idea/Arduino_BMI270_BMM150.iml

@@ -397,11 +397,11 @@ void BoschSensorClass::print_rslt(int8_t rslt)
       panic_led_trap();
       break;
     case BMI2_E_AUX_INVALID_CFG:
-      _debug->println("Error [" + String(rslt) + "] : Invalid auxilliary configuration");
+      _debug->println("Error [" + String(rslt) + "] : Invalid auxiliary configuration");
       panic_led_trap();
       break;
     case BMI2_E_AUX_BUSY:
-      _debug->println("Error [" + String(rslt) + "] : Auxilliary busy");
+      _debug->println("Error [" + String(rslt) + "] : Auxiliary busy");
       panic_led_trap();
       break;
     case BMI2_E_SELF_TEST_FAIL: