Add a workflow for checking spelling.

A few more typos in the code were fixed.  Note that the typo in the
`htdocs/library-tree.json` was fixed. We don't actually use that file
anymore anyway.

The following code changes were made so that the words involved do not
need to be blanket ignored.  The weren't good variable names anyway.

* The variable `$pn` in `templates/ContentGenerator/GatewayQuiz.html.ep`
  was renamed to `$problemNumber`.
* The variable `%visibles` in `lib/WeBWorK/Utils/FilterRecords.pm` was
  renamed to `%visibleSets`.
* The wording `select alls` was changed to `select all checkboxes` in the
  comments in `htdocs/js/SelectAll/selectall.js`.

crate-ci/typos is configured via the .typos.toml file with tightly scoped
extend-identifiers/extend-ignore-re entries for the remaining legitimate
non-dictionary terms (crypted, DNE, ANDed, LANGuage, etc.) so the checker
stays useful for catching real future typos.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

Author: drgrice1

.github/workflows/check-spelling.yml

@@ -0,0 +1,20 @@
+---
+name: Check Spelling
+
+on:
+  push:
+    branches-ignore: [main, develop]
+  pull_request:
+
+env:
+  CLICOLOR: 1
+
+jobs:
+  spelling:
+    name: Spell Check with crate-ci/typos
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+      - name: Spell check code
+        uses: crate-ci/typos@v1.50.1

.typos.toml

@@ -0,0 +1,47 @@
+[files]
+extend-exclude = [
+    "lib/WeBWorK/Localize/*",
+    # Filename is fixed asset content, not text to correct.
+    "courses.dist/modelCourse/html/achievements/2nd_order_ode.png",
+]
+
+[default]
+extend-ignore-re = [
+    # Intentional "(mis)coded" wordplay in AccessibilityGuide.md.
+    '\(mis\)coded',
+    # Abbreviation for "full", paired with "scr" (score), in scoring file
+    # suffixes/labels.
+    'ful\.csv',
+    "'scr', 'ful'",
+    'e\.g\. ful',
+    # "Does Not Exist" notation in the MathJax AsciiMath symbol table.
+    'dne: \{',
+    'Dne: \{',
+    'DNE: \{',
+    "output: 'DNE'",
+]
+
+# Each entry below is scoped to one exact identifier/token (case-sensitive,
+# whole-match only) rather than a global word, so it won't suppress a
+# genuine future typo that merely happens to contain the same fragment.
+[default.extend-identifiers]
+# Password-hashing naming convention used throughout (cryptedPassword,
+# crypted_password, etc.), not a typo of "encrypted".
+crypted = "crypted"
+crypted_ = "crypted_"
+cryptedPassword = "cryptedPassword"
+crypted_password = "crypted_password"
+# Variable name for the paired select-all checkboxes.
+pairedSelectAlls = "pairedSelectAlls"
+# Function name (write JSON to file).
+writeJSONtoFile = "writeJSONtoFile"
+# From "ANDed" (logically AND-ed together).
+ANDed = "ANDed"
+# From "LANGuage", deliberately styled to highlight the LANG env var.
+LANGuage = "LANGuage"
+# Placeholder value in docker-config/env.dist.
+sqlRootPasswordSetThisPasswordBEFOREfirstStartingTheDBcontainer = "sqlRootPasswordSetThisPasswordBEFOREfirstStartingTheDBcontainer"
+# Historical spelling preserved verbatim in the Artistic License text.
+MERCHANTIBILITY = "MERCHANTIBILITY"
+# IMS Caliper Analytics spec class name; must match the external spec exactly.
+FillinBlankResponse = "FillinBlankResponse"

doc/AccessibilityGuide.md

@@ -110,22 +110,22 @@ labels in a diagram, etc).
   graph — such as "Graph of y equals x squared" (default is "Graph"). When
   displaying the graph, the `alt` text is converted to an `aria_description`
   which has no character limit. An optional `long_description` can be added
-  to give both a shorter `aria_descripition` and longer description.
+  to give both a shorter `aria_description` and longer description.
 
 - Descriptions of static images (`.png`, `.jpeg`, etc) are provided via the
   `alt` text. `alt` text should be short, under ~125 characters, since many
   screen readers may only read the first ~125 characters of the `alt` text.
   See the PGML help for syntax options to add `alt` text. For anything more
   complicated than a one-line description, provide both a short `alt` text
-  and a full `long_descripition` of the image.
+  and a full `long_description` of the image.
 
 - Graphs created using the `PGlatex.pl`, `PGtikz.pl`, or `PGgraphmacros.pl`
   macros generate static images and follow the same guidelines as static
   images above. Graphs created using the deprecated `PGgraphmacros.pl` should
   migrate to using `plots.pl`. Consider also migrating images created using
   `PGlatex.pl` or `PGtikz.pl` to `plots.pl` as well.
 
-- `long_descripition` can include more than a sentence or paragraph for
+- `long_description` can include more than a sentence or paragraph for
   the image. It can include data tables (for example, a table of (x, y)
   points a plotted curve passes through), and is included in both the HTML
   and hardcopy PDF output, and is visible for sighted users.
@@ -177,5 +177,5 @@ issue.
   [pg repository](https://github.com/openwebwork/pg/issues)
 - If the issue stems from how a specific problem was (mis)coded, please see
   section 3 of this guide. And if you improve the accessibility of the
-  problem, contact your WeBWorK administrator to ask how you could contirubute
+  problem, contact your WeBWorK administrator to ask how you could contribute
   the improvement upstream.

htdocs/js/SelectAll/selectall.js

@@ -6,15 +6,15 @@
 		const checks = document.querySelectorAll(`input[name$=${selectAll.dataset.selectGroup}]`);
 
 		if (selectAll.type.toLowerCase() === 'checkbox') {
-			// Find additional select alls in the same group if any.
+			// Find additional select all checkboxes in the same group if any.
 			const pairedSelectAlls = document.querySelectorAll(
 				`.select-all[data-select-group="${selectAll.dataset.selectGroup}"]`
 			);
 
 			selectAll.addEventListener('click', () => {
 				checks.forEach((check) => (check.checked = selectAll.checked));
 
-				// Also check/uncheck any select alls in the same group.
+				// Also check/uncheck any select all checkboxes in the same group.
 				pairedSelectAlls.forEach((check) => (check.checked = selectAll.checked));
 			});
 

htdocs/library-tree.json

@@ -123,12 +123,13 @@ sub getFiltersForClass {
 			}
 		}
 	} elsif (ref $records[0] eq 'WeBWorK::DB::Record::Set') {
-		my (%assignment_types, %visibles);
+		my (%assignment_types, %visibleSets);
 
 		for my $set (@records) {
 			++$assignment_types{ $set->assignment_type };
-			++$visibles{ $set->visible }
-				unless (defined $visibles{0} && $set->visible eq '' || defined $visibles{''} && $set->visible eq '0');
+			++$visibleSets{ $set->visible }
+				unless (defined $visibleSets{0} && $set->visible eq ''
+					|| defined $visibleSets{''} && $set->visible eq '0');
 		}
 
 		if (keys %assignment_types > 1 && (!%includes || $includes{assignment_type})) {
@@ -137,8 +138,8 @@ sub getFiltersForClass {
 			}
 		}
 
-		if (keys %visibles > 1 && (!%includes || $includes{visible})) {
-			for my $vis (sortByName(undef, keys %visibles)) {
+		if (keys %visibleSets > 1 && (!%includes || $includes{visible})) {
+			for my $vis (sortByName(undef, keys %visibleSets)) {
 				push @filters, [ ($vis ? $c->maketext('Visible') : $c->maketext('Not Visible')) => "visible:$vis" ];
 			}
 		}

lib/WeBWorK/Utils/FilterRecords.pm

@@ -790,7 +790,7 @@ called from a compartment but not compiled within it.
 
 This evaluates the contents of file FILENAME inside the compartment.
 It uses the same rules as perl's built-in C<do> to locate the file,
-poossibly using C<@INC>.
+possibly using C<@INC>.
 
 See above documentation on the B<reval> method for further details.
 

lib/WeBWorK/WWSafe.pm

@@ -439,16 +439,16 @@
 		%
 		% # Set up links between problems and, for multi-page tests, pages.
 		% for my $i (0 .. $#$pg_results) {
-			% my $pn = $i + 1;
+			% my $problemNumber = $i + 1;
 			% content_for 'gw-navigation-problem-row' => begin
 				<td class="problem">
 					% if ($i >= $startProb && $i <= $endProb) {
 						<%= link_to
-							$pn   => '#',
-							class => 'problem-jump-link',
-							data  => { problem_number => $pn } =%>
+							$problemNumber => '#',
+							class          => 'problem-jump-link',
+							data           => { problem_number => $problemNumber } =%>
 					% } else {
-						<%= $pn =%>
+						<%= $problemNumber =%>
 					% }
 				</td>
 			% end

templates/ContentGenerator/GatewayQuiz.html.ep

@@ -28,8 +28,9 @@
 			const webworkConfig = <%== $c->webwork_js_config %>;
 		</script>
 		%
- % # JS Loads
- % # The color scheme JavaScript must be loaded early and not deferred to prevent flickering as the color scheme is set.
+		% # JS Loads
+		% # The color scheme JavaScript must be loaded early and not deferred
+		% # to prevent flickering as the color scheme is set.
 		<%= javascript $c->url({ type => 'webwork', name => 'htdocs', file => 'js/System/color-scheme.js' }) =%>
 		<%= javascript $c->url({ type => 'webwork', name => 'htdocs', file => 'js/MathJaxConfig/mathjax-config.js' }),
 			defer => undef =%>
@@ -182,7 +183,7 @@
 						</nav>
 					</div>
 				</div>
-				% # Navigation, e.g.: Prev, Up, Next for homeworks
+				% # Navigation, e.g.: Prev, Up, Next for homework
 				% if ($c->can('nav')) {
 					<%= $c->nav({ style => 'buttons', separator => '' }) =%>
 				% }