Masses of typos and yet more cSpell changes

andy-preston · May 25, 2024 · cba0f5c · cba0f5c
1 parent 9730b47
commit cba0f5c
Show file tree

Hide file tree

Showing 28 changed files with 246 additions and 232 deletions.
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -1,3 +1,5 @@
+# cSpell:words Eleventy borales
+
 name: Deploy static content to Pages
 
 on:

diff --git a/README.md b/README.md
@@ -1 +1,3 @@
-https://andy-preston.github.io/
+# Andy Preston's Curate's Egg
+
+Source code for <https://andy-preston.github.io/>
diff --git a/builder/cspell.json b/builder/cspell.json
diff --git a/builder/dom-serializer.ts b/builder/dom-serializer.ts
@@ -1,6 +1,6 @@
-"use strict"
-
-// Overcomplicated rigmarole to get `tsx` to import a commonJS module
+// If we simply import dom-serializer, it uses the CommonJS version (why?)
+// and we end up importing an object with a single property: `default` which
+// is a reference to the function we tried to import.
 
 import { require as tsxRequire } from "tsx/cjs/api";
 

diff --git a/builder/eleventy.js b/builder/eleventy.js
@@ -1,5 +1,7 @@
 "use strict";
 
+// cSpell:words syntaxhighlight
+
 import syntaxHighlight from "@11ty/eleventy-plugin-syntaxhighlight";
 import transforms from "./transforms.ts";
 import webCPlugin from "@11ty/eleventy-plugin-webc";

diff --git a/builder/tidy-html.test.ts b/builder/tidy-html.test.ts
@@ -1,8 +1,15 @@
+// cSpell:words quot
+
 import tidy from "./tidy-html.ts";
-import { describe, expect, test } from 'vitest'
+import { describe, expect, test } from "vitest";
 
 describe("Tidy HTML module", () => {
 
+    test("Quotes and ampersands are rendered as entities", () => {
+        const rawHtml = "<a href=\"plop.html\">\"&\"</a>";
+        expect(tidy(rawHtml)).toBe("<a href=\"plop.html\">&quot;&amp;&quot;</a>");
+    });
+
     test("It converts doctype to upper case", () => {
         // https://html-validate.org/rules/doctype-style.html
         const matcher = /^<!DOCTYPE/g;

diff --git a/builder/tidy-html.ts b/builder/tidy-html.ts
@@ -1,3 +1,5 @@
+// cSpell:words domhandler domutils
+
 import { parseDocument } from "htmlparser2";
 import render from "./dom-serializer.ts";
 import { Node, isDirective, isTag, isText, hasChildren } from "domhandler";
@@ -39,6 +41,7 @@ const isNotInline = (node: Node | null): boolean => {
 };
 
 const stripUnusedJs = (node: Node): void => {
+    // This is only needed as long as we're using Eleventy's "chunking"
     if (isTag(node) && node.name == "script" && node.attribs.src == "") {
         removeElement(node);
     }

diff --git a/builder/transforms.ts b/builder/transforms.ts
@@ -20,7 +20,7 @@ const typescript = (content: string): string => ts.transpileModule(content, {
 }).outputText;
 
 export default async (content: string, spec: string): Promise<string> => {
-    // bundler transform pass in a type, HTML transforms a filename
+    // bundler transform passes in a type, HTML transform passes a filename
     const type = spec.includes(".") ?
         path.extname(spec).replace(/^./, "") : spec;
     if (type == "js") {

diff --git a/components/article-index-links.webc b/components/article-index-links.webc
@@ -1,3 +1,4 @@
+<!--- cSpell:words nokeep -->
 <script webc:type="js">
     if (collection == undefined) {
         throw new Error(`*** Section "${section.title}" has no items ***`);

diff --git a/components/cspell.json b/components/cspell.json
diff --git a/components/front-introduction.webc b/components/front-introduction.webc
@@ -1,3 +1,4 @@
+<!-- cSpell:words nokeep -->
 <article>
     <front-illustration
         webc:nokeep

diff --git a/components/page-body.webc b/components/page-body.webc
@@ -1,3 +1,4 @@
+<!-- cSpell:words nokeep -->
 <body webc:nokeep>
     <article-header
         webc:nokeep

diff --git a/components/style.css b/components/style.css
@@ -1,3 +1,5 @@
+/* cSpell:words prolog -->
+
 :root {
     --column-width: 40em;
     --background: #000;

diff --git a/docker/yarn b/docker/yarn
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+# cSpell:words eleventy workdir
+
 case $1 in
 'shell')
     COMMAND='sh'

diff --git a/layout/layout.webc b/layout/layout.webc
@@ -1,3 +1,4 @@
+<!--- cSpell:words nokeep -->
 <html lang="en">
     <head>
         <meta http-equiv="Content-Type" content="text/html; charset=utf-8">

diff --git a/package.json b/package.json
@@ -72,6 +72,22 @@
             }
         ]
     },
+    "cspell": {
+        "version": "0.2",
+        "language": "en-gb",
+        "useGitignore": false,
+        "words": [
+            "webc"
+        ],
+        "overrides": [
+            {
+                "filename": "package.json",
+                "words": [
+                    "stylelint", "prestons", "syntaxhighlight"
+                ]
+            }
+        ]
+    },
     "stylelint": {
         "extends": [
             "stylelint-config-standard"

diff --git a/views/accessing-doctrine-models-as-arrays.webc b/views/accessing-doctrine-models-as-arrays.webc
@@ -1,4 +1,5 @@
 ---
+# cSpell:words ucfirst Symfony
 title: "Accessing Doctrine Models as Arrays"
 tags: php
 ---

diff --git a/views/agility.webc b/views/agility.webc
@@ -1,4 +1,5 @@
 ---
+# cSpell:words pongy
 title: "Agility"
 tags: philosophy
 date: "2023-05-26"

diff --git a/views/blue-pill-black-magic-probe.webc b/views/blue-pill-black-magic-probe.webc
@@ -1,4 +1,6 @@
 ---
+# cSpell:words blacksphere blackmagic stlink swlink imgur
+# cSpell:words JTAG GPIO libnewlib multiarch eabi swdp
 title: "Using a Blue Pill as a Black Magic Probe - The Easy Way"
 tags: micro
 date: "2023-06-26"

diff --git a/views/coding-katas-vs-real-life.webc b/views/coding-katas-vs-real-life.webc
@@ -1,4 +1,5 @@
 ---
+# cSpell:words culting
 title: "Coding Katas Vs Real Life"
 tags: engineering
 date: "2024-02-18"
@@ -112,7 +113,7 @@ reading their code, it comes over as leaning a little towards
 you need Deliberate Practice. And you can spend that time taking exercises
 with no goal beyond development itself or you can find a useful (or, at least,
 useful to you) project to complete. But make sure that project has some
-challenges that will make your skillset grow.</p>
+challenges that will make your skill-set grow.</p>
 
 <p>Be obsessed with software quality and refine your project again and again
 until the code isn't just &quot;not bad&quot; but as close to perfect that you

diff --git a/views/cspell.json b/views/cspell.json
diff --git a/views/docker-gui-non-root.webc b/views/docker-gui-non-root.webc
@@ -1,4 +1,6 @@
 ---
+# cSpell:words Ghidra blacktop
+# cSpell:words DIYLC unzipper noninteractive workdir
 title: "Running GUI Apps in Docker as a non root user"
 tags: docker
 date: "2023-07-11"

diff --git a/views/ffmpeg-recipies.webc b/views/ffmpeg-recipies.webc
@@ -1,4 +1,6 @@
 ---
+# cSpell:words libmp3lame yadif libx264 yuva444p colorchannelmixer
+# cSpell:words astats ametadata lavfi
 title: "FFMPEG Recipes"
 tags: shell
 date: "2024-02-18"
@@ -97,7 +99,7 @@ ffmpeg \
 <section>
 <article><p>Split into chunks each starting on a keyframe</p></article>
 <aside><pre><code>ffmpeg -i ./input.mp4 \
-    -acodec copy -format segment -vcodec copy \
+    -codec:a copy -format segment -codec:v copy \
     -reset_timestamps 1 \
     -map 0 chunk_%06d.mp4</code></pre></aside>
 </section>

diff --git a/views/if-parentheses.webc b/views/if-parentheses.webc
@@ -1,4 +1,5 @@
 ---
+# cSpell:words Rossum
 title: "Parentheses on IF statements"
 tags: philosophy
 date: "2023-09-07"

diff --git a/views/index.webc b/views/index.webc
@@ -1,4 +1,5 @@
 ---
+# cSpell:words edgeeffect youtube hackaday stackexchange Symfony nokeep
 title:
     - "Andy Preston"
     - "(Edge Effect)"

diff --git a/views/little-javascript-examples.webc b/views/little-javascript-examples.webc
@@ -1,4 +1,5 @@
 ---
+# cSpell:words steenkin
 title: "Little JavaScript (TypeScript) Examples"
 tags: javascript
 date: "2024-02-23"

diff --git a/views/null-transport.webc b/views/null-transport.webc
@@ -1,4 +1,5 @@
 ---
+# cSpell:words Symfony
 title: "Debugging and Testing with Symfony's Mailer Component"
 tags: php
 ---
@@ -44,6 +45,4 @@ and paste the following code into the <code>doSend</code> method:</p>
 
 <p>This is just a quick hack-up. The handling of
 <code>./var/mail/</code> is hardly what could be called &quot;robust&quot;.
-But it's fine for testing and debugging environments.</p>
-
-</article></section>
+But it's fine for testing and debugging environments.</p></article></section>