chore: add spell checking and fix typos#180
Open
thephez wants to merge 4 commits intodashpay:masterfrom
Open
Conversation
Due to how cspell splits words, some partial terms are detected as typos, like "Serv" (part of ProUpServTx), etc
📝 WalkthroughWalkthroughThis PR establishes spell-checking infrastructure by introducing cspell configuration, a custom project-words dictionary, and package dependency. Documentation files are updated with spell-checker directives and minor corrections including a serialization format fix and field name change. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
dip-0003.md (1)
269-278:⚠️ Potential issue | 🟠 MajorFix markdownlint MD032 list spacing in validation rules.
CI is currently failing at Line 270 (
MD032/blanks-around-lists). Add blank lines before the ordered lists under “In the case of type 0:”, “In the case of type 1:”, and “Applicable to any type:” so the markdownlint workflow passes.Proposed fix
In the case of type 0: + 1. collateralOutpoint `hash` is null but an output with 1000 DASH is not present at position `n` of the ProRegTx outputs 2. collateralOutpoint `hash` is not null but an output with 1000 DASH can't be found in the UTXO specified by the `hash` and `n` In the case of type 1: + 1. collateralOutpoint `hash` is null but an output with 4000 DASH is not present at position `n` of the ProRegTx outputs 2. collateralOutpoint `hash` is not null but an output with 4000 DASH can't be found in the UTXO specified by the `hash` and `n` Applicable to any type: + 1. Any KeyId* field is null (KeyIdOwner, KeyIdOperator or KeyIdVoting) 2. KeyIdOwner or PubKeyOperator was already used by any entry in the registered masternodes setAs per coding guidelines, “Markdown linting is enforced on all changed
.mdfiles via GitHub Actions using markdownlint-cli2 with the.markdownlint.jsonconfiguration”.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@dip-0003.md` around lines 269 - 278, The markdown lists under the headings "In the case of type 0:", "In the case of type 1:", and "Applicable to any type:" are missing a blank line before the ordered lists, causing markdownlint MD032 failures; fix by inserting a single blank line immediately before each ordered list (the lines starting with "1.") so each heading is followed by a blank line then the numbered list, ensuring the three sections ("In the case of type 0:", "In the case of type 1:", "Applicable to any type:") conform to markdownlint spacing rules.
🧹 Nitpick comments (1)
package.json (1)
2-4: Move cspell to devDependencies.cspell is development-only tooling (used only for spell-checking in markdown documentation via
<!-- cspell:ignore -->comments) and has no runtime usage. Keeping it independenciesunnecessarily bloats production installations.Proposed fix
{ - "dependencies": { + "devDependencies": { "cspell": "9.7.0" } }🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@package.json` around lines 2 - 4, The package.json currently lists "cspell" under "dependencies"; move "cspell": "9.7.0" from the dependencies object into devDependencies so it’s only installed for development. Update package.json to remove the entry from "dependencies" and add it under "devDependencies" (keeping the same version string "9.7.0"), then run your package manager to update lockfiles (e.g., npm install or pnpm install) so the lockfile reflects the change.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@dip-0003.md`:
- Around line 269-278: The markdown lists under the headings "In the case of
type 0:", "In the case of type 1:", and "Applicable to any type:" are missing a
blank line before the ordered lists, causing markdownlint MD032 failures; fix by
inserting a single blank line immediately before each ordered list (the lines
starting with "1.") so each heading is followed by a blank line then the
numbered list, ensuring the three sections ("In the case of type 0:", "In the
case of type 1:", "Applicable to any type:") conform to markdownlint spacing
rules.
---
Nitpick comments:
In `@package.json`:
- Around line 2-4: The package.json currently lists "cspell" under
"dependencies"; move "cspell": "9.7.0" from the dependencies object into
devDependencies so it’s only installed for development. Update package.json to
remove the entry from "dependencies" and add it under "devDependencies" (keeping
the same version string "9.7.0"), then run your package manager to update
lockfiles (e.g., npm install or pnpm install) so the lockfile reflects the
change.
ℹ️ Review info
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (11)
.cspell.json.gitignoredip-0003.mddip-0006.mddip-0010.mddip-0014.mddip-0015.mddip-0028.mddip-0029.mdpackage.jsonproject-words.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ser<sub>p</sub>→ser<sub>P</sub>- case consistency (line 158);0X→0x- hex prefix (line 187)publishMessage→publicMessage- wrong field name (line 671)Summary by CodeRabbit
Bug Fixes
Documentation
Chores