ci: add spellcheck

Author: SethFalco

.github/workflows/spellcheck.yml

@@ -0,0 +1,13 @@
+name: Check spelling
+
+on:
+  pull_request:
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: streetsidesoftware/cspell-action@v6
+        with:
+          incremental_files_only: false

cspell.jsonc

@@ -0,0 +1,57 @@
+{
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "version": "0.2",
+  "words": [
+    "André", // Name
+    "beziers",
+    "csstree", // https://www.npmjs.com/package/css-tree
+    "csswhat", // https://www.npmjs.com/package/css-what
+    "currentcolor", // SVG keyword
+    "deoptimized",
+    "elems", // Abbreviation for "elements"
+    "fontawesome",
+    "Fontello",
+    "Fonticons",
+    "frontends",
+    "grunt-svgmin",
+    "hkern",
+    "hrefs",
+    "Inkscape", // https://inkscape.org/
+    "inlines",
+    "panose",
+    "stemh",
+    "stemv",
+    "subselector",
+    "SVGOMG", // https://jakearchibald.github.io/svgomg/
+    "unenc", // Abbreviation for "unencoded"
+    "viewbox", // SVG keyword
+    "vkern",
+    "xast",
+    "Xlink",
+  ],
+  "ignorePaths": ["*.svg.txt", "*.svg"],
+  "ignoreRegExpList": [
+    "-moz", // Mozilla Firefox CSS prefix
+    "'.+?.svg',", // path to file with .svg extension
+    "[a-z]+: '#[a-f\\d]+',", // Color names in _collection.js
+    "[a-z]+…", // Words that have been cut off by an ellipsis
+    "@author .+", // JSDoc author tag line, usually names
+    "\"name\": .+", // package.json author name property
+    "\\*\\*SVG O\\*\\*ptimizer", // README
+    "&.+?;", // HTML entity
+    "<svg.+>", // Inline SVG in code
+    "Atrule", // At-rule
+    "data:image/.+", // Data URI
+    "datauri", // Data URI
+    "descs", // Abbreviation of "descriptions"
+    "id=([\"']).+?\\1", // ID attribute of inline SVG
+    "import .+", // Import statements in Javascript
+    "nums", // Abbreviation of "numbers"
+    "onwarn", // Rollup API,
+    "QRAB|QRCD",
+    "rrggbb",
+    "sax\\..+", // Any properties of the sax API
+    "shorthex", // Parameter of convertColors plugin
+    "sodipodi(?::[a-z]+)?", // https://wikipedia.org/wiki/Sodipodi
+  ],
+}

docs/04-plugins/cleanupIds.mdx

@@ -16,7 +16,7 @@ svgo:
       description: Elements with an ID that starts with one of these prefixes will be ignored.
       default: []
     force:
-      description: This plugin normally does nothing if a `<script>` or `<style>` element is found. Setting this to true will bypass that behaviour, which may result in destructive changes.
+      description: This plugin normally does nothing if a `<script>` or `<style>` element is found. Setting this to true will bypass that behavior, which may result in destructive changes.
       default: false
   defaultPlugin: true
 ---

lib/parser.js

@@ -11,7 +11,6 @@
  * @typedef {import('./types.js').XastChild} XastChild
  */
 
-// @ts-ignore sax will be replaced with something else later
 import SAX from 'sax';
 import { textElems } from '../plugins/_collections.js';
 

lib/svgo.test.js

@@ -1,10 +1,6 @@
 import { jest } from '@jest/globals';
 import { optimize } from './svgo.js';
 
-/**
- * @typedef {import('../lib/types.js').Plugin} Plugin
- */
-
 test('allow to setup default preset', () => {
   const svg = `
     <?xml version="1.0" encoding="utf-8"?>
@@ -353,9 +349,6 @@ test('slices long line in error code snippet', () => {
 test('multipass option should trigger plugins multiple times', () => {
   const svg = `<svg id="abcdefghijklmnopqrstuvwxyz"></svg>`;
   const list = [];
-  /**
-   * @type {Plugin<void>}
-   */
   const testPlugin = {
     name: 'testPlugin',
     fn: (_root, _params, info) => {

plugins/_collections.js

@@ -2397,7 +2397,7 @@ export const pseudoClasses = {
     'disabled',
     'enabled',
     'in-range',
-    'indetermined',
+    'indeterminate',
     'invalid',
     'optional',
     'out-of-range',

plugins/minifyStyles.js

@@ -58,7 +58,7 @@ export const fn = (_root, { usage, ...params }) => {
   return {
     element: {
       enter: (node, parentNode) => {
-        // detect deoptimisations
+        // detect deoptimizations
         if (hasScripts(node)) {
           deoptimized = true;
         }
@@ -115,7 +115,7 @@ export const fn = (_root, { usage, ...params }) => {
             }
 
             // preserve cdata if necessary
-            // TODO split cdata -> text optimisation into separate plugin
+            // TODO split cdata -> text optimization into separate plugin
             if (cssText.indexOf('>') >= 0 || cssText.indexOf('<') >= 0) {
               styleNode.children[0].type = 'cdata';
               styleNode.children[0].value = minified;

plugins/plugins-types.d.ts

@@ -108,13 +108,13 @@ type DefaultPlugins = {
 
   minifyStyles: {
     /**
-     * Disable or enable a structure optimisations.
+     * Disable or enable a structure optimizations.
      * @default true
      */
     restructure?: boolean;
     /**
      * Enables merging of @media rules with the same media query split by other rules.
-     * The optimisation is unsafe in general, but should work fine in most cases. Use it on your own risk.
+     * The optimization is unsafe in general, but should work fine in most cases. Use it on your own risk.
      * @default false
      */
     forceMediaMerge?: boolean;