Replace misspell with cspell and perform spelling fixes #4728

.cspell.yaml

@@ -0,0 +1,54 @@
+# For settings, see
+# https://www.streetsidesoftware.com/vscode-spell-checker/docs/configuration/
+version: '0.2'
+language: en-US
+caseSensitive: false
+allowCompoundWords: true
+useGitignore: true
+ignorePaths:
+  - '**/*.svg'
+files:
+  - '**/*.md'
+patterns:
+  - name: CodeBlock
+    pattern: |
+      /
+          ^(\s*[~`]{3,})   # code-block start
+          .*               # all languages and options, e.g. shell {hl_lines=[12]}
+          [\s\S]*?         # content
+          \1               # code-block end - cSpell:disable-next-line
+      /igmx
+  - name: CodeName
+    pattern: |
+      /
+          ([~`])
+          [^~`]*?
+          \1
+      /x
+  - name: UnderscoreName
+    pattern: |
+      /
+          ([_])
+          [^_]*?
+          \1
+      /x
+languageSettings:
+  - languageId: markdown
+    ignoreRegExpList:
+      - CodeBlock
+      - CodeName
+      - UnderscoreName
+dictionaryDefinitions:
+  - name: en-words
+    path: .cspell/en-words.txt
+dictionaries:
+  # Local word lists
+  - en-words
+  # Programming languages and software terms
+  - cpp
+  - dotnet
+  - golang
+  - node
+  - softwareTerms
+  # Other
+  - companies

.cspell/en-words.txt

@@ -0,0 +1,210 @@
+# Words listed here are only for their spelling. If there is a certain way to
+# capitalize the word, ensure textlint is configured, add capitalization rules
+# to text-lint rules in .textlintrc.yaml.
+#
+ABNF
+accountingservice
+actix
+adservice
+alibaba
+Alolita
+APAC
+apidocs
+appdynamics
+appender
+appenders
+aspecto
+autoconfiguration
+autoinstrumentation
+autoloaded
+autoloader
+autoloading
+backoff
+BLRP
+caml
+Capnproto
+cartservice
+cassandra
+CBOR
+checkoutservice
+Chronosphere
+classpath
+cloudevents
+cncf
+collectd
+comms
+configurator
+Cumulatives
+currencyservice
+daemonset
+datadog
+deser
+discoverability
+dotnet
+Drutu
+dubbo
+Dugar
+Dyla
+dynatrace
+dyno
+ebpf
+emailservice
+EMEA
+erlang
+errorf
+Ertl
+faas
+featureflagservice
+flagd
+frauddetectionservice
+frontendproxy
+github
+gitpod
+grafana
+Grassi
+Hausenblas
+Horvitz
+htlhash
+hugo
+inclusivity
+initializers
+instana
+istio
+jaeger
+jaegertracing
+Janotti
+javaagent
+javadoc
+javadocs
+jaxrs
+jboss
+jdbc
+Joao
+JSTOR
+julia
+Juraci
+Kehlenbeck
+knative
+kotlin
+Kröhling
+kubecon
+kubernetes
+kvlist
+laravel
+lifecycles
+lightstep
+Liudmila
+Loffay
+LTSV
+Mancuso
+Marcinak
+Marylia
+microservices
+Moessis
+Molkova
+mongodb
+Najaryan
+Naur
+ndjson
+Neena
+Neumann
+Neumüller
+nginx
+NUMA
+ocaml
+Omnition
+OOTB
+opamp
+opencensus
+openmetrics
+opensearch
+opentelemetry
+opentracing
+openzipkin
+OSTIF
+OTCA
+otel
+otel-comms
+otel-endusers
+otelcol
+otep
+oteps
+otlp
+Otmar
+OTTL
+Owais
+packagist
+pageinfo
+Paixão
+parameterizing
+parentbased
+Pavol
+paymentservice
+postgresql
+Pranay
+Prateek
+prepper
+productcatalogservice
+profilerpedia
+prometheus
+proto
+protobuf
+quantile
+quantiles
+quarkus
+quoteservice
+rabbitmq
+react-native-app
+recommendationservice
+redis
+Reiley
+Relatedly
+representivity
+Rexed
+rocketmq
+Ruech
+runbook
+runbooks
+Rynn
+SDID
+Sébastien
+semconv
+servlet
+Severin
+Sharma
+shippingservice
+Shkuro
+SIEM
+signalfx
+Socha
+Stalnaker
+stdoutmetric
+Strimzi
+symfony
+tabpane
+textlint
+thanos
+Tigran
+tocstop
+tracecontext
+traceidratio
+traceloop
+traceparent
+traefik
+Trask
+triager
+Triagers
+UCUM
+uids
+unconference
+unsampled
+unshallow
+upstreamed
+vdso
+Villela
+webjs
+wordpress
+WSGI
+zend
+zipkin
+zpages

.github/workflows/checks.yaml

@@ -79,11 +79,16 @@ jobs:
     - name: validate compliance-matrix
       run: git diff --exit-code spec-compliance-matrix.md || (echo 'Generated compliance matrix is out of date, please run "make compliance-matrix" and commit the changes in this PR.' && exit 1)
 
-  misspell:
+  cspell:
     runs-on: ubuntu-latest
     steps:
     - name: check out code
       uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1
 
-    - 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
+        use_cspell_files: 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

@@ -122,10 +122,10 @@ release.
 
 ### Compatibility
 
-- Flexibilie escaping of characters that are discouraged by Prometheus Conventions
+- Flexible escaping of characters that are discouraged by Prometheus Conventions
   in Prometheus exporters.
   ([#4533](https://github.com/open-telemetry/opentelemetry-specification/pull/4533))
-- Flexibilize addition of unit/type related suffixes in Prometheus exporters.
+- Flexibility in addition of unit/type related suffixes in Prometheus exporters.
   ([#4533](https://github.com/open-telemetry/opentelemetry-specification/pull/4533))
 - Define the configuration option "Translation Strategies" for Prometheus exporters.
   ([#4533](https://github.com/open-telemetry/opentelemetry-specification/pull/4533))
@@ -921,7 +921,7 @@ release.
 
 - Add optional configuration for Prometheus exporters to promote resource attributes to metric attributes
   ([#3761](https://github.com/open-telemetry/opentelemetry-specification/pull/3761))
-- Clarifications and flexibility in Exemplar speicification.
+- Clarifications and flexibility in Exemplar specification.
   ([#3760](https://github.com/open-telemetry/opentelemetry-specification/pull/3760))
 
 ### Logs
@@ -1125,7 +1125,7 @@ release.
 
 - No changes.
 
-### Supplemenatary Guidelines
+### Supplementary Guidelines
 
 - No changes.
 
@@ -1180,7 +1180,7 @@ release.
 
 - No changes.
 
-### Supplemenatary Guidelines
+### Supplementary Guidelines
 
 - No changes.
 
@@ -1241,7 +1241,7 @@ release.
 
 - No changes.
 
-### Supplemenatary Guidelines
+### Supplementary Guidelines
 
 - No changes.
 
@@ -1291,7 +1291,7 @@ release.
   namespaces.
   ([#3507](https://github.com/open-telemetry/opentelemetry-specification/pull/3507))
 
-### Supplemenatary Guidelines
+### Supplementary Guidelines
 
 - No changes.
 
@@ -1370,7 +1370,7 @@ release.
 - Add log entries to specification README.md contents.
   ([#3435](https://github.com/open-telemetry/opentelemetry-specification/pull/3435))
 
-### Supplemenatary Guidelines
+### Supplementary Guidelines
 
 - Add guidance to use service-supported propagation formats as default for AWS SDK client calls.
   ([#3212](https://github.com/open-telemetry/opentelemetry-specification/pull/3212))
@@ -2631,7 +2631,7 @@ Added telemetry schemas documents to the specification ([#2008](https://github.c
 ### OpenTelemetry Protocol
 
 - Add environment variables for configuring the OTLP exporter protocol (`grpc`, `http/protobuf`, `http/json`) ([#1880](https://github.com/open-telemetry/opentelemetry-specification/pull/1880))
-- Allow implementations to use their own default for OTLP compression, with `none` denotating no compression
+- Allow implementations to use their own default for OTLP compression, with `none` indicating no compression
   ([#1923](https://github.com/open-telemetry/opentelemetry-specification/pull/1923))
 - Clarify OTLP server components MUST support none/gzip compression
   ([#1955](https://github.com/open-telemetry/opentelemetry-specification/pull/1955))