feat: add spell check command (#1738)

Adds cspell for checking project spelling.

Author: achingbrain

.aegir.js

@@ -23,7 +23,8 @@ export default {
             'typedoc-plugin-missing-exports',
             'electron',
             'bytes',
-            'pascalcase'
+            'pascalcase',
+            'cspell'
         ]
     }
 }

README.md

@@ -43,57 +43,6 @@ It bundles config for standard tools such as eslint, mocha, etc and lets you con
 
  Run `aegir --help`
 
- ```bash
- Usage: aegir <command> [options]
-
- Commands:
-   aegir completion                   generate completion script
-   aegir build                        Builds a browser bundle and TS type declara
-                                      tions from the `src` folder.
-   aegir check-project                Ensure your project has the correct config.
-   aegir check                        Check project
-   aegir clean [files..]              Remove created build artifacts.
-   aegir dependency-check [input...]  Run `dependency-check` cli with aegir defau
-                                      lts.              [aliases: dep-check, dep]
-   aegir docs                         Generate documentation from TS type declara
-                                      tions.
-   aegir document-check [input...]    Run `document-check` cli with aegir default
-                                      s.                     [aliases: doc-check]
-   aegir lint-package-json            Lint package.json with aegir defaults.
-                                                     [aliases: lint-package, lpj]
-   aegir lint                         Lint all project files
-   aegir release                      Release using semantic-release
-   aegir release-rc                   Release an RC version of the current module
-                                       or monorepo
-   aegir test-dependant [repo]        Run the tests of an module that depends on
-                                      this module to see if the current changes h
-                                      ave caused a regression
-   aegir test                         Test your code in different environments
-   aegir exec <command>               Run a command in each project of a monorepo
-   aegir run <scripts..>              Run one or more npm scripts in each project
-                                       of a monorepo
-
- Global Options:
-   -h, --help     Show help                                             [boolean]
-   -v, --version  Show version number                                   [boolean]
-   -d, --debug    Show debug output.                   [boolean] [default: false]
-
- Examples:
-   aegir build                               Runs the build command to bundle JS
-                                             code for the browser.
-   npx aegir build                           Can be used with `npx` to use a loca
-                                             l version
-   aegir test -t webworker -- --browser fir  If the command supports `--` can be
-   efox                                      used to forward options to the under
-                                             lying tool.
-   npm test -- -- --browser firefox          If `npm test` translates to `aegir t
-                                             est -t browser` and you want to forw
-                                             ard options you need to use `-- --`
-                                             instead.
-
- Use `aegir <command> --help` to learn more about each command.
- ```
-
  ## Configuration
 
  Aegir can be fully configured using a config file named `.aegir.js` or the package.json using the property `aegir`.

cspell.json

@@ -0,0 +1,42 @@
+{
+  // Enable your dictionary by adding it to the list of `dictionaries`
+  "dictionaries": ["ipfs"],
+
+  // Tell CSpell about your dictionary
+  "dictionaryDefinitions": [{
+    // The name of the dictionary is used to look it up.
+    "name": "ipfs",
+    // Path to the custom word file. Relative to this `cspell.json` file.
+    "path": "./dictionaries/ipfs.txt"
+  }],
+
+  "files": [
+    "**/*.{ts,js,md}",
+    "!**/dist/**",
+    "!**/node_modules/**",
+    "!**/CHANGELOG.md"
+  ],
+
+  "ignoreRegExpList": [
+    // ignore import names (e.g. `import foo from 'module-name-with-typo'`)
+    "/from\\s+(['\"]).*\\1/",
+
+    // ignore dynamic imports
+    "/import(.*)/",
+
+    // ignore anything in backticks
+    "/`.*`/",
+
+    // multiaddrs are not spell checked
+    "/multiaddr(.*)/",
+
+    // peer ids are not spell checked
+    "/peerIdFromString(.*)/",
+
+    // string encoded binary is not spell checked
+    "/uint8ArrayFromString(.*)/",
+
+    // CIDs are not spell checked
+    "/CID(.*)/"
+  ]
+}

dictionaries/ipfs.txt

@@ -0,0 +1,275 @@
+achingbrain
+addr
+addrs
+aegir
+alanshaw
+autodial
+autodialer
+autonat
+bafyfoo
+bafzaa
+bavail
+bfree
+bitfield
+bitswap
+blockstore
+bootstrapper
+bootstrappers
+bufs
+bundlesize
+cbor
+cborg
+cd
+certhash
+certhashes
+chainsafe
+chunker
+ci
+cid
+cids
+cidv
+ciphertext
+cjs
+cms
+cnames
+codecov
+comms
+composable
+const
+createLibp
+crypto
+cryptographically
+dagcbor
+dagjson
+datagrams
+datastore
+dcutr
+dedupe
+dek
+deps
+DER
+derp
+dev
+devcon
+devs
+devtools
+dht
+dhts
+dialability
+dialable
+dialer
+dignifiedquire
+disambiguator
+discv
+dnsaddr
+dnsaddrs
+dnslink
+dumbsub
+encrypter
+Encrypters
+esm
+ethereum
+eventloop
+fanout
+fgrep
+fil
+filecoin
+filecoinv
+firewalled
+floodsub
+fs
+garply
+gater
+ghrelease
+ghtoken
+github
+golog
+gossipsub
+graphana
+graphsync
+hacky
+hamt
+hashers
+helia
+herp
+hopstr
+ihave
+implementers
+impls
+io
+ipcidr
+ipdxco
+ipfs
+ipfsd
+ipjs
+ipld
+ipni
+ipns
+ipshipyard
+ipv
+iterable
+iterables
+iwant
+kad
+kaddht
+kademlia
+kbucket
+keychain
+keypair
+keypairs
+keystore
+kubo
+libjuice
+libp
+maconn
+mafmt
+marshaled
+matcher
+mdns
+mDNS
+meshsub
+millis
+monorepo
+mplex
+multiaddr
+multiaddrs
+multibase
+multicodec
+multicodecs
+multidim
+multiformats
+multihash
+multihashes
+multistream
+muxed
+muxer
+muxerfactory
+muxers
+muxing
+namespace
+namesys
+nat
+nated
+nim
+nist
+nodejs
+npm
+nsecs
+onboarding
+opensource
+osi
+p's
+pbes
+pbkdf
+pblink
+pbstr
+pc
+peerbit
+pem
+perf
+pico
+pinset
+pkcs
+pkix
+plaintext
+pmp
+pnet
+polyfill
+pre
+premajor
+preminor
+prepatch
+priv
+productionization
+programmatically
+protobuf
+protos
+protoschool
+provs
+PRs
+PSK
+pubsub
+pushable
+qmfoo
+quic
+quicv
+reprovide
+reprovider
+requirejs
+responder
+retimeable
+roadmap
+routable
+rpc
+rsa
+runtimes
+sdp
+secio
+secp
+semver
+seqno
+sha
+sparsearray
+ssdp
+ssl
+stablelib
+startable
+startables
+statfs
+stringified
+stringifies
+stringifying
+subarray
+sublist
+subnet
+tdigest
+testdata
+timespec
+toc
+todo
+topologies
+tsconfig
+tutorialkit
+ufrag
+uint
+unconfirm
+undialable
+undialables
+unhandle
+unixfs
+unmarshal
+unmarshaled
+unmarshaling
+unmarshals
+untake
+unwant
+upgradability
+upgrader
+upnp
+upnpnat
+urlpad
+useragent
+varint
+vyzo
+waku
+wantlist
+weakcb
+weald
+webapp
+webrtc
+webrtcdirect
+webtransport
+webworker
+wherearewe
+wnfs
+xSalsa
+xxbloom
+yamux
+adoptopenjdk
+cmdline
+sdkmanager
+avdmanager
+avds
+askpass
+mdast
+conventionalcommits