Perform the tool switch to cspell

Author: thompson-tomo

.cspell.yaml

@@ -0,0 +1,109 @@
+# For settings, see
+# https://www.streetsidesoftware.com/vscode-spell-checker/docs/configuration/
+version: '0.2'
+language: en-US
+caseSensitive: true
+allowCompoundWords: true
+useGitignore: true
+import:
+  - https://cdn.jsdelivr.net/npm/@cspell/dict-people-names/cspell-ext.json
+ignorePaths:
+  - '**/*.svg'
+  - '.*.yml'
+  - '.*.yaml'
+  - 'schemas/**'
+  - 'spec-compliance-matrix/*.yaml'
+  - 'oteps/assets/0225*.*'
+patterns:
+  - name: CodeBlock
+    pattern: |
+      /
+          ^(\s*[~`]{3,})   # Matches 3 or more backticks or tildes to start a code block.
+          .*               # all languages and options, e.g. shell {hl_lines=[12]}
+          [\s\S]*?         # content
+          \1               # Matches the same symbol which started the match.
+      /igmx
+  - name: CodeName
+    pattern: |
+      /
+          ([~`])          # Matches a single backtick or tilde to start a code block.
+          [^~`]*?         # Matches any characters except backticks or tildes, non-greedy.
+          \1              # Matches the same symbol which started the match.
+      /x
+  - name: Links
+    pattern: |
+      /
+          \[[^\]]+\]      # Matches the link text inside square brackets [ ... ].
+          \(              # Match the opening parentheses for the URL.
+          [^)]+           # Matches any URL/path until the closing ) — works for both relative and absolute.
+          \)              # Match the closing parentheses for the URL.
+      /x
+  - name: Redirect
+    pattern: |
+      /
+        redirect:.+$     # Matches any front-matter redirect line.
+      /mx
+languageSettings:
+  - languageId:
+      - markdown
+      - yaml
+    ignoreRegExpList:
+      - CodeBlock
+      - CodeName
+      - Links
+      - Redirect
+dictionaries:
+  # Local word lists
+  - en-words
+  # Programming languages and software terms
+  - cpp
+  - csharp
+  - dart
+  - django
+  - docker
+  - dotnet
+  - elixir
+  - flutter
+  - fsharp
+  - golang
+  - haskell
+  - html
+  - java
+  - julia
+  - k8s
+  - kotlin
+  - markdown
+  - node
+  - npm
+  - php
+  - python
+  - ruby
+  - rust
+  - scala
+  - softwareTerms
+  - swift
+  - typescript
+  # Other
+  - companies
+  - aws
+  - google
+  - people-names
+words:
+  - BLRP
+  - Kubecon
+  - OpAMP
+  - OTCA
+  - OTEP
+  - OTTL
+  - cumulatives
+  - deser
+  - inclusivity
+  - oteps
+  - representivity
+  - relatedly
+  - Naur
+  - configurator
+  - relitigating
+  - IDCONTEXT
+  - pdata
+  - Dpanic

.github/workflows/checks.yaml

@@ -85,5 +85,9 @@ jobs:
     - name: check out code
       uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
-    - name: run misspell
-      run: make misspell
+    - uses: streetsidesoftware/cspell-action@v8
+      with:
+        incremental_files_only: false # check all files, not just changed files
+        config: .cspell.yaml
+        suggestions: true
+        treat_flagged_words_as_errors: true

.gitignore

@@ -22,9 +22,6 @@ bin
 # Vim
 .swp
 
-# Misspell binary
-internal/tools/bin
-
 # Node.js files for tools (e.g. markdown-toc)
 node_modules/
 package-lock.json

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "streetsidesoftware.code-spell-checker",
+        "streetsidesoftware.code-spell-checker-cspell-bundled-dictionaries"
+    ]
+}

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
     "rewrap.wrappingColumn": 80,
     "editor.rulers": [80],
+    "cSpell.autoFormatConfigFile": true,
     "markdownlint.config": {
         "MD004": false,
         "MD013": false,

CHANGELOG.md

@@ -169,7 +169,7 @@ release.
 
 ### Common
 
-- OTLP Exporters may allow devs to prepend a product identifier in `User-Agent` header.
+- OTLP Exporters may allow developers to prepend a product identifier in `User-Agent` header.
   ([#4560](https://github.com/open-telemetry/opentelemetry-specification/pull/4560))
 - ⚠️ **IMPORTANT**: Extending the set of standard attribute value types is no longer a breaking change.
   ([#4614](https://github.com/open-telemetry/opentelemetry-specification/pull/4614))

CONTRIBUTING.md

@@ -104,7 +104,7 @@ checks directly.
 See:
 
 - [MarkdownStyle](#markdown-style)
-- [Misspell Check](#misspell-check)
+- [CSpell Check](#cspell-check)
 - Markdown link checking (docs TODO)
 
 ### Autoformatting
@@ -120,7 +120,6 @@ You can also run these fixes individually.
 
 See:
 
-- [Misspell Correction](#misspell-check)
 - Table Generation (docs TODO)
 
 ### Markdown style
@@ -148,24 +147,14 @@ with the Node version of markdownlint. If you are using Visual Studio Code,
 you can also use the `fixAll` command of the
 [vscode markdownlint extension](https://github.com/DavidAnson/vscode-markdownlint).
 
-### Misspell check
+### CSpell check
 
 In addition, please make sure to clean up typos before you submit the change.
 
 To check for typos, run the following command:
 
 ```bash
-make misspell
-```
-
-> [!NOTE]
-> The `misspell` make target will also fetch and build the tool if
-> necessary. You'll need [Go](https://go.dev) to build the spellchecker.
-
-To quickly fix typos, use
-
-```bash
-make misspell-correction
+make cspell
 ```
 
 ## Updating the Compliance Matrix

Makefile

@@ -1,11 +1,5 @@
-# All documents to be used in spell check.
-ALL_DOCS := $(shell find . -type f -name '*.md' -not -path './.github/*' -not -path './node_modules/*' -not -path '*semantic_conventions*' -not -name 'spec-compliance-matrix.md' | sort)
 PWD := $(shell pwd)
 
-TOOLS_DIR := ./internal/tools
-MISSPELL_BINARY=bin/misspell
-MISSPELL = $(TOOLS_DIR)/$(MISSPELL_BINARY)
-
 # Detect Python and pip commands
 PYTHON := $(shell command -v python3 2>/dev/null || command -v python 2>/dev/null)
 PIP := $(shell command -v pip3 2>/dev/null || command -v pip 2>/dev/null)
@@ -28,18 +22,12 @@ SEMCONVGEN_VERSION=0.17.0
 
 # TODO: add `yamllint` step to `all` after making sure it works on Mac.
 .PHONY: all
-all: install-tools markdownlint markdown-link-check misspell
-
-$(MISSPELL):
-	cd $(TOOLS_DIR) && go build -o $(MISSPELL_BINARY) github.com/client9/misspell/cmd/misspell
+all: install-tools markdownlint markdown-link-check cspell
 
-.PHONY: misspell
-misspell:	$(MISSPELL)
-	$(MISSPELL) -error $(ALL_DOCS)
-
-.PHONY: misspell-correction
-misspell-correction:	$(MISSPELL)
-	$(MISSPELL) -w $(ALL_DOCS)
+.PHONY: cspell
+cspell:
+	@if ! npm ls cspell; then npm install; fi
+	npx cspell . --no-progress
 
 .PHONY: markdown-link-check
 markdown-link-check:
@@ -104,14 +92,9 @@ yamllint:
 
 # Run all checks in order of speed / likely failure.
 .PHONY: check
-check: misspell markdownlint markdown-link-check
+check: cspell markdownlint markdown-link-check
 	@echo "All checks complete"
 
-# Attempt to fix issues / regenerate tables.
-.PHONY: fix
-fix: misspell-correction
-	@echo "All autofixes complete"
-
 # Generate spec compliance matrix from YAML source
 .PHONY: compliance-matrix
 compliance-matrix: check-python
@@ -120,6 +103,6 @@ compliance-matrix: check-python
 	@echo "Compliance matrix generation complete"
 
 .PHONY: install-tools
-install-tools: $(MISSPELL)
+install-tools:
 	npm install
 	@echo "All tools installed"