Skip to content

chore: add spellchecker extension recommendation for VSCode developers; add lavamoat & blockaid to workspace dictionary#23210

Merged
davidmurdoch merged 1 commit intodevelopfrom
spellcheck
Mar 1, 2024
Merged

chore: add spellchecker extension recommendation for VSCode developers; add lavamoat & blockaid to workspace dictionary#23210
davidmurdoch merged 1 commit intodevelopfrom
spellcheck

Conversation

@davidmurdoch
Copy link
Copy Markdown
Contributor

@davidmurdoch davidmurdoch commented Feb 27, 2024

This adds a new extension recommendation for developers using VSCode: Code Spell Checker. It is optional to install, but when installed is useful for catching misspellings in code, comments, prose, etc.

Two downsides to using the extension:

  • It can be noisy in some files that use a lot of abbreviations, "PPOM"-related files come to mind.
  • VSCode may take an extra ~500ms to open the MM extension workspace.

See the Code Spell Checker VSCode extension documentation for details: https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker

To Test:

  • Install the extension into VSCode by using the link in the extension's page linked above to install, or in VSCode press Ctrl/Cmd+ Shift + X, then search for "Code Spell Checker" (by "Street Side Software")
  • open any file
  • type a word that is mispelled.
  • Place text cursor within the word then either press Ctrl/Cmd + . or click the lightbulb icon that appears.

Examples:

Misspellings will show a squiggly underline:

example

Demonstrating Suggestions and Add to Dictionary:

suggestions

Tooltip of a misspelling:

image

VSCode "Problems" panel:

image

Misspellings are highlighted in blue (dark mode) in the VSCode scroll bar:

image


This PR only adds two words to the dictionary: lavamoat and blockaid, just to get things started. I expect many more domain-specific words and abbreviations will be added over time.

If you hate this idea, let me know!

@davidmurdoch davidmurdoch added the team-extension-platform Extension Platform team label Feb 27, 2024
@davidmurdoch davidmurdoch requested a review from a team as a code owner February 27, 2024 21:04
@github-actions
Copy link
Copy Markdown
Contributor

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

@codecov
Copy link
Copy Markdown

codecov bot commented Feb 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.61%. Comparing base (d120d63) to head (b637097).
Report is 5 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop   #23210   +/-   ##
========================================
  Coverage    68.61%   68.61%           
========================================
  Files         1098     1098           
  Lines        43103    43103           
  Branches     11513    11513           
========================================
  Hits         29571    29571           
  Misses       13532    13532           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@metamaskbot
Copy link
Copy Markdown
Collaborator

Builds ready [f3b10df]
Page Load Metrics (1246 ± 414 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint851961303316
domContentLoaded147833199
load7221951246862414
domInteractive147733199
Bundle size diffs
  • background: 0 Bytes (0.00%)
  • ui: 0 Bytes (0.00%)
  • common: 0 Bytes (0.00%)

…s; add lavamoat & blockaid to workspace dictionary
@metamaskbot
Copy link
Copy Markdown
Collaborator

Builds ready [b637097]
Page Load Metrics (1099 ± 363 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint792251263919
domContentLoaded1280392211
load7219891099756363
domInteractive1280392211
Bundle size diffs
  • background: 0 Bytes (0.00%)
  • ui: 0 Bytes (0.00%)
  • common: 0 Bytes (0.00%)

@gauthierpetetin gauthierpetetin added the needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) label Mar 1, 2024
@davidmurdoch davidmurdoch merged commit 7fea26d into develop Mar 1, 2024
@davidmurdoch davidmurdoch deleted the spellcheck branch March 1, 2024 21:00
@github-actions github-actions bot locked and limited conversation to collaborators Mar 1, 2024
@github-actions github-actions bot removed the needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) label Mar 1, 2024
@metamaskbot metamaskbot added the release-11.13.0 Issue or pull request that will be included in release 11.13.0 label Mar 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

release-11.13.0 Issue or pull request that will be included in release 11.13.0 team-extension-platform Extension Platform team

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

5 participants