diff --git a/spelling/.vale-star.ini b/spelling/.vale-star.ini index 07e3247..54148d3 100644 --- a/spelling/.vale-star.ini +++ b/spelling/.vale-star.ini @@ -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 diff --git a/spelling/.vale.ini b/spelling/.vale.ini index 66572b5..c862856 100644 --- a/spelling/.vale.ini +++ b/spelling/.vale.ini @@ -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 diff --git a/spelling/styles/Consensys/Headings.yml b/spelling/styles/Consensys/Headings.yml index 763cd5f..e3eaa40 100644 --- a/spelling/styles/Consensys/Headings.yml +++ b/spelling/styles/Consensys/Headings.yml @@ -7,35 +7,77 @@ 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 @@ -43,10 +85,17 @@ exceptions: - TLS - TypeScript - UI + - Unity - URLs + - UX + - Vanilla JS - Vault + - ViewModel - Visual - VS + - Wallet API + - WebSockets - Windows - YAML - YML + - 2FA diff --git a/spelling/styles/Consensys/Inclusive.yml b/spelling/styles/Consensys/Inclusive.yml index 066ef64..cd81184 100644 --- a/spelling/styles/Consensys/Inclusive.yml +++ b/spelling/styles/Consensys/Inclusive.yml @@ -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"' diff --git a/spelling/styles/Consensys/Weasel.yml b/spelling/styles/Consensys/Weasel.yml index 56bf82c..5eb8536 100644 --- a/spelling/styles/Consensys/Weasel.yml +++ b/spelling/styles/Consensys/Weasel.yml @@ -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 @@ -31,7 +28,6 @@ tokens: - clearly - closely - coldly -# - completely - consequently - correctly - courageously @@ -39,8 +35,6 @@ tokens: - cruelly - crumbly - cuddly -# - currently - - daily - daringly - deadly - definitely @@ -49,7 +43,6 @@ tokens: - dumbly - eagerly - early - - easily - elegantly - enormously - enthusiastically @@ -101,7 +94,6 @@ tokens: - kindly - largely - lately - - lazily - likely - literally - lonely @@ -110,7 +102,6 @@ tokens: - loudly - luckily - madly - - many - mentally - mildly - monthly @@ -121,10 +112,8 @@ tokens: - nervously - nightly - noisily - - normally - obediently - occasionally -# - only - openly - painfully - particularly @@ -134,7 +123,6 @@ tokens: - poorly - powerfully - presumably -# - previously - promptly - punctually - quarterly @@ -154,7 +142,6 @@ tokens: - roughly - rudely - sadly - - safely - selfishly - sensibly - seriously @@ -177,7 +164,6 @@ tokens: - sternly - stupidly - substantially - - successfully - suddenly - surprisingly - suspiciously @@ -190,8 +176,6 @@ tokens: - truthfully - unexpectedly - unfortunately - - usually - - very - victoriously - violently - vivaciously diff --git a/spelling/styles/Microsoft/Adverbs.yml b/spelling/styles/Microsoft/Adverbs.yml index 5619f99..a882c20 100644 --- a/spelling/styles/Microsoft/Adverbs.yml +++ b/spelling/styles/Microsoft/Adverbs.yml @@ -199,6 +199,7 @@ tokens: - shrilly - shyly - silently + - simply - sleepily - slowly - smoothly diff --git a/spelling/styles/Microsoft/Auto.yml b/spelling/styles/Microsoft/Auto.yml index 4da4393..ab92f11 100644 --- a/spelling/styles/Microsoft/Auto.yml +++ b/spelling/styles/Microsoft/Auto.yml @@ -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: diff --git a/spelling/styles/Microsoft/Contractions.yml b/spelling/styles/Microsoft/Contractions.yml index 8c81dcb..6c4b3cf 100644 --- a/spelling/styles/Microsoft/Contractions.yml +++ b/spelling/styles/Microsoft/Contractions.yml @@ -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 diff --git a/spelling/styles/Microsoft/Dashes.yml b/spelling/styles/Microsoft/Dashes.yml index 72b05ba..5bd21f9 100644 --- a/spelling/styles/Microsoft/Dashes.yml +++ b/spelling/styles/Microsoft/Dashes.yml @@ -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: diff --git a/spelling/styles/Microsoft/Ellipses.yml b/spelling/styles/Microsoft/Ellipses.yml index 320457a..6a00a61 100644 --- a/spelling/styles/Microsoft/Ellipses.yml +++ b/spelling/styles/Microsoft/Ellipses.yml @@ -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: diff --git a/spelling/styles/Microsoft/GeneralURL.yml b/spelling/styles/Microsoft/GeneralURL.yml deleted file mode 100644 index dcef503..0000000 --- a/spelling/styles/Microsoft/GeneralURL.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "For a general audience, use 'address' rather than 'URL'." -link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses -level: warning -action: - name: replace - params: - - URL - - address -tokens: - - URL diff --git a/spelling/styles/Microsoft/Quotes.yml b/spelling/styles/Microsoft/Quotes.yml index 38f4976..3d3bf7e 100644 --- a/spelling/styles/Microsoft/Quotes.yml +++ b/spelling/styles/Microsoft/Quotes.yml @@ -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: - '["“][^"”“]+["”][.,]' diff --git a/spelling/styles/Microsoft/Terms.yml b/spelling/styles/Microsoft/Terms.yml index 65fca10..856b561 100644 --- a/spelling/styles/Microsoft/Terms.yml +++ b/spelling/styles/Microsoft/Terms.yml @@ -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) diff --git a/spelling/styles/config/ignore/Consensys-common/project-words.txt b/spelling/styles/config/ignore/Consensys-common/project-words.txt index 8551152..a38a2df 100644 --- a/spelling/styles/config/ignore/Consensys-common/project-words.txt +++ b/spelling/styles/config/ignore/Consensys-common/project-words.txt @@ -16,6 +16,7 @@ adminorg adoptopenjdk adriaan agan +agoric aigc airdrop airnode @@ -34,6 +35,7 @@ algorand alloc allowedfutureblocktime allowlist +allowlisted allowlisting allowlists amarok @@ -47,6 +49,7 @@ apetimism apfs api apis +api's apos appchain appchains @@ -58,6 +61,7 @@ approle approlepath aptos arbitrum +arbitrum's archbee architecting argonconfig @@ -72,14 +76,15 @@ arweave asalt aspecta astro +async atrule atticc attnets aurorascan authkey -authorisation authpath autoconverted +autodetection autogen autogenerating autohide @@ -108,11 +113,15 @@ bhcn biconomy bigints bigram +binance +bitcode +bitswap blish blobbasefee blobhash blockchain blockchains +blockchain's blockexplorer blockheader blocklist @@ -127,31 +136,38 @@ blst bluecircle boolean booleans +bootloader bootnode bootnodes brakedown bridgable briged +browserify browserslist browserstack brqyo buble buildathon builtins +bundler bvfw +bware byos bytecode caabernathy cacheable +caddy caddyfile cakeshop callcode +calldata callouts callstack callTracer camelcase candillon cardlist +casm cbor ccip cdabcdab @@ -165,6 +181,7 @@ chaindata chainlens chainlink chainlist +chainstack changefreq changeit changeme @@ -176,12 +193,14 @@ chrony claimmessage classpath clément +clickjacking clientcert clientkey clienturl clob clonable clsx +codec codefi codegen codehilite @@ -196,12 +215,14 @@ colocation colour commitlint composability +config configfile configout configurability conflator consen consensys +consentful consortiom consortiums containerd @@ -209,6 +230,7 @@ contoso contravariance cookbookdev corejs +coroutines corsdomain counterfactually counterparty @@ -218,6 +240,7 @@ createemptyblocks createnew creativecommons cristiano +cron cronos crypto cryptoassets @@ -243,6 +266,7 @@ datapath datas datashare datatypes +data's dbaeumer dbname dbpassword @@ -250,6 +274,7 @@ dburl dciijx décembre decentralised +decentraweb decommas dedup deduplicated @@ -263,6 +288,7 @@ dencun deps deri deso +destructuring devcontainers deversi devnet @@ -271,6 +297,8 @@ devs devspace devto devtooltest +dialog +dialogs diátaxis dipdup discport @@ -297,6 +325,7 @@ dogfood dogfooding dojocat dooper +dotenv drpc dsla dteku @@ -337,8 +366,11 @@ ensccip ensip ensure entrypoints +enum envio envr +eoas +ephemeral epochlength erim erpc @@ -364,6 +396,7 @@ ethers etherspot ethersproject ethersv +ethjs ethminer ethpure ethscription @@ -375,6 +408,7 @@ ethstats euroe evaluable eventbus +everstake evmdiff evmdistracer evms @@ -398,19 +432,23 @@ failovers fallocate farcaster faucetme +favicon fbid février fienny filebeat filecoin +filestore filterId fixeddifficulty flac +flaskonly fluvi fluviwallet fontawesome foofoo forkchoice +formatters formik fouc foundryup @@ -428,6 +466,7 @@ funboxteam fvy fwdx gabrielcsapo +galactica galxe gameplay gamification @@ -449,12 +488,14 @@ getopts gettransactionexclusionstatusv gettransactionstatus getwork +gif gitgraph gitpod gizathon glassfish glibc globalqueue +globals globalslots globbing globby @@ -492,6 +533,7 @@ hdwallet healthcheck heavener héctor +hedera héllô hellogator helloworld @@ -510,6 +552,7 @@ hostman hostname hostnames hoverable +href hunxh husain hydratedTransactions @@ -529,6 +572,7 @@ ilnft immer immunefi immutabilitythreshold +impactful importcert importcerts in @@ -540,18 +584,24 @@ infima influxd informat informations +infstones infux ingestors +inlined inlines inproc insecureskipverify intelli +interactable interactiveness interchain interpolatable +interprocess investec ipfs ipfsupload +ipfs's +ips irys izumi jacoco @@ -563,6 +613,7 @@ javadoc javalin jaxrs jayant +jazzicon jdbc jdbi jemalloc @@ -578,6 +629,7 @@ jssdk jwt jwts jwtsecret +jwt's kaleido kaszubowski katex @@ -649,6 +701,7 @@ lineabridge lineabuild lineascan lineaster +linea's linenums linkify listschains @@ -677,6 +730,7 @@ marcey markdownextradata marocchino massoud +matchers mathbb mathjax maxlynch @@ -691,7 +745,10 @@ mdxast mdxhast medomain meeet +mello mélen +memoize +memoizing mendi meok meotherdomain @@ -710,11 +767,14 @@ metricbeat metrika mgas microdata +middleware middlewares mimc +mina minerthreads miner_stop minifier +mins mintable mintair mintings @@ -729,6 +789,7 @@ mobula modexp moesif mongo +monorepo moralis mordor msapplication @@ -771,6 +832,7 @@ newkey newnode newPending nextra +nfts nftscan ngryman nidkrpk @@ -780,6 +842,7 @@ nodekey nodekeyhex nodekeys nodeurl +nodies nodiscover noexec noflash @@ -816,7 +879,6 @@ oklink omitempty omni omnichain -onboarded onchain onlinea onquorum @@ -833,6 +895,7 @@ optind orderbooks orgadmin orta +ortner othent otsv outerbounds @@ -868,6 +931,7 @@ permissioned permissioning permissionless permissionlessly +petnames petstore philpl photoshop @@ -886,28 +950,34 @@ plushie plushies pnpm poap +podfile polkadot pollable +polyfill +polyfills polygon ponly postbot postbots postfrens posthog +postinstall pprof pre preactjs preauthenticated +prebuild +prebuilding precache precached precaching +precompiled preconfigured preconnect predeploy prefetch prefetching preloads -prepended preprocess preprocessors prerendered @@ -960,6 +1030,7 @@ qrng quasis quddus quddús +quelquejay queryid querystring quickstart @@ -979,8 +1050,10 @@ randao rapidsnark rawkey reactjs +react's rearchitecture recieve +reconnections recrawl redcircle redelegate @@ -1032,7 +1105,9 @@ rpcnode rpcprefix rtcts rtlcss +runtimes s +safeheron samina samzkback satisfiability @@ -1047,6 +1122,7 @@ scopechat scopescan scriptable scry +sdk's searchbar sebastien sébastien @@ -1069,6 +1145,7 @@ sgaua shamir shannessy sharded +shasum shib shiba shiki @@ -1123,6 +1200,7 @@ stani starknet starks statefulset +stateroot station stationx storepass @@ -1164,6 +1242,7 @@ supabase superfences supermon supernet +superset supplychain supplychainconsortium sushiswap @@ -1197,6 +1276,7 @@ timelock timesync tkbu tldr +tlds tload tlskeystore tlstruststore @@ -1205,6 +1285,7 @@ toBlock tokenomics tomestone toolset +tooltip toplevel tplh tpms @@ -1216,6 +1297,7 @@ treeified treeifies treeify treosh +trezor triaging truffle truffledashboard @@ -1245,23 +1327,32 @@ typesense udpate ultiverse uncollateralize +uncomment +uncommented uncompress undergreen unflat +unicode unifra uint unist +unix unlinkable unlisteds unlocalized unmarshal unmarshalling unmatch +unmount +unmounts unnormalized unoptimized unprefixed unswizzle +untrack +untracked untrusted +unvalidated unversioned upcheck updatepassword @@ -1285,6 +1376,7 @@ validator validatorcontractaddress validators validatorselectionmode +validator's vannicatte vdisk velocore @@ -1302,23 +1394,29 @@ viemv viet viewports vinnik +virtualizable vitalik +vite viti vitidiary vjeux vwap vyper wagmi +wagmi's waitlist waivable +waku walkthrough walletconnect +wasm wbtc wcag weab web3signer webfactory webp +webpack webpackbar webservice websigner @@ -1336,6 +1434,7 @@ wscat wxjb xbeacon xclip +xcode xdns xdoppelganger xhelp @@ -1366,6 +1465,7 @@ zecale zhou zkevm zkex +zksync zkurvpu zkvotev zonic diff --git a/spelling/styles/config/vocabularies/Consensys-common/accept.txt b/spelling/styles/config/vocabularies/Consensys-common/accept.txt index 083adf1..f17f1c7 100644 --- a/spelling/styles/config/vocabularies/Consensys-common/accept.txt +++ b/spelling/styles/config/vocabularies/Consensys-common/accept.txt @@ -25,6 +25,7 @@ Consensys CSpell [dD]app[s]? [dD]eauthoriz(?:e|ing) +[dD]eeplink(?:s|ing)? [dD]enylist[s]? [dD]eserializ(?:e|ing) [dD]eserialization @@ -102,11 +103,12 @@ MkDocs [nN]amespace[s]? [nN]avbar Nginx -Nodejs +Node.js [nN]once[s]? npm nvm OAuth +[oO]nboard(?:s|ing|ed)? opBNB|opbnb Orion [pP]arallelization @@ -114,6 +116,7 @@ paramStructure [pP]articipate Pegasys [pP]ermission(?:ing|ed)? +[pP]repend(?:s|ing|ed)? Photoshop Postgres PoW @@ -133,6 +136,7 @@ Redocusaurus [rR]eentrancy [rR]epurposing REST +rest Rinkeby Roboto Ropsten @@ -149,7 +153,7 @@ Schnorr Slack Splunk StarkGate -Starknet +[sS]tarknet StarkWare [sS]uborganization[s]? Swagger @@ -172,7 +176,7 @@ USB Armory Mk II Vercel Vertx vCPU[s]? -web3 +[wW]eb3 Web3Signer wei [wW]ithdrawable diff --git a/spelling/styles/config/vocabularies/Consensys-common/reject.txt b/spelling/styles/config/vocabularies/Consensys-common/reject.txt index 35b8f8b..f1f771d 100644 --- a/spelling/styles/config/vocabularies/Consensys-common/reject.txt +++ b/spelling/styles/config/vocabularies/Consensys-common/reject.txt @@ -5,11 +5,9 @@ arithmatex [dD]oppelgänger e[rR][cC][ -]20 [eE]therum -evm log[bB]ack|logBack log[sS]tash orion [pP]egaSys p[ -][cC]hain x[ -][cC]hain -[Tt]o[ -]?[Dd]o diff --git a/spelling/styles/proselint/Typography.yml b/spelling/styles/proselint/Typography.yml index 60283eb..5b1af51 100644 --- a/spelling/styles/proselint/Typography.yml +++ b/spelling/styles/proselint/Typography.yml @@ -3,9 +3,9 @@ message: Consider using the '%s' symbol instead of '%s'. level: error nonword: true swap: - '\.\.\.': … +# '\.\.\.': … '\([cC]\)': © '\(TM\)': ™ '\(tm\)': ™ '\([rR]\)': ® - '[0-9]+ ?x ?[0-9]+': × +# '[0-9]+ ?x ?[0-9]+': × diff --git a/spelling/styles/proselint/Very.yml b/spelling/styles/proselint/Very.yml deleted file mode 100644 index e4077f7..0000000 --- a/spelling/styles/proselint/Very.yml +++ /dev/null @@ -1,6 +0,0 @@ -extends: existence -message: "Remove '%s'." -ignorecase: true -level: error -tokens: - - very diff --git a/spelling/styles/write-good/So.yml b/spelling/styles/write-good/So.yml index e57f099..4882534 100644 --- a/spelling/styles/write-good/So.yml +++ b/spelling/styles/write-good/So.yml @@ -1,5 +1,5 @@ extends: existence message: "Don't start a sentence with '%s'." -level: error +level: warning raw: - '(?:[;-]\s)so[\s,]|\bSo[\s,]' diff --git a/spelling/styles/write-good/ThereIs.yml b/spelling/styles/write-good/ThereIs.yml index 8b82e8f..6666106 100644 --- a/spelling/styles/write-good/ThereIs.yml +++ b/spelling/styles/write-good/ThereIs.yml @@ -1,6 +1,6 @@ extends: existence message: "Don't start a sentence with '%s'." ignorecase: false -level: error +level: warning raw: - '(?:[;-]\s)There\s(is|are)|\bThere\s(is|are)\b'