Skip to content

Comments

Vale rules#96

Closed
m4sterbunny wants to merge 10 commits intomainfrom
vale-rules
Closed

Vale rules#96
m4sterbunny wants to merge 10 commits intomainfrom
vale-rules

Conversation

@m4sterbunny
Copy link
Contributor

@m4sterbunny m4sterbunny commented Feb 12, 2026

Note

Low Risk
CI/docs-lint configuration changes only; primary risk is introducing false positives/negatives in spelling checks or minor workflow execution issues.

Overview
Adds a new GitHub Actions workflow (.github/workflows/spelling.yml) that runs the local docs-spelling-check composite action (Vale) on pull requests and pushes to main.

Tunes Vale rules to reduce noise: ignores Microsoft’s agent(s) terminology preference, adds heading/vocabulary exceptions (e.g., Embedded Wallets, inviter, pimlico, viem), removes the local Microsoft/Very rule file, and updates .gitignore to avoid committing synced style packages while properly ignoring .idea.

Written by Cursor Bugbot for commit 94cf93f. This will update automatically on new commits. Configure here.

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 2 potential issues.

Microsoft.GeneralURL = NO

# Allow "agent" variants despite Microsoft.Terms preference
Microsoft.Terms.Ignore = (?i)\bagents?\b
Copy link

Choose a reason for hiding this comment

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

Microsoft.Terms.Ignore may not be valid Vale config

Medium Severity

Microsoft.Terms.Ignore does not appear to be a documented Vale configuration key. The .Ignore suffix is supported for the built-in Spelling rule (to reference dictionary files), but Microsoft.Terms is a substitution-type rule which only supports exceptions and vocab in its YAML definition. Vale will likely silently ignore this setting, meaning "agent" variants won't actually be excluded from Microsoft.Terms checks. The vocabulary accept.txt or the rule's exceptions array would be the standard way to achieve this.

Fix in Cursor Fix in Web

- Ethers.js
- EthSigner
- EVM
- Embedded Wallets
Copy link

Choose a reason for hiding this comment

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

Heading exception breaks alphabetical list ordering

Low Severity

Embedded Wallets is appended after EVM but the exceptions list is alphabetically ordered. Since "Em" sorts before "EO"/"ER"/"ET"/"EV", this entry belongs between Electron and Emmet to maintain the established ordering convention.

Fix in Cursor Fix in Web

@m4sterbunny
Copy link
Contributor Author

closing this in favor of #98

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant