Merge pull request #1554 from fpistm/codespell

ci: add codespell action

Author: fpistm

.github/workflows/CodeSpell.yml

@@ -0,0 +1,27 @@
+name: codespell
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      # See: https://github.com/codespell-project/actions-codespell/blob/master/README.md
+      - name: Spell check
+        uses: codespell-project/actions-codespell@master
+        with:
+          check_filenames: true
+          check_hidden: true
+          # In the event of a false positive, add the word in all lower case to this file:
+          ignore_words_file: ./CI/codespell/.codespellignore
+          skip: ./.git,./CI,./system/Drivers,./system/Middlewares

CI/codespell/.codespellignore

@@ -0,0 +1,8 @@
+busses
+dout
+exten
+hart
+hsi
+noe
+nwe
+

CI/codespell/.codespellrc

@@ -0,0 +1,5 @@
+[codespell]
+check-filenames =
+check-hidden =
+skip = ./.git,./CI,./system/Drivers,./system/Middlewares
+ignore-words = ./CI/codespell/.codespellignore

CI/codespell/codespell.md

@@ -0,0 +1,21 @@
+## [codespell]
+
+[codespell] is used to check common misspellings and fix them.
+
+To execute it within this repository, it has to be installed first, see [installation](https://github.com/codespell-project/codespell#installation).
+Then run from the root folder this command using the configuration file:
+
+* Linux or equivalent:
+
+```console
+codespell --config ./CI/codespell/.codespellrc
+```
+
+* Windows
+
+```console
+codespell.exe --config .\CI\codespell\.codespellrc
+```
+
+
+[codespell]: https://github.com/codespell-project/codespell

CI/update/stm32cube.py

@@ -42,7 +42,7 @@
 hal_dest_path = system_dest_path / hal_src_path
 cmsis_dest_path = system_dest_path / hal_src_path / "CMSIS" / "Device" / "ST"
 
-stm32_list = []  # Serie
+stm32_list = []  # series
 cube_versions = collections.OrderedDict()  # key: serie name, value: cube version
 cube_HAL_versions = collections.OrderedDict()  # key: serie name, value: HAL version
 cube_CMSIS_versions = collections.OrderedDict()  # key: serie name, value: CMSIS version

CI/update/stm32variant.py

@@ -2012,7 +2012,7 @@ def aggregate_dir():
         # Get all mcu_dir
         mcu_dirs = sorted(mcu_family.glob("*/"))
 
-        # Group mcu directories when only expressions and xml file name are differents
+        # Group mcu directories when only expressions and xml file name are different
         while mcu_dirs:
             # Pop first item
             group_mcu_dir = [mcu_dirs.pop(0)]

CI/utils/pathlib_ext.py

@@ -36,7 +36,7 @@ def copyFile(src, dest):
 
 
 def genSTM32List(path, pattern):
-    stm32_list = []  # Serie
+    stm32_list = []  # series
     dir_pattern = re.compile(r"^STM32(.*)xx_HAL_Driver$", re.IGNORECASE)
 
     if pattern is not None:

CONTRIBUTING.md

@@ -9,7 +9,7 @@ To report a bug/request please file an issue in the right repository
 (example for [Arduino_Core_STM32](https://github.com/stm32duino/Arduino_Core_STM32/issues/new/choose)).
 But check the following boxes before posting an issue:
 
-- [ ] `Make sure you are using the latest STM32 core and libraries versions.` See [lastest core here](https://github.com/stm32duino/Arduino_Core_STM32/releases/latest).
+- [ ] `Make sure you are using the latest STM32 core and libraries versions.` See [latest core here](https://github.com/stm32duino/Arduino_Core_STM32/releases/latest).
 - [ ] `Your issue is NOT a question/feedback/suggestions.` This should be discussed on the [stm32duino forum](http://stm32duino.com):
   * questions on the [STM32 Core](http://stm32duino.com/viewforum.php?f=35).
   * bugs/enhancements on the [STM core: Bugs and enhancements](http://stm32duino.com/viewforum.php?f=38).

README.md

@@ -2,7 +2,7 @@
 [![forums](https://img.shields.io/badge/join-the%20forums-blue.svg)](https://www.stm32duino.com/)
 [![wiki](https://img.shields.io/badge/browse-the%20wiki-orange.svg)](https://github.com/stm32duino/wiki/wiki)
 [![STM32 Core Continuous Integration](https://github.com/stm32duino/Arduino_Core_STM32/workflows/STM32%20Core%20Continuous%20Integration/badge.svg?branch=main)](https://github.com/stm32duino/Arduino_Core_STM32/actions)
-
+[![codespell](https://github.com/stm32duino/Arduino_Core_STM32/workflows/codespell/badge.svg)](https://github.com/stm32duino/Arduino_Core_STM32/actions?workflow=codespell)
 
 
 [![GitHub release](https://img.shields.io/github/release/stm32duino/Arduino_Core_STM32.svg)](https://github.com/stm32duino/Arduino_Core_STM32/releases/latest)

cores/arduino/HardwareSerial.cpp

@@ -265,7 +265,7 @@ HardwareSerial::HardwareSerial(void *peripheral, HalfDuplexMode_t halfDuplex)
                             setTx(PIN_SERIALLP2_TX);
                           } else
 #endif
-                            // else get the pins of the first peripheral occurence in PinMap
+                            // else get the pins of the first peripheral occurrence in PinMap
                           {
                             _serial.pin_rx = pinmap_pin(peripheral, PinMap_UART_RX);
                             _serial.pin_tx = pinmap_pin(peripheral, PinMap_UART_TX);
@@ -485,7 +485,7 @@ void HardwareSerial::flush()
     // nop, the interrupt handler will free up space for us
   }
   // If we get here, nothing is queued anymore (DRIE is disabled) and
-  // the hardware finished tranmission (TXC is set).
+  // the hardware finished transmission (TXC is set).
 }
 
 size_t HardwareSerial::write(const uint8_t *buffer, size_t size)