cspell-config-spellbookx 0.7.2 → 0.7.3

package/.turbo/turbo-build.log

@@ -1,7 +1,7 @@
 
-> cspell-config-spellbookx@0.7.2 build /home/runner/work/spellbookx/spellbookx/packages/cspell-config-spellbookx
+> cspell-config-spellbookx@0.7.3 build /home/runner/work/spellbookx/spellbookx/packages/cspell-config-spellbookx
 > rolldown -c && tsc
 
 [log] <DIR>/index.js  chunk │ size: 2.91 kB
 [log]
-[success] rolldown v1.0.0-rc.1 Finished in 63.96 ms
+[success] rolldown v1.0.0-rc.1 Finished in 36.92 ms

package/README.md

@@ -1,121 +1,72 @@
 # cspell-config-spellbookx
 
-Shared configuration for [CSpell](https://cspell.org) - tuned for polyglot monorepos (Node, Rust, Go, Python, and more).  
-Clean. Opinionated. No junk, no false positives.
+Shared [CSpell](https://cspell.org/) configuration for the Spellbookx project. This package provides a consistent and robust spell-checking setup for all packages in the monorepo.
 
----
+## Description
 
-## Table of Content
+This package offers a comprehensive CSpell configuration that includes:
 
-- [Features](#features)
-- [Installation](#installation)
-- [Usage](#usage)
-- [Development](#development)
-- [License](#license)
+- A curated list of custom words and technical terms specific to the Spellbookx ecosystem.
+- An extensive list of ignored paths to prevent spell-checking in irrelevant files and directories (e.g., `node_modules`, `dist`, lock files).
+- A rich set of dictionaries for various languages and technologies, including English, Spanish, Italian, French, German, and numerous programming languages.
+- Support for multiple languages: English, Spanish, Italian, French, and German.
 
----
+## Why use this?
 
-## Features
+By using this shared configuration, we ensure that:
 
-- Pre-tuned dictionaries for:
-  - English (US/GB)
-  - Common programming languages (TypeScript, Node, Python, Go, PHP, etc.)
-  - Framework & tooling terms (npm, softwareTerms, misc)
-- Smart `ignorePaths` that skip all build artifacts, lock files, and temp directories:
-  - Node / JS / TS (`dist`, `node_modules`, `.next`, `.turbo`, etc.)
-  - Rust (`target/`, `.cargo/`, `Cargo.lock`)
-  - Go (`go.sum`, `vendor/`, etc.)
-  - Python (`__pycache__`, `.venv/`, `.tox/`, `.ruff_cache/`, etc.)
-  - Windows / WSL cruft (`:Zone.Identifier`, `Thumbs.db`, `desktop.ini`, etc.)
-- Works seamlessly with modern CSpell (`>=6.0`) using native ESM & `defineConfig`
-
----
+- Spell-checking is consistent across all packages.
+- False positives are minimized by maintaining a central list of accepted words.
+- The configuration is easily maintainable and extendable.
 
 ## Installation
 
-```bash
-npm install -g cspell
-npm install -D cspell @cspell/cspell-types cspell-config-spellbookx
-```
+Install the package using your favorite package manager:
 
-or
+**npm**
 
 ```bash
-pnpm add -g cspell
-pnpm add -D cspell @cspell/cspell-types cspell-config-spellbookx
+npm install --save-dev cspell-config-spellbookx cspell
 ```
 
-or
+**pnpm**
 
 ```bash
-yarn global add cspell
-yarn add -D cspell @cspell/cspell-types cspell-config-spellbookx
+pnpm add -D cspell-config-spellbookx cspell
 ```
 
-or
+**yarn**
 
 ```bash
-bun add -g cspell
-bun add -D cspell @cspell/cspell-types cspell-config-spellbookx
+yarn add -D cspell-config-spellbookx cspell
 ```
 
----
-
-## Usage
-
-Create a custom dictionary:
+**bun**
 
 ```bash
-mkdir .cspell
-touch .cspell/custom-words.txt
-```
-
-Then create or update your `cspell.config.cjs` at the root of your project:
-
-```js
-const { defineConfig } = require('@cspell/cspell-types');
-
-module.exports = defineConfig({
-  version: '0.2',
-  import: ['cspell-config-spellbookx'],
-  words: [],
-  dictionaryDefinitions: [
-    {
-      name: 'custom-words',
-      path: './.cspell/custom-words.txt',
-      addWords: true,
-    },
-  ],
-  dictionaries: ['custom-words'],
-});
+bun add -d cspell-config-spellbookx cspell
 ```
 
-Then, run:
-
-```bash
-npx cspell lint '**/*.{ts,js,tsx,jsx,md}'
-```
-
-or integrate with Nx, Husky, Lefthook, or your CI.
-
----
+## Usage
 
-## Development
+To use this configuration, create a `cspell.config.cjs` file in your project's root and extend this package:
 
-If you are contributing inside the monorepo:
+```javascript
+const config = require('cspell-config-spellbookx');
 
-```bash
-nx run cspell-config:build
+module.exports = config;
 ```
 
-Test the config locally:
+You can then add a script to your `package.json` to run the spell checker:
 
-```bash
-npx cspell lint --config path-to/packages/cspell-config/dist/index.js .
+```json
+{
+  "scripts": {
+    "spellcheck": "cspell \"**/*.{js,jsx,ts,tsx,md,json}\""
+  }
+}
 ```
 
----
-
 ## License
 
 This project is licensed under the MIT License.

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "cspell-config-spellbookx",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "private": false,
-  "description": "Shared cspell (spell checker) configuration for Spellbookx",
+  "description": "A shareable CSpell configuration for spell-checking in a monorepo.",
   "keywords": [
     "cspell",
-    "spellchecker",
-    "spellcheck",
     "cspell-config",
-    "spellbookx"
+    "spellbookx",
+    "spellcheck",
+    "spellchecker"
   ],
   "homepage": "https://github.com/spellbookx/spellbookx#readme",
   "bugs": {
@@ -40,7 +40,7 @@
     "@types/node": "^25.0.10",
     "rolldown": "1.0.0-rc.1",
     "typescript": "5.9.2",
-    "@spellbookx/typescript-config": "0.7.2"
+    "@spellbookx/typescript-config": "0.7.3"
   },
   "publishConfig": {
     "access": "public"