Skip to content

style(coveo.analytics): fix spelling issues - #8065

Merged
alexprudhomme merged 3 commits into
mainfrom
cspell-coveo-analytics
Jul 27, 2026
Merged

style(coveo.analytics): fix spelling issues#8065
alexprudhomme merged 3 commits into
mainfrom
cspell-coveo-analytics

Conversation

@alexprudhomme

@alexprudhomme alexprudhomme commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

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.

@svcsnykcoveo

svcsnykcoveo commented Jul 24, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@chromatic-com

chromatic-com Bot commented Jul 24, 2026

Copy link
Copy Markdown

Tip

All tests passed and all changes approved!

🟢 UI Tests: 456 tests unchanged
🟢 UI Review: 465 stories published -- no changes
Storybook icon Storybook Publish: 465 stories published

@pkg-pr-new

pkg-pr-new Bot commented Jul 24, 2026

Copy link
Copy Markdown
@coveo/atomic

npm i https://pkg.pr.new/@coveo/atomic@8065

@coveo/atomic-hosted-page

npm i https://pkg.pr.new/@coveo/atomic-hosted-page@8065

@coveo/atomic-legacy

npm i https://pkg.pr.new/@coveo/atomic-legacy@8065

@coveo/atomic-react

npm i https://pkg.pr.new/@coveo/atomic-react@8065

@coveo/auth

npm i https://pkg.pr.new/@coveo/auth@8065

@coveo/bueno

npm i https://pkg.pr.new/@coveo/bueno@8065

@coveo/create-atomic

npm i https://pkg.pr.new/@coveo/create-atomic@8065

@coveo/create-atomic-component

npm i https://pkg.pr.new/@coveo/create-atomic-component@8065

@coveo/create-atomic-component-project

npm i https://pkg.pr.new/@coveo/create-atomic-component-project@8065

@coveo/create-atomic-result-component

npm i https://pkg.pr.new/@coveo/create-atomic-result-component@8065

@coveo/create-atomic-rollup-plugin

npm i https://pkg.pr.new/@coveo/create-atomic-rollup-plugin@8065

@coveo/create-ui

npm i https://pkg.pr.new/@coveo/create-ui@8065

@coveo/headless

npm i https://pkg.pr.new/@coveo/headless@8065

@coveo/headless-react

npm i https://pkg.pr.new/@coveo/headless-react@8065

@coveo/relay

npm i https://pkg.pr.new/@coveo/relay@8065

@coveo/shopify

npm i https://pkg.pr.new/@coveo/shopify@8065

commit: b0ab03f

@github-actions

github-actions Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

🔗 Scratch Orgs ready to test this PR:

@changeset-bot

changeset-bot Bot commented Jul 27, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: b0ab03f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Base automatically changed from format-coveo-analytics to main July 27, 2026 12:36
@alexprudhomme
alexprudhomme force-pushed the cspell-coveo-analytics branch from 919ecdd to 4b532cf Compare July 27, 2026 12:42
@alexprudhomme
alexprudhomme marked this pull request as ready for review July 27, 2026 12:44
@alexprudhomme
alexprudhomme requested review from a team July 27, 2026 12:44

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread packages/coveo-analytics/README.md Outdated
Comment thread packages/coveo-analytics/docs/technical-overview.md Outdated
Comment thread .cspell.json Outdated
Comment thread .cspell.json Outdated
Comment thread .cspell.json Outdated
@alexprudhomme
alexprudhomme added this pull request to the merge queue Jul 27, 2026
Merged via the queue into main with commit ef8a9fb Jul 27, 2026
91 checks passed
@alexprudhomme
alexprudhomme deleted the cspell-coveo-analytics branch July 27, 2026 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants