Skip to content

Linter fixes#2873

Merged
alexandratran merged 13 commits intomainfrom
vale-fixes
Apr 21, 2026
Merged

Linter fixes#2873
alexandratran merged 13 commits intomainfrom
vale-fixes

Conversation

@alexandratran
Copy link
Copy Markdown
Contributor

@alexandratran alexandratran commented Apr 18, 2026

Description

  • Vale was previously misconfigured and not running on any doc files. This PR updates the config to ensure the CI runs on all changed lines in md/mdx files. Reviewdog will report warnings and errors. Vale updated in update docs-spelling-check Consensys/github-actions#119 to reflect latest MetaMask conventions and balance strictness; we can continue to update if Vale introduces too much friction in new PRs.
  • Fix most significant/common Vale errors in metamask-connect, smart-accounts-kit, and snaps folders. embedded-wallets may have significant remaining errors.
  • Update Prettier CI to only run on changed files. In case contributors bypass the Prettier pre-commit hook and CI for some reason, other PRs won't be blocked by unrelated Prettier issues.
  • Fix Prettier issues + ignore generated SAK glossary

Preview

Checklist

  • If this PR updates or adds documentation content that changes or adds technical meaning, it has received an approval from an engineer or DevRel from the relevant team.
  • If this PR updates or adds documentation content, it has received an approval from a technical writer.

External contributor checklist

  • I've read the contribution guidelines.
  • I've created a new issue (or assigned myself to an existing issue) describing what this PR addresses.

Note

Medium Risk
CI behavior changes: Vale now runs across the repo’s doc changes and Prettier only checks changed files, which could alter PR gating and miss formatting issues outside the diff if the change-detection step fails.

Overview
Tightens docs quality checks by updating CI: Prettier now runs only on files changed in the PR (using tj-actions/changed-files), and Vale spelling/style checks are no longer path-scoped (with full git history via fetch-depth: 0).

Applies broad documentation lint fixes to satisfy Vale/Prettier conventions across metamask-connect, smart-accounts-kit, and snaps (terminology shifts like sign-in/sign-out, capitalization such as Wallet Standard/Wallet Adapter, link fixes to .mdx, table/MDX formatting, and selective vale off/on blocks).

Treats the Smart Accounts Kit glossary as generated output by ignoring it in .gitignore/.prettierignore, and simplifies scripts/generate-smart-accounts-glossary.js by removing Prettier formatting and wrapping execution in a synchronous try/catch.

Reviewed by Cursor Bugbot for commit 4049694. Bugbot is set up for automated code reviews on this repo. Configure here.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 18, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
metamask-docs Ready Ready Preview, Comment Apr 21, 2026 5:31pm

Request Review

Comment thread .github/workflows/ci.yml Fixed
@alexandratran alexandratran marked this pull request as ready for review April 20, 2026 19:18
@alexandratran alexandratran requested review from a team as code owners April 20, 2026 19:18
@alexandratran alexandratran changed the title Vale fixes Linter fixes Apr 20, 2026
# Conflicts:
#	metamask-connect/troubleshooting/index.md
Copy link
Copy Markdown

@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 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 72a5d4e. Configure here.

Comment thread .github/workflows/ci.yml Outdated
Copy link
Copy Markdown
Contributor

@bgravenorst bgravenorst left a comment

Choose a reason for hiding this comment

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

lgtm

@alexandratran alexandratran merged commit c29532b into main Apr 21, 2026
17 of 19 checks passed
@alexandratran alexandratran deleted the vale-fixes branch April 21, 2026 23:53
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.

3 participants