@kitschpatrol/cspell-config 4.4.3 → 4.6.0

package/dictionaries/kp-tech.txt

@@ -0,0 +1,329 @@
+aacbrew
+Acrobits
+Airtable
+altool
+apos
+AppFlowy
+apufix
+Archivy
+Armbian
+armhf
+Artnet
+Astro
+astrojs
+autohide
+autoimports
+autoplay
+autoresizing
+backlink
+backlinking
+backlinks
+backtest
+balena
+Balsamiq
+beforeunload
+bézier
+Bibliogram
+bindability
+Blotar
+Boostnote
+bootable
+boto
+browserconfig
+Bugsense
+Bulma
+bumpp
+buttongrid
+bzdata
+bzpkg
+camelcase
+camerakit
+cameraring
+camerawheel
+certbot
+chezmoi
+chipset
+clippy
+cmark
+cocoapods
+codebases
+codebooga
+codellama
+codesigning
+Codespaces
+Colibri
+Collab
+colspan
+combinators
+Coqui
+coreboot
+cosmicconfig
+Cousine
+Cpath
+cpufreq
+crossorigin
+csvg
+cubicbezier
+cupsctl
+Cura
+Cyberduck
+Cython
+Datalog
+dataview
+Datejs
+datetime
+deepmerge
+Dendron
+deno
+disablepictureinpicture
+Dokku
+dpkg
+draggability
+duti
+Dyntube
+Emolex
+execa
+exif
+exiftool
+exportdb
+faststart
+favicons
+fddk
+ffprobe
+fieldset
+figcaption
+fileprivate
+filesize
+filesys
+Flashforge
+fontsource
+fortawesome
+fpsgraph
+fullscreen
+Futil
+Gridsome
+haml
+hashchange
+iframes
+imagetools
+introend
+introstart
+InvisBox
+jetblack
+jsonifiable
+JUCE
+Keybr
+keyof
+Kinect
+langchain
+lerp
+libreddit
+linebreak
+linkedom
+linkify
+localizable
+Loggly
+Lume
+Luminar
+Maaku
+markdownit
+maxlength
+Mbps
+mdast
+mdat
+mdatrc
+mdsvex
+mdxconfig
+mdxjs
+mediahasplayed
+Memex
+Menlo
+mergeable
+Meslo
+MikroTik
+Mimestream
+min
+Mindflex
+miniconda
+Mkdown
+Monaspace
+Monkeytype
+Monospice
+moveto
+movflags
+mrmime
+mstile
+Mullvad
+multimethod
+multiport
+Multitaction
+nannou
+Netatalk
+Netgate
+Netgear
+Newswire
+Niantic
+Nimbot
+Ninite
+Nitter
+Noctua
+Nodebox
+nodenext
+nokey
+noopener
+noprint
+noreferrer
+noscript
+notarytool
+Notenik
+Noteplan
+Noteship
+nothrow
+Noti
+notionhq
+Noto
+numpy
+Nuxt
+Obinslab
+objc
+oclif
+Odroid
+Odroidh
+Odroidxu
+oklab
+ollama
+openframeworks
+openmediavault
+openscad
+osascript
+osxphotos
+outfile
+outro
+outroend
+outrostart
+overscroll
+pagecrypt
+pagefind
+Pandoc
+Panebuilder
+Panepaint
+Parachain
+parsimmon
+pdfreader
+pendingupload
+pfsense
+phasor
+Photomator
+Photoshop
+photoswipe
+pinojs
+pipx
+Piwick
+Pixelmator
+Pixera
+playsinline
+Polycode
+positionals
+Preact
+precompress
+preprocessors
+prezto
+projectz
+Protectli
+proto
+protobuf
+Protokol
+Protovis
+Proxyman
+pushshift
+qscale
+radiogrid
+raytrace
+rclone
+rcmdnk
+realfavicongenerator
+rehype
+remarklint
+remarkrc
+resizability
+Roboto
+scikit
+scipy
+screenshare
+scrollbooster
+seedrandom
+signale
+silencedetect
+Simplenote
+Siri
+slnc
+slugified
+smartctl
+smartmontools
+Snipster
+squoosh
+Statamic
+Strapi
+Stuntz
+stylelintrc
+stylesheet
+subclassable
+subclassing
+subgrids
+subheadline
+subviews
+Superslides
+svelteness
+Sveltepress
+SwiftyMarkdown
+Swinsian
+syncmd
+syncme
+tabindex
+taskkill
+Tauri
+tbody
+templating
+testid
+textbox
+thead
+Threlte
+tiktoken
+tinycolor
+tinyllama
+tldraw
+torchaudio
+torchvision
+tsconfigs
+tsdoc
+tslog
+tsparticles
+tsquery
+tsup
+Tukul
+tweakpane
+universaljs
+unplugin
+USBImager
+vapo
+vectorstore
+vfile
+virtualenv
+vmax
+vmin
+Vokaloid
+Vuetify
+webarchive
+Webflow
+webui
+Wekinator
+wght
+whisperx
+woob
+WorkFlowy
+worktree
+xcrun
+yadm
+Zigbee
+zimfw
+zplug

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@kitschpatrol/cspell-config",
-  "version": "4.4.3",
+  "version": "4.6.0",
   "type": "module",
-  "description": "CSPell config for @kitschpatrol/shared-config",
+  "description": "CSpell configuration for @kitschpatrol/shared-config.",
   "repository": {
     "type": "git",
     "url": "git@github.com:kitschpatrol/shared-config.git",
@@ -28,10 +28,17 @@
   "main": "./cspell.config.json",
   "files": [
     "bin/*",
+    "dictionaries/*",
     "init/*"
   ],
+  "keywords": [
+    "shared-config",
+    "cspell-config",
+    "cspell",
+    "cli"
+  ],
   "peerDependencies": {
-    "cspell": "^8.1.3"
+    "cspell": "^8.6.0"
   },
   "dependencies": {
     "@pinojs/json-colorizer": "^4.0.0",
@@ -44,6 +51,7 @@
   },
   "scripts": {
     "build": "../../scripts/build.ts && mdat readme",
-    "cli": "node ./bin/cli.js"
+    "cli": "node ./bin/cli.js",
+    "list-words": "cat ./dictionaries/*.txt"
   }
 }

package/readme.md

@@ -7,7 +7,7 @@
 [![NPM Package @kitschpatrol/cspell-config](https://img.shields.io/npm/v/@kitschpatrol/cspell-config.svg)](https://npmjs.com/package/@kitschpatrol/cspell-config)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-**CSPell config for @kitschpatrol/shared-config**
+**CSpell configuration for @kitschpatrol/shared-config.**
 
 <!-- /header -->
 
@@ -59,7 +59,7 @@ Integrate with your `package.json` scripts as you see fit, for example:
 
 #### Command: `cspell-config`
 
-CSPell config for @kitschpatrol/shared-config
+CSpell configuration for @kitschpatrol/shared-config.
 
 Usage:
 
@@ -77,11 +77,64 @@ cspell-config [<file|glob> ...]
 
 <!-- /cli-help -->
 
+## Configuration
+
+### Disabling bundled dictionaries
+
+In additional to CSpell's default dictionary configuration, this shared configuration enables a number of dictionaries that ship with CSpell for all file types:
+
+- [`lorem-ipsum`](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/lorem-ipsum/dict/lorem.txt)
+- [`git`](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/git/cspell-ext.json)
+- [`gaming-terms`](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/gaming-terms/dict/gaming-terms.txt)
+- [`npm`](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/npm/dict/npm.txt)
+- [`data-science`](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/data-science/dict/data-science.txt)
+- [`fullstack`](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/fullstack/dict/fullstack.txt)
+
+It also includes a number of _custom_ dictionaries distributed with this package, all of which are enabled by default:
+
+- `kp-acronyms` Contains acronyms
+- `kp-brands` Contains proper nouns like brand names
+- `kp-misc` Contains general and miscellaneous words
+- `kp-tech` Tech-specific terminology, some ambiguity vs. "brands"
+- `kp-names` Human names and usernames
+
+In your project's root `.cspell.json`, you can disable any combination of these dictionaries by adding them to the `dictionaries` array with a `!` prefix.
+
+For example, do disable the `kp-acronyms` and `kp-brands` dictionaries:
+
+```json
+{
+  "import": "@kitschpatrol/cspell-config",
+  "dictionaries": [
+    "!kp-acronyms",
+    "!kp-brands"
+    // ...Addtional !-prefixed dicitonary names
+  ]
+}
+```
+
+### Adding project-scoped words
+
+In your project's root `.cspell.json`:
+
+```json
+{
+  "import": "@kitschpatrol/cspell-config",
+  "words": [
+    "mountweazel",
+    "steinlaus",
+    "jungftak",
+    "esquivalience"
+    // ...Additional words
+  ]
+}
+```
+
 ## Notes
 
 This config includes a bunch of words I've happened to have needed to use. Your preferences will vary.
 
-CSpell is configured to automatically ignore files and paths in `.gitignore` (via `"useGitignore": true`).
+CSpell is configured to automatically ignore files and paths in `.gitignore` (via `"useGitignore": true`), and to ignore words inside of ` ``` ` code fences in markdown and mdx files.
 
 <!-- license -->