Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add Spell Checker to recommended VS Code extensions #3136

Merged
merged 1 commit into from
Oct 12, 2023

Conversation

Savio-Sou
Copy link
Collaborator

@Savio-Sou Savio-Sou commented Oct 12, 2023

Description

Problem*

The Noir repo does not currently enforce any spell checks, which could lead to:

  • Misspelt APIs, commands, flags, etc. --> user confusions
  • Mismatched interfaces due to e.g. American vs British spelling of the same function --> dev frictions and/or user confusions

Summary*

This PR doesn't enforce a spell check, but adds Code Spell Checker as a recommended VS Code extension for users building in this repo.

Further spell alignments can then be made and enforced more easily through the shared config file cspell.json of this repo.

Additional Context

Referenced AztecProtocol/aztec-packages#2817.

PR Checklist*

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

@Savio-Sou Savio-Sou added the enhancement New feature or request label Oct 12, 2023
@kevaundray kevaundray added this pull request to the merge queue Oct 12, 2023
Merged via the queue into master with commit e88ce80 Oct 12, 2023
30 checks passed
@kevaundray kevaundray deleted the ss/recommend-spell-checker branch October 12, 2023 23:22
TomAFrench added a commit that referenced this pull request Oct 13, 2023
* master:
  chore: Add Spell Checker to recommended VS Code extensions (#3136)
  chore: run `nargo fmt` on integration tests (#3059)
  feat(traits): allow multiple traits to share the same associated function name and to be implemented for the same type (#3126)
  chore(fmt): format parentheses expression (#3132)
  chore(fmt): restore removed comment (#3129)
TomAFrench added a commit that referenced this pull request Oct 13, 2023
* master:
  chore: apply spellcheck (#3143)
  feat: Add experimental REPL-based debugger (#2995)
  fix: do not perform dead instruction elimination on mod,div unless rhs is constant (#3141)
  chore: allow dependencies with the boost source license (BSL-1.0) (#3142)
  feat: Reuse witnesses which have been assigned constant values during ACIR gen (#3137)
  chore: Add Spell Checker to recommended VS Code extensions (#3136)
  chore: run `nargo fmt` on integration tests (#3059)
  feat(traits): allow multiple traits to share the same associated function name and to be implemented for the same type (#3126)
Sakapoi pushed a commit to Sakapoi/noir_fork that referenced this pull request Oct 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants