Add code-spell spelling checks to CI (#8067)

Help find and fix silly spelling errors as they are added to the repo.

Author: earlephilhower

.github/workflows/pull-request.yml

@@ -269,3 +269,18 @@ jobs:
           bash ./tests/ci/build_boards.sh
           bash ./tests/ci/eboot_test.sh
           bash ./tests/ci/pkgrefs_test.sh
+
+
+# Validate orthography
+  code-spell:
+    name: Check spelling
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: true
+    - name: Run codespell
+      uses: codespell-project/actions-codespell@master
+      with:
+        skip: ./libraries/ESP8266SdFat,./libraries/LittleFS/lib,./tools/pyserial,./tools/sdk,./tools/esptool,./libraries/SoftwareSerial,./libraries/Ethernet,./github/workflows,./libraries/ESP8266HTTPUpdateServer/examples/SecureBearSSLUpdater/SecureBearSSLUpdater.ino,./libraries/esp8266/examples/RTCUserMemory/RTCUserMemory.ino,./libraries/esp8266/examples/StreamString/StreamString.ino,./libraries/ESP8266WiFi/examples/BearSSL_Validation/BearSSL_Validation.ino,./libraries/ESP8266WiFi/examples/BearSSL_Sessions/BearSSL_Sessions.ino,./libraries/ESP8266WebServer/examples/HelloServerBearSSL/HelloServerBearSSL.ino,./libraries/ESP8266WebServer/examples/HttpHashCredAuth/HttpHashCredAuth.ino,./cores/esp8266/spiffs,./tests/device/test_libc/libm_string.c, ./libraries/Netdump/examples/Netdump/Netdump.ino,./libraries/ESP8266WiFi/examples/BearSSL_Server,./cores/esp8266/LwipIntfDev.h
+        ignore_words_list: ESP8266,esp8266,esp,dout,DOUT,ser,ans

cores/esp8266/CallBackList.h

@@ -1,9 +1,8 @@
 #ifndef __CALLBACKLIST_H__
 #define __CALLBACKLIST_H__
 
-
 /*
- CallBackList, An implemention for handling callback execution
+ CallBackList, An implementation for handling callback execution
 
  Copyright (c) 2019 Herman Reintke. All rights reserved.
  This file is part of the esp8266 core for Arduino environment.

cores/esp8266/Esp-frag.cpp

@@ -25,7 +25,7 @@
 
 void EspClass::getHeapStats(uint32_t* hfree, uint16_t* hmax, uint8_t* hfrag)
 {
-    // L2 / Euclidian norm of free block sizes.
+    // L2 / Euclidean norm of free block sizes.
     // Having getFreeHeap()=sum(hole-size), fragmentation is given by
     // 100 * (1 - sqrt(sum(hole-size²)) / sum(hole-size))
 

cores/esp8266/Esp.h

@@ -26,7 +26,7 @@
 #include "spi_vendors.h"
 
 /**
- * AVR macros for WDT managment
+ * AVR macros for WDT management
  */
 typedef enum {
     WDTO_0MS    = 0,   //!< WDTO_0MS
@@ -264,7 +264,7 @@ class EspClass {
         static bool flashReplaceBlock(uint32_t address, const uint8_t *value, uint32_t byteCount);
         /**
          * @brief Write up to @a size bytes from @a data to flash at @a address
-         * This function takes case of unaligned memory acces by copying @a data to a temporary buffer,
+         * This function takes case of unaligned memory access by copying @a data to a temporary buffer,
          * it also takes care of page boundary crossing see @a flashWritePageBreak as to why it's done.
          * Less than @a size bytes may be written, due to 4 byte alignment requirement of spi_flash_write
          * @param address address on flash where write should start

cores/esp8266/FSnoop.cpp

@@ -15,7 +15,7 @@ void close_all_fs(void)
 }
 
 // default weak definitions
-// they are overriden in their respective real implementation
+// they are overridden in their respective real implementation
 // hint: https://github.com/esp8266/Arduino/pull/6699#issuecomment-549085382
 
 void littlefs_request_end(void) __attribute__((weak));

cores/esp8266/HardwareSerial.h

@@ -132,7 +132,7 @@ class HardwareSerial: public Stream
 
     int peek(void) override
     {
-        // return -1 when data is unvailable (arduino api)
+        // return -1 when data is unavailable (arduino api)
         return uart_peek_char(_uart);
     }
 
@@ -162,7 +162,7 @@ class HardwareSerial: public Stream
 
     int read(void) override
     {
-        // return -1 when data is unvailable (arduino api)
+        // return -1 when data is unavailable (arduino api)
         return uart_read_char(_uart);
     }
     // ::read(buffer, size): same as readBytes without timeout

cores/esp8266/LwipDhcpServer-NonOS.cpp

@@ -51,7 +51,7 @@ extern "C"
         //                  trying to change legacy behavor
         // `fw_has_started_softap_dhcps` will be read in DhcpServer::DhcpServer
         // which is called when c++ ctors are initialized, specifically
-        // dhcpSoftAP intialized with AP interface number above.
+        // dhcpSoftAP initialized with AP interface number above.
         fw_has_started_softap_dhcps = 1;
 #endif
     }

cores/esp8266/LwipDhcpServer.cpp

@@ -195,7 +195,7 @@ DhcpServer::DhcpServer(netif* netif): _netif(netif)
             { 0 }           // gateway 0.0.0.0
         };
         begin(&ip);
-        fw_has_started_softap_dhcps = 2; // not 1, ending intial boot sequence
+        fw_has_started_softap_dhcps = 2; // not 1, ending initial boot sequence
     }
 };
 
@@ -454,10 +454,10 @@ uint8_t* DhcpServer::add_offer_options(uint8_t *optptr)
     *optptr++ = 1;
     *optptr++ = 0x00;
 
-#if 0 // vendor specific unititialized (??)
+#if 0 // vendor specific uninitialized (??)
     *optptr++ = 43; // vendor specific
     *optptr++ = 6;
-    // unitialized ?
+    // uninitialized ?
 #endif
 
 #if 0 // already set (DHCP_OPTION_SUBNET_MASK==1) (??)

cores/esp8266/Print.h

@@ -76,7 +76,7 @@ class Print {
         inline size_t write(int8_t c) { return write((uint8_t) c); }
 
         // default to zero, meaning "a single write may block"
-        // should be overriden by subclasses with buffering
+        // should be overridden by subclasses with buffering
         virtual int availableForWrite() { return 0; }
 
         size_t printf(const char * format, ...)  __attribute__ ((format (printf, 2, 3)));

cores/esp8266/Stream.cpp

@@ -148,7 +148,7 @@ long Stream::parseInt(char skipChar) {
 
     do {
         if(c == skipChar)
-            ; // ignore this charactor
+            ; // ignore this character
         else if(c == '-')
             isNegative = true;
         else if(c >= '0' && c <= '9')        // is c a digit?