cspell-glob 10.3.1-alpha.1 → 10.3.1

package/README.md

@@ -10,10 +10,27 @@ This library doesn't do any file i/o. It uses [micromatch](https://github.com/mi
 
 ## Usage
 
+```ts
+import { GlobMatcher } from 'cspell-glob';
+
+// Patterns behave like the contents of a `.gitignore` file.
+const patterns = ['*.test.js', '!important.test.js'];
+
+const matcher = new GlobMatcher(patterns, process.cwd());
+
+matcher.match('src/app.test.js'); // true -- matches `*.test.js`
+matcher.match('src/important.test.js'); // false -- excluded by the negated pattern
+matcher.match('src/app.js'); // false -- does not match any pattern
 ```
-const cspellGlob = require('cspell-glob');
 
-// TODO: DEMONSTRATE API
+By default, `GlobMatcher` runs in `exclude` mode (like `.gitignore`). Use `include` mode when searching for
+files to check, where patterns must be more explicit to match:
+
+```ts
+const matcher = new GlobMatcher(['src/**/*.ts'], { root: process.cwd(), mode: 'include' });
+
+matcher.match('src/app.ts'); // true
+matcher.match('node_modules/lib/index.ts'); // false
 ```
 
 ## CSpell for Enterprise

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "10.3.1-alpha.1",
+  "version": "10.3.1",
   "description": "Glob matcher for cspell",
   "keywords": [
     "cspell",
@@ -58,7 +58,7 @@
     "node": ">=22.18.0"
   },
   "dependencies": {
-    "@cspell/url": "10.3.1-alpha.1",
+    "@cspell/url": "10.3.1",
     "picomatch": "^4.0.7"
   },
   "devDependencies": {
@@ -66,5 +66,5 @@
     "@types/picomatch": "^4.0.3",
     "micromatch": "^4.0.8"
   },
-  "gitHead": "aa0576e5b7e666a7e8645939871bcfe4fa2a7eb5"
+  "gitHead": "793953d1c2b4f1cab257389ff6ecb3ae2dd40230"
 }