add spellcheck (#221)

## Description

Adds spell check.

## Motivation and Context

Check errors earlier. I know the PR checks are red but those are
unrelated -> my changes are passing:

## Documentation impact

- [ ] Documentation update required
- [ ] Documentation updated [in another PR](_)
- [x] No documentation update required

## Types of changes

- [ ] Bug fix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to
      not work as expected)

Author: p1003

.cspell.json

@@ -0,0 +1,33 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "dictionaries": ["custom-dictionary"],
+  "dictionaryDefinitions": [
+    {
+      "name": "custom-dictionary",
+      "path": "./spelling.txt",
+      "addWords": true
+    }
+  ],
+  "ignorePaths": [
+    "**/node_modules/**",
+    "packages/**",
+    "docs/api/**",
+    ".git/**",
+    "*.lock",
+    "yarn.lock",
+    "package-lock.json",
+    "api/**"
+  ],
+  "ignoreRegExpList": ["JSXComment", "/^\\s*```[\\s\\S]*?^\\s*```/gm"],
+
+  "patterns": [
+    {
+      "name": "JSXComment",
+      "pattern": "\\{/\\*[\\s\\S]*?\\*/\\}"
+    }
+  ],
+  "enableFiletypes": ["mdx"],
+  "allowCompoundWords": true,
+  "ignoreWords": ["MZWSHSWM"]
+}

.github/workflows/static.yaml

@@ -51,4 +51,7 @@ jobs:
           fi
 
       - name: Check TypeDoc generation
-        run: yarn docs --emit none
+        run: yarn docs
+
+      - name: Spellcheck
+        run: yarn spellcheck

package.json

@@ -8,6 +8,7 @@
   "packageManager": "yarn@4.4.0",
   "devDependencies": {
     "@eslint/js": "^9.23.0",
+    "cspell": "^9.4.0",
     "eslint": "^9.23.0",
     "globals": "^16.0.0",
     "prettier": "^3.5.3",
@@ -23,6 +24,8 @@
     "typecheck": "yarn workspaces foreach -A -p run typecheck",
     "format:check": "yarn workspaces foreach -A -p run format:check",
     "format": "yarn workspaces foreach -A -p run format",
-    "docs": "typedoc"
+    "docs": "typedoc",
+    "spellcheck": "cspell '**/*.md' '**/*.mdx' '**/*.html' --exclude '**/api/**' --show-suggestions",
+    "spellcheck:report": "yarn spellcheck --no-show-suggestions"
   }
 }

packages/js-server-sdk/src/agent.ts

@@ -93,7 +93,7 @@ export class FishjamAgent extends (EventEmitter as new () => TypedEmitter<AgentE
   }
 
   /**
-   * Interrupt track indentified by `trackId`.
+   * Interrupt track identified by `trackId`.
    *
    * Any audio that has been sent by the agent, but not played
    * by Fishjam will be cleared and be prevented from playing.

spelling.txt

@@ -0,0 +1,108 @@
+# markdown-spellcheck spelling configuration file
+
+# Format - lines beginning # are comments
+
+# global dictionary is at the start, file overrides afterwards
+
+# one word per line, to define a file override use ' - filename'
+
+# where filename is relative to this configuration file
+
+stateful
+webhooks
+webhook
+websocket
+metadata
+Fishjam
+backend
+SDK
+SDKs
+url
+params
+NodeJS
+e.g.
+js-server-sdk
+Docusaurus
+pre-configured
+TabItem
+AndroidManifest.xml
+iOS
+Xcode
+UI
+dev
+Podfile
+TLDR
+frontend
+quicknavigation
+src
+carditems
+webrtc
+item.title.tolowercase
+videoroom
+fishjam.io
+room.fishjam.io
+unmuting
+programmatically
+unmute
+middleware
+encodings
+apis
+unmuted
+FastAPI
+Fastify
+fishjamclient
+codebase
+protobuf
+websockets
+deduplication
+se
+InstallPackage
+ConfigurePermissions
+mdx
+_components
+fastify
+JSON
+props.children
+_common
+header.mdx
+MetadataHeader
+joining_room.mdx
+JoiningRoom
+updating.mdx
+UpdatingMetadata
+reading.mdx
+ReadingMetadata
+codecs
+H.264
+VP8
+codec
+bitrates
+preprocess
+customsource
+js
+visioncamera
+frameprocessorplugin
+Javascript
+WebGL
+WebGPU
+Three.js
+PixiJS
+MediaStream
+WHEP
+livestream
+livestreaming
+broadcasted
+livestreamer
+livestreams
+async
+boolean
+asyncio
+mrousavy
+xcworkspace
+Pixi
+pydantic
+uvicorn
+QVGA
+Memberof
+unmutes
+websocat