@cspell/cspell-types 10.3.5 → 10.4.0-alpha.1

package/dist/Parser/index.d.mts

@@ -1,2 +1,2 @@
-import { _ as TextDocumentFragment, a as ParsedTag, c as Parser, d as Scope, f as ScopeChain, g as TextDocument, h as SourceMap, i as ParseResult, l as ParserName, m as Range, n as DelegateInfo, o as ParsedTags, p as ScopeString, r as DocumentParser, s as ParsedText, t as MappedText, u as ParserOptions } from "../index-KJUXVo8e.mjs";
+import { _ as TextDocumentFragment, a as ParsedTag, c as Parser, d as Scope, f as ScopeChain, g as TextDocument, h as SourceMap, i as ParseResult, l as ParserName, m as Range, n as DelegateInfo, o as ParsedTags, p as ScopeString, r as DocumentParser, s as ParsedText, t as MappedText, u as ParserOptions } from "../index-eOBgsj8d.mjs";
 export type { DelegateInfo, DocumentParser, MappedText, ParseResult, ParsedTag, ParsedTags, ParsedText, Parser, ParserName, ParserOptions, Range, Scope, ScopeChain, ScopeString, SourceMap, TextDocument, TextDocumentFragment };

package/dist/Parser/index.d.ts

@@ -1,2 +1,2 @@
-import { _ as TextDocumentFragment, a as ParsedTag, c as Parser, d as Scope, f as ScopeChain, g as TextDocument, h as SourceMap, i as ParseResult, l as ParserName, m as Range, n as DelegateInfo, o as ParsedTags, p as ScopeString, r as DocumentParser, s as ParsedText, t as MappedText, u as ParserOptions } from "../index-KJUXVo8e.js";
+import { _ as TextDocumentFragment, a as ParsedTag, c as Parser, d as Scope, f as ScopeChain, g as TextDocument, h as SourceMap, i as ParseResult, l as ParserName, m as Range, n as DelegateInfo, o as ParsedTags, p as ScopeString, r as DocumentParser, s as ParsedText, t as MappedText, u as ParserOptions } from "../index-eOBgsj8d.js";
 export type { DelegateInfo, DocumentParser, MappedText, ParseResult, ParsedTag, ParsedTags, ParsedText, Parser, ParserName, ParserOptions, Range, Scope, ScopeChain, ScopeString, SourceMap, TextDocument, TextDocumentFragment };

package/dist/{index-KJUXVo8e.d.mts → index-eOBgsj8d.d.mts}

@@ -51,7 +51,7 @@ type SourceMap = number[];
 type Range = readonly [start: number, end: number];
 /**
  * Interface used to pass documents to the parser.
- * @since 10.4.0
+ * @since 10.5.0
  */
 interface TextDocument {
   /**
@@ -67,7 +67,7 @@ interface TextDocument {
 }
 /**
  * A fragment of a text document, representing a subset of the full document.
- * @since 10.4.0
+ * @since 10.5.0
  */
 interface TextDocumentFragment extends TextDocument {
   /**
@@ -252,4 +252,4 @@ interface TransformedText extends Mapped {
 }
 //#endregion
 export { TextDocumentFragment as _, ParsedTag as a, Parser as c, Scope as d, ScopeChain as f, TextDocument as g, SourceMap as h, ParseResult as i, ParserName as l, Range as m, DelegateInfo as n, ParsedTags as o, ScopeString as p, DocumentParser as r, ParsedText as s, MappedText as t, ParserOptions as u };
-//# sourceMappingURL=index-KJUXVo8e.d.mts.map
+//# sourceMappingURL=index-eOBgsj8d.d.mts.map

package/dist/{index-KJUXVo8e.d.ts → index-eOBgsj8d.d.ts}

@@ -51,7 +51,7 @@ type SourceMap = number[];
 type Range = readonly [start: number, end: number];
 /**
  * Interface used to pass documents to the parser.
- * @since 10.4.0
+ * @since 10.5.0
  */
 interface TextDocument {
   /**
@@ -67,7 +67,7 @@ interface TextDocument {
 }
 /**
  * A fragment of a text document, representing a subset of the full document.
- * @since 10.4.0
+ * @since 10.5.0
  */
 interface TextDocumentFragment extends TextDocument {
   /**
@@ -252,4 +252,4 @@ interface TransformedText extends Mapped {
 }
 //#endregion
 export { TextDocumentFragment as _, ParsedTag as a, Parser as c, Scope as d, ScopeChain as f, TextDocument as g, SourceMap as h, ParseResult as i, ParserName as l, Range as m, DelegateInfo as n, ParsedTags as o, ScopeString as p, DocumentParser as r, ParsedText as s, MappedText as t, ParserOptions as u };
-//# sourceMappingURL=index-KJUXVo8e.d.ts.map
+//# sourceMappingURL=index-eOBgsj8d.d.ts.map

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { _ as TextDocumentFragment, a as ParsedTag, c as Parser, g as TextDocument, h as SourceMap, i as ParseResult, l as ParserName, m as Range, o as ParsedTags, r as DocumentParser, s as ParsedText, t as MappedText, u as ParserOptions } from "./index-KJUXVo8e.mjs";
+import { _ as TextDocumentFragment, a as ParsedTag, c as Parser, g as TextDocument, h as SourceMap, i as ParseResult, l as ParserName, m as Range, o as ParsedTags, r as DocumentParser, s as ParsedText, t as MappedText, u as ParserOptions } from "./index-eOBgsj8d.mjs";
 //#region src/cspell-vfs.d.ts
 /**
  * Binary data for CSpellVFS file.
@@ -244,7 +244,7 @@ interface ProgressFileBegin extends ProgressFileBase {
 }
 type ProgressEmitter = (p: ProgressItem | ProgressFileComplete) => void;
 interface RunResult {
-  /** Number of files processed. */
+  /** Number of files found, including skipped files. */
   files: number;
   /** Set of files where issues were found. */
   filesWithIssues: Set<string>;
@@ -428,7 +428,7 @@ interface CSpellSettingsValidation {
    *
    * @default { "*": true }
    * @experimental
-   * @since 10.4.0
+   * @since 10.5.0
    */
   validate?: ValidationTags;
 }
@@ -447,13 +447,13 @@ interface ValidationTags {
    * The default validation setting for any tag not otherwise matched.
    * @default true
    */
-  "*"?: boolean;
+  "*"?: boolean | undefined;
   /**
    * Validation setting for the specific tag.
    *
    * If not specified, the default (`'*'`) will be used.
    */
-  [tag: TagPattern]: boolean;
+  [tag: TagPattern]: boolean | undefined;
 }
 //#endregion
 //#region src/suggestionCostsDef.d.ts
@@ -1229,7 +1229,7 @@ interface FeatureWithConfiguration {
 //#region src/Plugin/index.d.ts
 type CreateParser<Options = unknown> = (name: string, options?: Options) => Promise<DocumentParser | undefined> | DocumentParser | undefined;
 /**
- * @since 10.4.0
+ * @since 10.5.0
  */
 interface AvailableParsers<Options> {
   /**
@@ -1239,7 +1239,7 @@ interface AvailableParsers<Options> {
   [name: string]: DocumentParser | Parser | CreateParser<Options>;
 }
 /**
- * @since 10.4.0
+ * @since 10.5.0
  */
 type Parsers = (DocumentParser | Parser)[];
 /**

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { _ as TextDocumentFragment, a as ParsedTag, c as Parser, g as TextDocument, h as SourceMap, i as ParseResult, l as ParserName, m as Range, o as ParsedTags, r as DocumentParser, s as ParsedText, t as MappedText, u as ParserOptions } from "./index-KJUXVo8e.js";
+import { _ as TextDocumentFragment, a as ParsedTag, c as Parser, g as TextDocument, h as SourceMap, i as ParseResult, l as ParserName, m as Range, o as ParsedTags, r as DocumentParser, s as ParsedText, t as MappedText, u as ParserOptions } from "./index-eOBgsj8d.js";
 //#region src/cspell-vfs.d.ts
 /**
  * Binary data for CSpellVFS file.
@@ -244,7 +244,7 @@ interface ProgressFileBegin extends ProgressFileBase {
 }
 type ProgressEmitter = (p: ProgressItem | ProgressFileComplete) => void;
 interface RunResult {
-  /** Number of files processed. */
+  /** Number of files found, including skipped files. */
   files: number;
   /** Set of files where issues were found. */
   filesWithIssues: Set<string>;
@@ -428,7 +428,7 @@ interface CSpellSettingsValidation {
    *
    * @default { "*": true }
    * @experimental
-   * @since 10.4.0
+   * @since 10.5.0
    */
   validate?: ValidationTags;
 }
@@ -447,13 +447,13 @@ interface ValidationTags {
    * The default validation setting for any tag not otherwise matched.
    * @default true
    */
-  "*"?: boolean;
+  "*"?: boolean | undefined;
   /**
    * Validation setting for the specific tag.
    *
    * If not specified, the default (`'*'`) will be used.
    */
-  [tag: TagPattern]: boolean;
+  [tag: TagPattern]: boolean | undefined;
 }
 //#endregion
 //#region src/suggestionCostsDef.d.ts
@@ -1229,7 +1229,7 @@ interface FeatureWithConfiguration {
 //#region src/Plugin/index.d.ts
 type CreateParser<Options = unknown> = (name: string, options?: Options) => Promise<DocumentParser | undefined> | DocumentParser | undefined;
 /**
- * @since 10.4.0
+ * @since 10.5.0
  */
 interface AvailableParsers<Options> {
   /**
@@ -1239,7 +1239,7 @@ interface AvailableParsers<Options> {
   [name: string]: DocumentParser | Parser | CreateParser<Options>;
 }
 /**
- * @since 10.4.0
+ * @since 10.5.0
  */
 type Parsers = (DocumentParser | Parser)[];
 /**

package/package.json

@@ -1,15 +1,28 @@
 {
   "name": "@cspell/cspell-types",
+  "version": "10.4.0-alpha.1",
+  "description": "Types for cspell and cspell-lib",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
-  "version": "10.3.5",
-  "description": "Types for cspell and cspell-lib",
-  "type": "commonjs",
+  "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-types#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/streetsidesoftware/cspell.git",
+    "directory": "packages/cspell-types"
+  },
+  "bugs": {
+    "url": "https://github.com/streetsidesoftware/cspell/issues?q=is%3Aissue%20state%3Aopen%20label%3Acspell-types"
+  },
+  "keywords": [
+    "cspell",
+    "types"
+  ],
+  "license": "MIT",
+  "author": "Jason Dent",
   "sideEffects": false,
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
+  "type": "commonjs",
   "exports": {
     ".": {
       "import": "./dist/index.mjs",
@@ -24,6 +37,8 @@
       "require": "./cspell.schema.json"
     }
   },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "typesVersions": {
     "*": {
@@ -48,21 +63,6 @@
       ]
     }
   },
-  "scripts": {
-    "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
-    "build": "pnpm build:tsc && pnpm build:tsdown && pnpm run build-schema",
-    "build:tsc": "tsc -p tsconfig.json",
-    "build:tsdown": "tsdown",
-    "build-schema": "pnpm build-cspell-schema",
-    "clean-build": "pnpm run clean && pnpm run build",
-    "coverage": "vitest run --coverage",
-    "test": "vitest run"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/streetsidesoftware/cspell.git",
-    "directory": "packages/cspell-types"
-  },
   "files": [
     "dist",
     "ajv.config.js",
@@ -75,15 +75,18 @@
     "!**/*.spec.*",
     "!**/*.map"
   ],
-  "keywords": [
-    "cspell",
-    "types"
-  ],
-  "author": "Jason Dent",
-  "license": "MIT",
+  "scripts": {
+    "build": "pnpm build:tsc && pnpm build:tsdown && pnpm run build-schema",
+    "build:tsc": "tsc -p tsconfig.json",
+    "build:tsdown": "tsdown",
+    "build-schema": "pnpm build-cspell-schema",
+    "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
+    "clean-build": "pnpm run clean && pnpm run build",
+    "coverage": "vitest run --coverage",
+    "test": "vitest run"
+  },
   "engines": {
     "node": ">=22.18.0"
   },
-  "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-types#readme",
-  "gitHead": "f37a244a54b686fc1ac11272d6019b9a059b062a"
+  "gitHead": "628768a6e62b792e628189b41e63e12e5d3d8fe3"
 }