Merge pull request #320 from srobo/add-spell-check

Add spell checking

Author: sedders123

.gitignore

@@ -3,3 +3,4 @@ _site
 .sass-cache
 .jekyll-metadata
 .bundle
+node_modules/

.spelling

@@ -0,0 +1,50 @@
+APRILTAG
+BODMAS
+CamCon
+DataTraveler
+Duratool
+DTSE9H
+Ebuyer
+iMAX
+IntelliJ
+Nikitin
+ODROID
+overcurrent
+piezo
+Plazma
+PULLUP
+Quarternion
+Ruggeduino
+Ruggeduinos
+Scarzy
+srobo
+ST7202USBGB
+studentrobotics
+usbkey
+Webots
+Zoloto
+
+# Markup
+allowfullscreen
+endcomment
+forloop
+xmlschema
+
+# Python Modules
+dateutil
+dbus
+docopt
+gmqtt
+iniparse
+kiwisolver
+matplotlib
+pydantic
+pygobject
+pyparsing
+pyquaternion
+pyserial
+pytz
+pyudev
+pyusb
+setuptools
+udiskie

Rakefile

@@ -16,6 +16,10 @@ task :dependencies do
   end
 end
 
+task :spelling_dependencies do
+  sh('npm install')
+end
+
 file '_sass/brand/.git' do
   sh('git submodule update --init')
 end
@@ -30,6 +34,8 @@ task :build => [:dependencies, :submodules] do
   sh('bundle exec jekyll build --config _config.yml')
 end
 
+task :build_spellings => [:build, :spelling_dependencies]
+
 task :validate_kit_versions do
   data = YAML.load_file('_data/kit_versions.yml')
   data.each do |entry|
@@ -88,4 +94,8 @@ task :validate_sidebar_tree => [:build] do
   puts "Sidebar links validated successfully"
 end
 
-task :validate => [:validate_kit_versions, :validate_links, :validate_sidebar_tree]
+task :validate_spellings => [:build_spellings] do
+  sh('npm run spell-check')
+end
+
+task :validate => [:validate_kit_versions, :validate_links, :validate_sidebar_tree, :validate_spellings]

_includes/sidebar.html

@@ -16,14 +16,14 @@
           <a href="{{ subheading.url | prepend: site.baseurl }}">{{subheading.title}}</a>
           {% if subheading.tree %}
           <ul>
-          {% for subsubheading in subheading.tree %}
-            <li{% if clean_url == subsubheading.url %} class="selected" {% endif %}>
-              <a href="{{ subsubheading.url | prepend: site.baseurl }}">{{subsubheading.title}}</a>
-              {% if subsubheading.tree %}
+          {% for sub_subheading in subheading.tree %}
+            <li{% if clean_url == sub_subheading.url %} class="selected" {% endif %}>
+              <a href="{{ sub_subheading.url | prepend: site.baseurl }}">{{sub_subheading.title}}</a>
+              {% if sub_subheading.tree %}
               <ul>
-                {% for subsubsubheading in subsubheading.tree %}
-                  <li{% if clean_url == subsubsubheading.url %} class="selected" {% endif %}>
-                    <a href="{{ subsubsubheading.url | prepend: site.baseurl }}">{{subsubsubheading.title}}</a>
+                {% for sub_sub_subheading in sub_subheading.tree %}
+                  <li{% if clean_url == sub_sub_subheading.url %} class="selected" {% endif %}>
+                    <a href="{{ sub_sub_subheading.url | prepend: site.baseurl }}">{{sub_sub_subheading.title}}</a>
                   </li>
                 {% endfor %}
               </ul>

cspell.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "version": "0.2",
+  "dictionaryDefinitions": [
+    {
+      "name": "project-words",
+      "path": "./.spelling",
+      "addWords": true
+    }
+  ],
+  "dictionaries": ["en-gb", "project-words", "python"],
+  "useGitignore": true,
+  "ignorePaths": ["resources/", "vendor/"],
+  "files": ["**/*.html", "**/*.md", "**/*.js", "**/*.css"]
+}

css/interactive_troubleshooter.css

@@ -1,4 +1,4 @@
-div.doc #resetbtnattop {
+div.doc #reset-btn-at-top {
     margin-top: 20px;
     font-weight: bold;
 }

images/content/kit/battery_charger_imaxb6.png renamed to images/content/kit/battery_charger_imax_b6.png

@@ -5,7 +5,7 @@
     function init() {
         globalRadioName = 0;
 
-        var resetBtnAtTop = document.getElementById("resetbtnattop");
+        var resetBtnAtTop = document.getElementById("reset-btn-at-top");
         resetBtnAtTop.style.display = "none";
 
         var troubleshooter = document.getElementById("troubleshooter");
@@ -42,26 +42,26 @@
             parent.appendChild(newMessage);
         }
 
-        if ("askiffixed" in answer) {
-            var question = data.askiffixed_question;
-            question.answers[1].nextquestion = answer.nextquestion;
+        if ("ask_if_fixed" in answer) {
+            var question = data.ask_if_fixed_question;
+            question.answers[1].next_question = answer.next_question;
             appendQuestion(parent, question);
             return;
         }
 
-        if (!("nextquestion" in answer)) {
+        if (!("next_question" in answer)) {
             var newMessage = document.createElement("p");
             newMessage.className = "message";
             newMessage.textContent = "Thank you for using the SR Troubleshooter.";
             parent.appendChild(newMessage);
 
-            var resetBtnAtTop = document.getElementById("resetbtnattop");
+            var resetBtnAtTop = document.getElementById("reset-btn-at-top");
             resetBtnAtTop.style.display = "inline-block";
 
             return;
         }
 
-        appendQuestionById(parent, answer.nextquestion);
+        appendQuestionById(parent, answer.next_question);
     }
 
     function appendQuestionById(parent, id) {