Skip to content

Commit

Permalink
Merge pull request #63 from alexandratran/metamask-vale
Browse files Browse the repository at this point in the history
Updates for MetaMask docs
  • Loading branch information
alexandratran authored Nov 6, 2024
2 parents f6ff2d3 + cac1381 commit 4b80446
Show file tree
Hide file tree
Showing 20 changed files with 179 additions and 55 deletions.
3 changes: 3 additions & 0 deletions spelling/.vale-star.ini
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ Microsoft.Acronyms = NO
# Microsoft.Avoid is not relevant
Microsoft.Avoid = NO

# Quite quotes: too many false positives
Microsoft.Quotes = NO

# Quiet weasel: is replaced by Consensys list
write-good.Weasel = NO

Expand Down
3 changes: 3 additions & 0 deletions spelling/.vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ Microsoft.Acronyms = NO
# Microsoft.Avoid is not relevant
Microsoft.Avoid = NO

# Quite quotes: too many false positives
Microsoft.Quotes = NO

# Quiet weasel: is replaced by Consensys list
write-good.Weasel = NO

Expand Down
49 changes: 49 additions & 0 deletions spelling/styles/Consensys/Headings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,46 +7,95 @@ match: $sentence
indicators:
- ':'
exceptions:
- ABI
- Account Management API
- Android
- API
- APIs
- AWS
- Azure
- Besu
- Binance Smart Chain
- BLS
- BNB Chain
- Caddy
- Chain Methods API
- CLI
- Code
- Consensys
- Cosmos
- CSP
- curl
- Docker
- ECMAScript
- EIP
- Electron
- Emmet
- EOA
- ERC
- ETH
- Ethereum
- EthSigner
- EVM
- FAQs
- Flask
- GoQuorum
- Hashicorp
- HTTP
- HTTPS
- Hyperledger
- ID
- IPFS
- JavaScript
- JSON
- JSX
- JWTs
- KMS
- Kubernetes
- Linux
- macOS
- Marketplace
- MetaMask
- MetaMask Mobile
- MIPD
- MongoDB
- Next.js
- NFT
- NFTs
- Node.js
- PoS
- Python
- Quorum
- Orion
- PegaSys
- PostgreSQL
- React
- React Native
- RPC
- Rust
- SDK
- SES
- Snap
- Snaps
- Snap's
- Studio
- Swagger
- TOML
- REPL
- TLS
- TypeScript
- UI
- Unity
- URLs
- UX
- Vanilla JS
- Vault
- ViewModel
- Visual
- VS
- Wallet API
- WebSockets
- Windows
- YAML
- YML
- 2FA
5 changes: 2 additions & 3 deletions spelling/styles/Consensys/Inclusive.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@ link: https://github.com/Consensys/doc.common/wiki/Documentation-Style-Guide#5-b
ignorecase: true
level: error
swap:
'black[ \-]?list(?:ed|(?:ing)?s?)': '"denylist", "excludelist", or "blocklist"'
'white[ \-]?list(?:ed|(?:ing)?s?)': '"allowlist", "trustlist", or "safelist"'
'black[ \-]?list(?:ed|(?:ing)?s?)': '"denylist"'
'white[ \-]?list(?:ed|(?:ing)?s?)': '"allowlist"'
'gr[ae]y[ \-]?list(?:ed|(?:ing)?s?)': '"provisional" or "temporary" list'
'masters?': '"main", "parent" or "primary"'
'slaves?': '"replica" or "subordinate"'
'm[ae]n': '"person"'
'natives?': 'a more precise term like "built-in"'
'first[ \-]?class citizens?': '"core feature" or "top-level"'
'h[au]ng': '"stop responding"'
18 changes: 1 addition & 17 deletions spelling/styles/Consensys/Weasel.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
extends: existence
message: "'%s' is a weasel word!"
ignorecase: true
level: warning
level: suggestion
tokens:
- absolutely
- accidentally
# - additionally
- allegedly
# - alternatively
- angrily
- anxiously
- approximately
- awkwardly
- badly
- barely
Expand All @@ -31,16 +28,13 @@ tokens:
- clearly
- closely
- coldly
# - completely
- consequently
- correctly
- courageously
- crinkly
- cruelly
- crumbly
- cuddly
# - currently
- daily
- daringly
- deadly
- definitely
Expand All @@ -49,7 +43,6 @@ tokens:
- dumbly
- eagerly
- early
- easily
- elegantly
- enormously
- enthusiastically
Expand Down Expand Up @@ -101,7 +94,6 @@ tokens:
- kindly
- largely
- lately
- lazily
- likely
- literally
- lonely
Expand All @@ -110,7 +102,6 @@ tokens:
- loudly
- luckily
- madly
- many
- mentally
- mildly
- monthly
Expand All @@ -121,10 +112,8 @@ tokens:
- nervously
- nightly
- noisily
- normally
- obediently
- occasionally
# - only
- openly
- painfully
- particularly
Expand All @@ -134,7 +123,6 @@ tokens:
- poorly
- powerfully
- presumably
# - previously
- promptly
- punctually
- quarterly
Expand All @@ -154,7 +142,6 @@ tokens:
- roughly
- rudely
- sadly
- safely
- selfishly
- sensibly
- seriously
Expand All @@ -177,7 +164,6 @@ tokens:
- sternly
- stupidly
- substantially
- successfully
- suddenly
- surprisingly
- suspiciously
Expand All @@ -190,8 +176,6 @@ tokens:
- truthfully
- unexpectedly
- unfortunately
- usually
- very
- victoriously
- violently
- vivaciously
Expand Down
1 change: 1 addition & 0 deletions spelling/styles/Microsoft/Adverbs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ tokens:
- shrilly
- shyly
- silently
- simply
- sleepily
- slowly
- smoothly
Expand Down
2 changes: 1 addition & 1 deletion spelling/styles/Microsoft/Auto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ extends: existence
message: "In general, don't hyphenate '%s'."
link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/auto
ignorecase: true
level: error
level: warning
action:
name: convert
params:
Expand Down
2 changes: 1 addition & 1 deletion spelling/styles/Microsoft/Contractions.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
extends: substitution
message: "Use '%s' instead of '%s'."
link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-contractions
level: error
level: suggestion
ignorecase: true
action:
name: replace
Expand Down
2 changes: 1 addition & 1 deletion spelling/styles/Microsoft/Dashes.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ message: "Remove the spaces around '%s'."
link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/emes
ignorecase: true
nonword: true
level: error
level: warning
action:
name: edit
params:
Expand Down
2 changes: 1 addition & 1 deletion spelling/styles/Microsoft/Ellipses.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ extends: existence
message: "In general, don't use an ellipsis."
link: https://docs.microsoft.com/en-us/style-guide/punctuation/ellipses
nonword: true
level: warning
level: suggestion
action:
name: remove
tokens:
Expand Down
11 changes: 0 additions & 11 deletions spelling/styles/Microsoft/GeneralURL.yml

This file was deleted.

2 changes: 1 addition & 1 deletion spelling/styles/Microsoft/Quotes.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
extends: existence
message: 'Punctuation should be inside the quotes.'
link: https://docs.microsoft.com/en-us/style-guide/punctuation/quotation-marks
level: error
level: warning
nonword: true
tokens:
- '["“][^"”“]+["”][.,]'
2 changes: 1 addition & 1 deletion spelling/styles/Microsoft/Terms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ ignorecase: true
action:
name: replace
swap:
"(?:agent|virtual assistant|intelligent personal assistant)": personal digital assistant
"(?:virtual assistant|intelligent personal assistant)": personal digital assistant
"(?:assembler|machine language)": assembly language
"(?:drive C:|drive C>|C: drive)": drive C
"(?:internet bot|web robot)s?": bot(s)
Expand Down
Loading

0 comments on commit 4b80446

Please sign in to comment.