fix(spelling): Fix misspellings detected by codespell and enable it (espressif#10232)

* fix(spelling): Fix misspellings detected by codespell and enable it * change(tools): Push generated binaries to PR --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: lucasssvaz

.codespellrc

@@ -1,9 +1,8 @@
 [codespell]
 # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check/.codespellrc
 # In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
-ignore-words-list = ba,licence,ot,dout,als,exten,acount,totaly,pasttime
+ignore-words-list = ba,licence,ot,dout,als,exten
 skip = ./.git,./.licenses,__pycache__,.clang-format,.codespellrc,.editorconfig,.flake8,.prettierignore,.yamllint.yml,.gitignore,boards.txt,platform.txt,programmers.txt
 builtin = clear,informal,en-GB_to_en-US
 check-filenames =
 check-hidden =
-write-changes =

.pre-commit-config.yaml

@@ -1,7 +1,9 @@
 exclude: |
  (?x)(
  ^\.github\/|
- ^tests\/performance\/coremark\/.*\.[ch]$
+ ^tests\/performance\/coremark\/.*\.[ch]$|
+ ^tests\/performance\/superpi\/.*\.(cpp|h)$|
+ LICENSE\.md$
  )
 
 default_language_version:
@@ -24,11 +26,10 @@ repos:
  - id: trailing-whitespace
  args: [--markdown-linebreak-ext=md]
  - repo: https://github.com/codespell-project/codespell
- rev: "v2.2.4"
+ rev: "v2.3.0"
  hooks:
  - id: codespell
  exclude: ^.*\.(svd|SVD)$
- stages: [manual]
  - repo: https://github.com/pre-commit/mirrors-clang-format
  rev: "v18.1.3"
  hooks:

CODE_OF_CONDUCT.md

@@ -5,7 +5,7 @@
 We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
 size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
+identity and expression, level of experience, education, socioeconomic status,
 nationality, personal appearance, race, religion, or sexual identity
 and orientation.
 

cores/esp32/Arduino.h

@@ -179,7 +179,7 @@ void initArduino(void);
 unsigned long pulseIn(uint8_t pin, uint8_t state, unsigned long timeout);
 unsigned long pulseInLong(uint8_t pin, uint8_t state, unsigned long timeout);
 
-uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder);
+uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder); // codespell:ignore shiftin
 void shiftOut(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder, uint8_t val);
 
 #ifdef __cplusplus

cores/esp32/HWCDC.cpp

@@ -443,7 +443,7 @@ size_t HWCDC::write(const uint8_t *buffer, size_t size) {
  if (connected) {
  usb_serial_jtag_ll_ena_intr_mask(USB_SERIAL_JTAG_INTR_SERIAL_IN_EMPTY);
  }
- // tracks CDC trasmission progress to avoid hanging if CDC is unplugged while still sending data
+ // tracks CDC transmission progress to avoid hanging if CDC is unplugged while still sending data
  size_t last_toSend = to_send;
  uint32_t tries = tx_timeout_ms; // waits 1ms per sending data attempt, in case CDC is unplugged
  while (connected && to_send) {
@@ -479,7 +479,7 @@ size_t HWCDC::write(const uint8_t *buffer, size_t size) {
  }
  }
  }
- // CDC was diconnected while sending data ==> flush the TX buffer keeping the last data
+ // CDC was disconnected while sending data ==> flush the TX buffer keeping the last data
  if (to_send && !usb_serial_jtag_ll_txfifo_writable()) {
  connected = false;
  flushTXBuffer(buffer + so_far, to_send);

cores/esp32/HardwareSerial.h

@@ -228,7 +228,7 @@ class HardwareSerial : public Stream {
 
  // onReceive will setup a callback that will be called whenever an UART interruption occurs (UART_INTR_RXFIFO_FULL or UART_INTR_RXFIFO_TOUT)
  // UART_INTR_RXFIFO_FULL interrupt triggers at UART_FULL_THRESH_DEFAULT bytes received (defined as 120 bytes by default in IDF)
- // UART_INTR_RXFIFO_TOUT interrupt triggers at UART_TOUT_THRESH_DEFAULT symbols passed without any reception (defined as 10 symbos by default in IDF)
+ // UART_INTR_RXFIFO_TOUT interrupt triggers at UART_TOUT_THRESH_DEFAULT symbols passed without any reception (defined as 10 symbols by default in IDF)
  // onlyOnTimeout parameter will define how onReceive will behave:
  // Default: true -- The callback will only be called when RX Timeout happens.
  // Whole stream of bytes will be ready for being read on the callback function at once.

cores/esp32/esp32-hal-uart.c

@@ -45,7 +45,7 @@ struct uart_struct_t {
  bool has_peek; // flag to indicate that there is a peek byte pending to be read
  uint8_t peek_byte; // peek byte that has been read but not consumed
  QueueHandle_t uart_event_queue; // export it by some uartGetEventQueue() function
- // configuration data:: Arduino API tipical data
+ // configuration data:: Arduino API typical data
  int8_t _rxPin, _txPin, _ctsPin, _rtsPin; // UART GPIOs
  uint32_t _baudrate, _config; // UART baudrate and config
  // UART ESP32 specific data

cores/esp32/wiring_shift.c

@@ -20,7 +20,7 @@
 #include "esp32-hal.h"
 #include "wiring_private.h"
 
-uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder) {
+uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder) { // codespell:ignore shiftin
  uint8_t value = 0;
  uint8_t i;
 

docs/en/api/gpio.rst

@@ -9,7 +9,7 @@ One of the most used and versatile peripheral in a microcontroller is the GPIO.
 
 GPIO stands to General Purpose Input Output, and is responsible to control or read the state of a specific pin in the digital world. For example, this peripheral is widely used to create the LED blinking or to read a simple button.
 
-.. note:: There are some GPIOs with special restrictions, and not all GPIOs are accessible through the developemnt board. For more information about it, see the corresponding board pin layout information.
+.. note:: There are some GPIOs with special restrictions, and not all GPIOs are accessible through the development board. For more information about it, see the corresponding board pin layout information.
 
 GPIOs Modes
 ***********

docs/en/tutorials/preferences.rst

@@ -565,7 +565,7 @@ If you need to access a different namespace, close the one before opening the ot
 
  currentNamespace.end(); // closes 'myNamespace'
 
- currentNamespace.begin("myOtherNamespace", false); // opens a different Preferences namesspace.
+ currentNamespace.begin("myOtherNamespace", false); // opens a different Preferences namespace.
  // do other stuff...
 
  currentNamespace.end(); // closes 'myOtherNamespace'
@@ -644,7 +644,7 @@ Returning to the example above:
 
 ..
 
-will assign to the variable ``dessert`` the String ``gravel`` if an error occurred, or the value stored against the key ``favourites`` if not.
+will assign to the variable ``dessert`` the String ``gravel`` if an error occurred, or the value stored against the key ``favorites`` if not.
 
 If we predetermine a default value that is outside all legitimate values, we now have a way to test if an error actually occurred.