From 3b0c707b265bc8c76a345888c4eadffb80f1048a Mon Sep 17 00:00:00 2001
From: Sebastian Romero <s.romero@arduino.cc>
Date: Thu, 17 Mar 2022 15:37:55 +0100
Subject: [PATCH 01/13] Add rules to find incorrectly formatted units

---
 scripts/validation/rules/rules-spelling.yml | 49 +++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/scripts/validation/rules/rules-spelling.yml b/scripts/validation/rules/rules-spelling.yml
index 8490076af3..bbbe45ef51 100644
--- a/scripts/validation/rules/rules-spelling.yml
+++ b/scripts/validation/rules/rules-spelling.yml
@@ -5,7 +5,56 @@
   format: markdown
   errorMessage: Megabytes should be either written as 'megabytes' or abbreviated as
     'MB'
+
+# MHz / GHz spacing
+- regex: "(?<!\\S)\\b\\d+[MG][hH]z\\b"
+  shouldMatch: false
+  type: warning
+  format: markdown
+  errorMessage: Space between unit and value required
+
+# MHz / GHz spelling
+- regex: "(?<!\\S)\\b\\d+\\s?[MG]hz\\b"
+  shouldMatch: false
+  type: warning
+  format: markdown
+  errorMessage: Megahertz/Gigahertz should be abbreviated as MHz/GHz
+
+# Mbps / Gbps spacing
+- regex: "(?<!\\S)\\b\\d+[MG]bps\\b"
+  shouldMatch: false
+  type: warning
+  format: markdown
+  errorMessage: Space between unit and value required
+
+# kB / MB spacing
+- regex: "(?<!\\S)\\b\\d+[mMkK][bB]\\b"
+  shouldMatch: false
+  type: warning
+  format: markdown
+  errorMessage: Space between unit and value required
+
+# kB spelling
+- regex: "(?<!\\S)\\b\\d+\\s?K[bB]\\b"
+  shouldMatch: false
+  type: warning
+  format: markdown
+  errorMessage: Kilobyte should be abbreviated as kB.
+
+# MB spelling
+- regex: "(?<!\\S)\\b\\d+\\s?m[bB]\\b"
+  shouldMatch: false
+  type: warning
+  format: markdown
+  errorMessage: Megabyte should be abbreviated as MB.
     
+# μm / mm spacing
+- regex: "(?<!\\S)\\b\\d+[μm]m\\b"
+  shouldMatch: false
+  type: warning
+  format: markdown
+  errorMessage: Space between unit and value required
+
 # Excludes Wi-Fi in URLs (prepended by dash or slash) and WiFi.XY and MKR WiFi
 - regex: "(?<![\\/-]|Arduino |MKR |UNO |MKR 1000 )[wW]i[fF]i(?![-\\/]|\\.?\\S| [sS]hield)"
   shouldMatch: false

From dbec98774ceb7faa0523dab8e65cba8735ee0216 Mon Sep 17 00:00:00 2001
From: Sebastian Romero <s.romero@arduino.cc>
Date: Wed, 30 Mar 2022 14:41:43 +0200
Subject: [PATCH 02/13] Add rule for Mbps / Gbps spelling

---
 scripts/validation/rules/rules-spelling.yml | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/scripts/validation/rules/rules-spelling.yml b/scripts/validation/rules/rules-spelling.yml
index bbbe45ef51..abcab2cea7 100644
--- a/scripts/validation/rules/rules-spelling.yml
+++ b/scripts/validation/rules/rules-spelling.yml
@@ -27,6 +27,13 @@
   format: markdown
   errorMessage: Space between unit and value required
 
+# Mbps / Gbps spelling
+- regex: "(?<!\\S)\\b\\d+\\s?[mg]bps\\b"
+  shouldMatch: false
+  type: warning
+  format: markdown
+  errorMessage: Megabit per second shout be abbreviated mbps, Gigabit per second gbps  
+
 # kB / MB spacing
 - regex: "(?<!\\S)\\b\\d+[mMkK][bB]\\b"
   shouldMatch: false
@@ -39,14 +46,14 @@
   shouldMatch: false
   type: warning
   format: markdown
-  errorMessage: Kilobyte should be abbreviated as kB.
+  errorMessage: Kilobyte should be abbreviated as kB, Kilobit as kb.
 
 # MB spelling
 - regex: "(?<!\\S)\\b\\d+\\s?m[bB]\\b"
   shouldMatch: false
   type: warning
   format: markdown
-  errorMessage: Megabyte should be abbreviated as MB.
+  errorMessage: Megabyte should be abbreviated as MB, Megabit as Mb.
     
 # μm / mm spacing
 - regex: "(?<!\\S)\\b\\d+[μm]m\\b"

From f494e64378779a98f766ba53ccf5d704c02a851a Mon Sep 17 00:00:00 2001
From: Sebastian Romero <s.romero@arduino.cc>
Date: Thu, 14 Apr 2022 11:38:07 +0200
Subject: [PATCH 03/13] Catch mhz ghz misspelling

---
 scripts/validation/rules/rules-spelling.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/scripts/validation/rules/rules-spelling.yml b/scripts/validation/rules/rules-spelling.yml
index abcab2cea7..0863202a07 100644
--- a/scripts/validation/rules/rules-spelling.yml
+++ b/scripts/validation/rules/rules-spelling.yml
@@ -14,7 +14,7 @@
   errorMessage: Space between unit and value required
 
 # MHz / GHz spelling
-- regex: "(?<!\\S)\\b\\d+\\s?[MG]hz\\b"
+- regex: "(?<!\\S)\\b\\d+\\s?[MGmg]hz\\b"
   shouldMatch: false
   type: warning
   format: markdown

From 54fd016d9f0d0c31883b3349e7f1290e2b378d7a Mon Sep 17 00:00:00 2001
From: Sebastian Romero <s.romero@arduino.cc>
Date: Thu, 14 Apr 2022 11:50:28 +0200
Subject: [PATCH 04/13] Fix Kb and KB rule

---
 scripts/validation/rules/rules-spelling.yml | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/scripts/validation/rules/rules-spelling.yml b/scripts/validation/rules/rules-spelling.yml
index 0863202a07..df35a8685e 100644
--- a/scripts/validation/rules/rules-spelling.yml
+++ b/scripts/validation/rules/rules-spelling.yml
@@ -41,12 +41,12 @@
   format: markdown
   errorMessage: Space between unit and value required
 
-# kB spelling
-- regex: "(?<!\\S)\\b\\d+\\s?K[bB]\\b"
+# KB / Kb spelling
+- regex: "(?<!\\S)\\b\\d+\\s?k[bB]\\b"
   shouldMatch: false
   type: warning
   format: markdown
-  errorMessage: Kilobyte should be abbreviated as kB, Kilobit as kb.
+  errorMessage: Kilobyte should be abbreviated as KB, Kilobit as Kb.
 
 # MB spelling
 - regex: "(?<!\\S)\\b\\d+\\s?m[bB]\\b"

From b2e3c0abcfc8e20efa99f42920bd79ce1cb8667f Mon Sep 17 00:00:00 2001
From: Sebastian Romero <s.romero@arduino.cc>
Date: Thu, 14 Apr 2022 13:21:59 +0200
Subject: [PATCH 05/13] Improve error message

Co-authored-by: Josefine Hansson <66409231+jhansson-ard@users.noreply.github.com>
---
 scripts/validation/rules/rules-spelling.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/scripts/validation/rules/rules-spelling.yml b/scripts/validation/rules/rules-spelling.yml
index df35a8685e..373667c50b 100644
--- a/scripts/validation/rules/rules-spelling.yml
+++ b/scripts/validation/rules/rules-spelling.yml
@@ -32,7 +32,7 @@
   shouldMatch: false
   type: warning
   format: markdown
-  errorMessage: Megabit per second shout be abbreviated mbps, Gigabit per second gbps  
+  errorMessage: 'Megabit per second' should be abbreviated Mbps, 'Gigabit per second' Gbps  
 
 # kB / MB spacing
 - regex: "(?<!\\S)\\b\\d+[mMkK][bB]\\b"

From ddf2db15fb32eb5b7cb910a66c51310a878672e3 Mon Sep 17 00:00:00 2001
From: Sebastian Romero <s.romero@arduino.cc>
Date: Thu, 14 Apr 2022 13:22:12 +0200
Subject: [PATCH 06/13] Improve error message

Co-authored-by: Josefine Hansson <66409231+jhansson-ard@users.noreply.github.com>
---
 scripts/validation/rules/rules-spelling.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/scripts/validation/rules/rules-spelling.yml b/scripts/validation/rules/rules-spelling.yml
index 373667c50b..b6c1a59a97 100644
--- a/scripts/validation/rules/rules-spelling.yml
+++ b/scripts/validation/rules/rules-spelling.yml
@@ -18,7 +18,7 @@
   shouldMatch: false
   type: warning
   format: markdown
-  errorMessage: Megahertz/Gigahertz should be abbreviated as MHz/GHz
+  errorMessage: 'Megahertz'/'Gigahertz' should be abbreviated as MHz/GHz
 
 # Mbps / Gbps spacing
 - regex: "(?<!\\S)\\b\\d+[MG]bps\\b"

From 248bf8cd6d9b97ccbc4e1750c9486296f1626d37 Mon Sep 17 00:00:00 2001
From: Sebastian Romero <s.romero@arduino.cc>
Date: Thu, 14 Apr 2022 13:22:24 +0200
Subject: [PATCH 07/13] Improve error message

Co-authored-by: Josefine Hansson <66409231+jhansson-ard@users.noreply.github.com>
---
 scripts/validation/rules/rules-spelling.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/scripts/validation/rules/rules-spelling.yml b/scripts/validation/rules/rules-spelling.yml
index b6c1a59a97..5b975876ab 100644
--- a/scripts/validation/rules/rules-spelling.yml
+++ b/scripts/validation/rules/rules-spelling.yml
@@ -53,7 +53,7 @@
   shouldMatch: false
   type: warning
   format: markdown
-  errorMessage: Megabyte should be abbreviated as MB, Megabit as Mb.
+  errorMessage: 'Megabyte' should be abbreviated as MB, 'Megabit' as Mb.
     
 # μm / mm spacing
 - regex: "(?<!\\S)\\b\\d+[μm]m\\b"

From 6813963eade9504f4fffece8c8d6768f26e571d8 Mon Sep 17 00:00:00 2001
From: Sebastian Romero <s.romero@arduino.cc>
Date: Thu, 14 Apr 2022 13:22:38 +0200
Subject: [PATCH 08/13] Improve error message

Co-authored-by: Josefine Hansson <66409231+jhansson-ard@users.noreply.github.com>
---
 scripts/validation/rules/rules-spelling.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/scripts/validation/rules/rules-spelling.yml b/scripts/validation/rules/rules-spelling.yml
index 5b975876ab..3a5570f0c6 100644
--- a/scripts/validation/rules/rules-spelling.yml
+++ b/scripts/validation/rules/rules-spelling.yml
@@ -46,7 +46,7 @@
   shouldMatch: false
   type: warning
   format: markdown
-  errorMessage: Kilobyte should be abbreviated as KB, Kilobit as Kb.
+  errorMessage: 'Kilobyte' should be abbreviated as KB, 'Kilobit' as Kb.
 
 # MB spelling
 - regex: "(?<!\\S)\\b\\d+\\s?m[bB]\\b"

From 9cbf2b18aaf3f57e1c13a5740896e7d5396630cc Mon Sep 17 00:00:00 2001
From: Sebastian Romero <s.romero@arduino.cc>
Date: Thu, 14 Apr 2022 15:19:06 +0200
Subject: [PATCH 09/13] Properly escape messages

---
 scripts/validation/rules/rules-spelling.yml | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/scripts/validation/rules/rules-spelling.yml b/scripts/validation/rules/rules-spelling.yml
index 3a5570f0c6..56cb4a7bec 100644
--- a/scripts/validation/rules/rules-spelling.yml
+++ b/scripts/validation/rules/rules-spelling.yml
@@ -3,22 +3,22 @@
   shouldMatch: false
   type: warning
   format: markdown
-  errorMessage: Megabytes should be either written as 'megabytes' or abbreviated as
-    'MB'
+  errorMessage: "Megabytes should be either written as 'megabytes' or abbreviated as
+    'MB'"
 
 # MHz / GHz spacing
-- regex: "(?<!\\S)\\b\\d+[MG][hH]z\\b"
+- regex: "(?<!\\S)\\b\\d+[MmGg][hH]z\\b"
   shouldMatch: false
   type: warning
   format: markdown
   errorMessage: Space between unit and value required
 
 # MHz / GHz spelling
-- regex: "(?<!\\S)\\b\\d+\\s?[MGmg]hz\\b"
+- regex: "(?<!\\S)\\b\\d+\\s?[MmGg]hz\\b"
   shouldMatch: false
   type: warning
   format: markdown
-  errorMessage: 'Megahertz'/'Gigahertz' should be abbreviated as MHz/GHz
+  errorMessage: "'Megahertz'/'Gigahertz' should be abbreviated as MHz/GHz"
 
 # Mbps / Gbps spacing
 - regex: "(?<!\\S)\\b\\d+[MG]bps\\b"
@@ -32,7 +32,7 @@
   shouldMatch: false
   type: warning
   format: markdown
-  errorMessage: 'Megabit per second' should be abbreviated Mbps, 'Gigabit per second' Gbps  
+  errorMessage: "'Megabit per second' should be abbreviated Mbps, 'Gigabit per second' Gbps"
 
 # kB / MB spacing
 - regex: "(?<!\\S)\\b\\d+[mMkK][bB]\\b"
@@ -46,14 +46,14 @@
   shouldMatch: false
   type: warning
   format: markdown
-  errorMessage: 'Kilobyte' should be abbreviated as KB, 'Kilobit' as Kb.
+  errorMessage: "'Kilobyte' should be abbreviated as KB, 'Kilobit' as Kb."
 
 # MB spelling
 - regex: "(?<!\\S)\\b\\d+\\s?m[bB]\\b"
   shouldMatch: false
   type: warning
   format: markdown
-  errorMessage: 'Megabyte' should be abbreviated as MB, 'Megabit' as Mb.
+  errorMessage: "'Megabyte' should be abbreviated as MB, 'Megabit' as Mb."
     
 # μm / mm spacing
 - regex: "(?<!\\S)\\b\\d+[μm]m\\b"
@@ -68,7 +68,7 @@
   type: warning
   format: markdown
   includeCodeBlocks: false
-  errorMessage: Incorrect spelling of 'Wi-Fi' found.
+  errorMessage: "Incorrect spelling of 'Wi-Fi' found."
 
 - regex: "(?<!\\/|-)\\b(master|slave)\\b"
   regexModifiers: "gi"

From 69930463645714220e602694acf61f4e94a64543 Mon Sep 17 00:00:00 2001
From: Josefine Hansson <j.hansson@arduino.cc>
Date: Thu, 14 Apr 2022 15:24:30 +0200
Subject: [PATCH 10/13] moved MB up a line

---
 scripts/validation/rules/rules-spelling.yml | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/scripts/validation/rules/rules-spelling.yml b/scripts/validation/rules/rules-spelling.yml
index 56cb4a7bec..4530ed47bd 100644
--- a/scripts/validation/rules/rules-spelling.yml
+++ b/scripts/validation/rules/rules-spelling.yml
@@ -3,8 +3,7 @@
   shouldMatch: false
   type: warning
   format: markdown
-  errorMessage: "Megabytes should be either written as 'megabytes' or abbreviated as
-    'MB'"
+  errorMessage: "Megabytes should be either written as 'megabytes' or abbreviated as 'MB'"
 
 # MHz / GHz spacing
 - regex: "(?<!\\S)\\b\\d+[MmGg][hH]z\\b"

From c97cc82687301bcb41cd73c3d5a1bfa2bad354db Mon Sep 17 00:00:00 2001
From: Josefine Hansson <j.hansson@arduino.cc>
Date: Thu, 14 Apr 2022 15:53:46 +0200
Subject: [PATCH 11/13] added aditional rules

---
 scripts/validation/rules/rules-spelling.yml | 30 +++++++++++++++------
 1 file changed, 22 insertions(+), 8 deletions(-)

diff --git a/scripts/validation/rules/rules-spelling.yml b/scripts/validation/rules/rules-spelling.yml
index 4530ed47bd..f0ccd75a5c 100644
--- a/scripts/validation/rules/rules-spelling.yml
+++ b/scripts/validation/rules/rules-spelling.yml
@@ -5,8 +5,8 @@
   format: markdown
   errorMessage: "Megabytes should be either written as 'megabytes' or abbreviated as 'MB'"
 
-# MHz / GHz spacing
-- regex: "(?<!\\S)\\b\\d+[MmGg][hH]z\\b"
+# MHz / GHz / kHz spacing
+- regex: "(?<!\\S)\\b\\d+[MmGgk][hH]z\\b"
   shouldMatch: false
   type: warning
   format: markdown
@@ -19,6 +19,13 @@
   format: markdown
   errorMessage: "'Megahertz'/'Gigahertz' should be abbreviated as MHz/GHz"
 
+# kHz spelling
+- regex: "(?<!\\S)\\b\\d+\\s?[Kk]hz\\b"
+  shouldMatch: false
+  type: warning
+  format: markdown
+  errorMessage: "'Kilohertz' should be abbreviated as kHz"
+
 # Mbps / Gbps spacing
 - regex: "(?<!\\S)\\b\\d+[MG]bps\\b"
   shouldMatch: false
@@ -26,15 +33,15 @@
   format: markdown
   errorMessage: Space between unit and value required
 
-# Mbps / Gbps spelling
-- regex: "(?<!\\S)\\b\\d+\\s?[mg]bps\\b"
+# Kbps/ Mbps / Gbps spelling
+- regex: "(?<!\\S)\\b\\d+\\s?[mgk]bps\\b"
   shouldMatch: false
   type: warning
   format: markdown
-  errorMessage: "'Megabit per second' should be abbreviated Mbps, 'Gigabit per second' Gbps"
+  errorMessage: "'Kilobit per second' should be abbreviated as Kbps, 'Megabit per second' as Mbps and 'Gigabit per second' Gbps"
 
-# kB / MB spacing
-- regex: "(?<!\\S)\\b\\d+[mMkK][bB]\\b"
+# kB / KB / Mb / MB / Gb / GB spacing
+- regex: "(?<!\\S)\\b\\d+[gBmMkK][bB]\\b"
   shouldMatch: false
   type: warning
   format: markdown
@@ -47,13 +54,20 @@
   format: markdown
   errorMessage: "'Kilobyte' should be abbreviated as KB, 'Kilobit' as Kb."
 
-# MB spelling
+# MB / Mb spelling
 - regex: "(?<!\\S)\\b\\d+\\s?m[bB]\\b"
   shouldMatch: false
   type: warning
   format: markdown
   errorMessage: "'Megabyte' should be abbreviated as MB, 'Megabit' as Mb."
     
+# GB / Gb spelling
+- regex: "(?<!\\S)\\b\\d+\\s?g[bB]\\b"
+  shouldMatch: false
+  type: warning
+  format: markdown
+  errorMessage: "'Gigabyte' should be abbreviated as GB, 'Gigabit' as Gb."
+
 # μm / mm spacing
 - regex: "(?<!\\S)\\b\\d+[μm]m\\b"
   shouldMatch: false

From abc829c0de6cbd284f402ee9dfffa6bb13272ef2 Mon Sep 17 00:00:00 2001
From: Josefine Hansson <j.hansson@arduino.cc>
Date: Thu, 14 Apr 2022 16:20:37 +0200
Subject: [PATCH 12/13] updated __ per second

---
 scripts/validation/rules/rules-spelling.yml | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/scripts/validation/rules/rules-spelling.yml b/scripts/validation/rules/rules-spelling.yml
index f0ccd75a5c..3f4f431e05 100644
--- a/scripts/validation/rules/rules-spelling.yml
+++ b/scripts/validation/rules/rules-spelling.yml
@@ -33,12 +33,12 @@
   format: markdown
   errorMessage: Space between unit and value required
 
-# Kbps/ Mbps / Gbps spelling
-- regex: "(?<!\\S)\\b\\d+\\s?[mgk]bps\\b"
+# Kbps / KBps / Mbps / MBps / Gbps / GBps spelling
+- regex: "(?<!\\S)\\b\\d+\\s?[kmg][Bb][Pp][Ss]\\b"
   shouldMatch: false
   type: warning
   format: markdown
-  errorMessage: "'Kilobit per second' should be abbreviated as Kbps, 'Megabit per second' as Mbps and 'Gigabit per second' Gbps"
+  errorMessage: "Incorrect abbreviation used. Use one of the following: Kbps, KBps, Mbps, MBps, Gbps or GBps (b = bits, B = bytes)"
 
 # kB / KB / Mb / MB / Gb / GB spacing
 - regex: "(?<!\\S)\\b\\d+[gBmMkK][bB]\\b"

From 3be447ed8d5471d75155acc80cd363e7b8c7880f Mon Sep 17 00:00:00 2001
From: Josefine Hansson <66409231+jhansson-ard@users.noreply.github.com>
Date: Thu, 14 Apr 2022 16:24:19 +0200
Subject: [PATCH 13/13] Update scripts/validation/rules/rules-spelling.yml

---
 scripts/validation/rules/rules-spelling.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/scripts/validation/rules/rules-spelling.yml b/scripts/validation/rules/rules-spelling.yml
index 3f4f431e05..ff424d5ec6 100644
--- a/scripts/validation/rules/rules-spelling.yml
+++ b/scripts/validation/rules/rules-spelling.yml
@@ -27,7 +27,7 @@
   errorMessage: "'Kilohertz' should be abbreviated as kHz"
 
 # Mbps / Gbps spacing
-- regex: "(?<!\\S)\\b\\d+[MG]bps\\b"
+- regex: "(?<!\\S)\\b\\d+[MGK]bps\\b"
   shouldMatch: false
   type: warning
   format: markdown