search

synapsecns / sanguine

Synapse Monorepo
MIT License
43 stars 31 forks source link

Automated spellchecking with `cspell` [SLT-408] #3350

Closed abtestingalpha closed 1 month ago

abtestingalpha commented 1 month ago

Description Adds cspell for automated spellchecking during CI. Package scripts directly affect:

96288845a9ab5aa6395828d7e7a8c458ddfb1cb5: docs preview link 96288845a9ab5aa6395828d7e7a8c458ddfb1cb5: explorer-ui preview link

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!NOTE] Currently processing new changes in this PR. This may take a few minutes, please wait...

📥 Commits Files that changed from the base of the PR and between 421a3434c61d0d95995007f7da20b502360b648f and 0385800a0f00d1bb4f25fff57e1648133d653963.
📒 Files selected for processing (3) * docs/bridge/package.json (2 hunks) * packages/explorer-ui/package.json (2 hunks) * packages/synapse-interface/package.json (2 hunks) 
 _____________________________________________________________________________________________________________________
< The average user doesn't give a damn what happens, as long as (1) it works and (2) it's fast. - Daniel J. Bernstein >
 ---------------------------------------------------------------------------------------------------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).

Walkthrough

The pull request introduces enhancements to the TypeScript workflow by adding a spellcheck step in the linting process and updating the test job for better file change tracking. A new configuration file, cspell.json, is added to specify spell-checking rules and custom dictionaries. Documentation files across various components are updated for typographical corrections and clarity, particularly in the Synapse Bridge SDK and REST API. Additionally, several localization files are modified to correct spelling errors in user messages.

Changes

File Change Summary
.github/workflows/packages.yml Added spellcheck step to lint job and improved file change tracking in test job.
cspell.json New configuration file for spell checking with custom words and ignore rules.
docs/bridge/README.md Corrected typo "regenration" to "regeneration".
docs/bridge/docs/02-Bridge/01-SDK.md Fixed typo "wiht" to "with", clarified options object structure in functions.
docs/bridge/docs/02-Bridge/02-REST-API.md Corrected "hexidecimal" to "hexadecimal" and "addres" to "address".
docs/bridge/docs/04-Routers/01-Synapse-Router/index.md Corrected typographical errors and clarified documentation.
docs/bridge/docs/04-Routers/RFQ/01-Relayer.md Updated terminology and enhanced explanations of relayer functionality.
docs/bridge/docs/04-Routers/RFQ/API/index.md Fixed spelling errors and minor formatting adjustments.
docs/bridge/docs/06-Services/04-Submitter.md Corrected "greatrer" to "greater" and "simultanously" to "simultaneously".
docs/bridge/package.json Added new spellcheck scripts and updated ci:spellcheck.
packages/explorer-ui/components/misc/CopyTitle.tsx Corrected "opaciyt" to "opacity" in class assignment.
packages/explorer-ui/package.json Added spellcheck scripts and new dependency for spell checking.
packages/sdk-router/package.json Added spellcheck scripts for README and new dependency for spell checking.
packages/synapse-constants/package.json Added new script and cleared devDependencies.
packages/synapse-interface/components/Maintenance/components/AnnouncementBanner.tsx Corrected local storage key typo.
packages/synapse-interface/components/Maintenance/example/EcotoneForkUpgrade.tsx Fixed typo in comment section.
packages/synapse-interface/constants/urls/uriToHttp.tsx Corrected comment from "udpate" to "update".
packages/synapse-interface/messages/*.json Corrected "Succesfully" to "Successfully" in multiple localization files.
packages/synapse-interface/package.json Added spellcheck scripts and new dependency for spell checking.
packages/synapse-interface/pages/state-managed-bridge/index.tsx Corrected success message and improved error handling logic.

Possibly related PRs

Suggested labels

size/s

Suggested reviewers

Poem

In the land of code where bunnies hop,
We fixed some typos, made errors stop.
With spellcheck scripts, our docs shine bright,
Clarity and accuracy, oh what a sight!
Hopping through changes, we cheer and play,
For a cleaner codebase, hip-hip-hooray! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
cloudflare-workers-and-pages[bot] commented 1 month ago

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0385800
Status: ✅  Deploy successful!
Preview URL: https://5f81b936.sanguine-fe.pages.dev
Branch Preview URL: https://docs-spellcheck.sanguine-fe.pages.dev

View logs

codecov[bot] commented 1 month ago

Bundle Report

Changes will decrease total bundle size by 3.44MB (-9.64%) :arrow_down:. This is within the configured threshold :white_check_mark:

Detailed changes | Bundle name | Size | Change | | ----------- | ---- | ------ | | sdk-router-@synapsecns/sdk-router-esm* | 255.26kB | 609 bytes (0.24%) :arrow_up: | | sdk-router-@synapsecns/sdk-router-cjs* | 117.55kB | 312 bytes (0.27%) :arrow_up: | | explorer-ui-server-cjs* | 724.87kB | 141.19kB (-16.3%) :arrow_down: | | explorer-ui-client-array-push* | 2.17MB | 146.28kB (-6.32%) :arrow_down: | | synapse-interface-client-array-push* | 7.49MB | 216.91kB (2.98%) :arrow_up: | | synapse-interface-server-cjs* | 1.65MB | 156.93kB (10.5%) :arrow_up: | | widget-cjs-esm* | 271.27kB | 2.03kB (-0.74%) :arrow_down: | | docs-bridge-client-array-push | 7.34MB | 564.45kB (-7.14%) :arrow_down: | | docs-bridge-server-cjs | 11.57MB | 3.31MB (-22.23%) :arrow_down: | | synapse-constants-esm-cjs* | 174.63kB | 174.63kB (100%) :arrow_up: | | synapse-constants-cjs-esm* | 174.18kB | 174.18kB (100%) :arrow_up: |

ℹ️ *Bundle size includes cached data from a previous commit