style(coveo.analytics): fix spelling issues - #8065
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
|
Tip All tests passed and all changes approved!🟢 UI Tests: 456 tests unchanged |
@coveo/atomic
@coveo/atomic-hosted-page
@coveo/atomic-legacy
@coveo/atomic-react
@coveo/auth
@coveo/bueno
@coveo/create-atomic
@coveo/create-atomic-component
@coveo/create-atomic-component-project
@coveo/create-atomic-result-component
@coveo/create-atomic-rollup-plugin
@coveo/create-ui
@coveo/headless
@coveo/headless-react
@coveo/relay
@coveo/shopify
commit: |
762cd4e to
de564d7
Compare
4e75917 to
919ecdd
Compare
|
919ecdd to
4b532cf
Compare
There was a problem hiding this comment.
Pull request overview
This PR removes temporary CSpell ignore paths for coveo.analytics docs and fixes spelling issues across the package’s documentation and a few source/test strings to make the imported CAJS snapshot pass CSpell.
Changes:
- Remove CSpell ignore entries for the CAJS README and technical overview and add package-specific dictionary words.
- Fix spelling/typos in CAJS docs and in runtime error messages/JSDoc.
- Add a narrowly scoped inline CSpell directive for a long lorem ipsum test string.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
packages/coveo-analytics/src/react-native/react-native-runtime.ts |
Fix JSDoc tag typo (@default). |
packages/coveo-analytics/src/formatting/format-array-for-coveo-custom-data.spec.ts |
Add a narrow CSpell disable directive for a long test string. |
packages/coveo-analytics/src/client/analyticsFetchClient.ts |
Fix typo in logged error messages (“occurred”). |
packages/coveo-analytics/README.md |
Fix spelling in docs text (with remaining grammar nit noted in review). |
packages/coveo-analytics/docs/technical-overview.md |
Fix spelling variant (“centralize”) (with nearby grammar nit noted in review). |
.cspell.json |
Remove ignorePaths entries for CAJS docs and add dictionary words for intentional identifiers/test values. |
Problem
The cspell dictionary used ad hoc entries for arbitrary CAJS mock and fixture values, making spelling validation less meaningful.
Solution
Removed the arbitrary dictionary entries and normalized affected CAJS test and fixture values to readable
test...,mock..., and descriptive values. Preserved legitimate CAJS identifiers and API field names, updated asserted expectations, and replaced the opaque JWT fixture with a minimal equivalent token. Targeted cspell, oxlint, oxfmt, and whitespace validation pass.