@cspell/cspell-types 6.1.0 → 6.1.3-alpha.0

package/cspell.schema.json

@@ -159,9 +159,8 @@
       "type": "object"
     },
     "CustomDictionaryPath": {
-      "description": "A File System Path to a dictionary file.",
-      "pattern": "^.*\\.txt$",
-      "type": "string"
+      "$ref": "#/definitions/FsPath",
+      "description": "A File System Path to a dictionary file."
     },
     "CustomDictionaryScope": {
       "description": "Specifies the scope of a dictionary.",

package/dist/CSpellSettingsDef.d.ts

@@ -1,5 +1,6 @@
 import type { DictionaryInformation } from './DictionaryInformation';
 import type { Features } from './features';
+import { Parser, ParserName } from './Parser';
 export declare type ReplaceEntry = [string, string];
 export declare type ReplaceMap = ReplaceEntry[];
 /**
@@ -24,7 +25,7 @@ export interface CSpellSettingsWithSourceTrace extends CSpellSettings {
     __importRef?: ImportFileRef;
     __imports?: Map<string, ImportFileRef>;
 }
-export interface FileSettings extends ExtendableSettings, CommandLineSettings {
+export interface FileSettings extends ExtendableSettings, CommandLineSettings, ExperimentalFileSettings {
     /**
      * Configuration format version of the settings file.
      *
@@ -347,7 +348,7 @@ export interface OverrideFilterFields {
     /** Glob pattern or patterns to match against. */
     filename: Glob | Glob[];
 }
-export interface BaseSetting {
+export interface BaseSetting extends ExperimentalBaseSettings {
     /** Optional identifier. */
     id?: string;
     /** Optional name of configuration. */
@@ -739,9 +740,8 @@ export declare type TrustLevel = 'trusted' | 'untrusted';
 export declare type DictionaryPath = string;
 /**
  * A File System Path to a dictionary file.
- * @pattern ^.*\.txt$
  */
-export declare type CustomDictionaryPath = string;
+export declare type CustomDictionaryPath = FsPath;
 export interface RegExpPatternDefinition {
     /**
      * Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList.
@@ -803,5 +803,43 @@ interface BaseSource {
  * Reporter name or reporter name + reporter config.
  */
 export declare type ReporterSettings = string | [string] | [string, unknown];
+/**
+ * Experimental Configuration / Options
+ *
+ * This Configuration is subject to change without warning.
+ * @experimental
+ * @hidden
+ */
+export interface ExperimentalFileSettings {
+    /**
+     * Future Plugin support
+     * @experimental
+     * @version 6.2.0
+     */
+    plugins?: Plugin[] | undefined;
+}
+/**
+ * Experimental Configuration / Options
+ *
+ * This Configuration is subject to change without warning.
+ * @experimental
+ * @hidden
+ */
+export interface ExperimentalBaseSettings {
+    /**
+     * Parser to use for the file content
+     * @experimental
+     * @version 6.2.0
+     */
+    parser?: ParserName | Parser | undefined;
+}
+/**
+ * Plugin API
+ * @experimental
+ * @version 6.2.0
+ */
+export interface Plugin {
+    parsers?: Parser[] | undefined;
+}
 export {};
 //# sourceMappingURL=CSpellSettingsDef.d.ts.map

package/dist/Parser.d.ts

@@ -0,0 +1,122 @@
+export declare type ParserOptions = Record<string, unknown>;
+export declare type ParserName = string;
+export interface Parser {
+    /** Name of parser */
+    name: ParserName;
+    /**
+     * Parse Method
+     * @param content - full content of the file
+     * @param filename - filename
+     */
+    parse(content: string, filename: string): ParseResult;
+}
+export interface ParseResult {
+    content: string;
+    filename: string;
+    parsedTexts: Iterable<ParsedText>;
+}
+export interface ParsedText {
+    /**
+     * The text extracted and possibly transformed
+     */
+    text: string;
+    /**
+     * start and end offsets of the text
+     */
+    range: Range;
+    /**
+     * The Scope annotation for a segment of text.
+     * Used by the spell checker to apply spell checking options
+     * based upon the value of the scope.
+     */
+    scope?: Scope | undefined;
+    /**
+     * The source map is used to support text transformations.
+     *
+     * See: {@link SourceMap}
+     */
+    map?: SourceMap | undefined;
+    /**
+     * Used to delegate parsing the contents of `text` to another parser.
+     *
+     */
+    delegate?: DelegateInfo | undefined;
+}
+/**
+ * A SourceMap is used to map transform a piece of text back to its original text.
+ * This is necessary in order to report the correct location of a spelling issue.
+ * An empty source map indicates that it was a 1:1 transformation.
+ *
+ * The values in a source map are number pairs (even, odd) relative to the beginning of each
+ * string segment.
+ * - even - offset in the source text
+ * - odd - offset in the transformed text
+ *
+ * Offsets start a 0
+ *
+ * Example:
+ *
+ * - Original text: `Grand Caf\u00e9 Bj\u00f8rvika`
+ * - Transformed text: `Grand Café Bjørvika`
+ * - Map: [9, 9, 15, 10, 18, 13, 24, 14]
+ *
+ * | offset | original    | offset | transformed |
+ * | ------ | ----------- | ------ | ----------- |
+ * | 0-9    | `Grand Caf` | 0-9    | `Grand Caf` |
+ * | 9-15   | `\u00e9`    | 9-10   | `é`         |
+ * | 15-18  | ` Bj`       | 10-13  | ` Bj`       |
+ * | 18-24  | `\u00f8`    | 13-14  | `ø`         |
+ * | 24-29  | `rvika`     | 14-19  | `rvika`     |
+ *
+ * <!--- cspell:ignore Bjørvika rvika --->
+ */
+export declare type SourceMap = number[];
+export declare type Range = readonly [start: number, end: number];
+/**
+ * DelegateInfo is used by a parser to delegate parsing a subsection of a document to
+ * another parser. The following information is used by the spell checker to match
+ * the parser.
+ */
+export interface DelegateInfo {
+    /**
+     * Proposed virtual file name including the extension.
+     * Format: `./${source_filename}/${block_number}.${ext}
+     * Example: `./README.md/1.js`
+     */
+    filename: string;
+    /**
+     * The filename of the origin of the virtual file block.
+     * Example: `./README.md`
+     */
+    originFilename: string;
+    /**
+     * Proposed file extension
+     * Example: `.js`
+     */
+    extension: string;
+    /**
+     * Filetype to use
+     * Example: `javascript`
+     */
+    fileType: string;
+}
+/**
+ * Scope - chain of scope going from local to global
+ *
+ * Example:
+ * ```
+ * `comment.block.documentation.ts` -> `meta.interface.ts` -> `source.ts`
+ * ```
+ */
+export interface ScopeChain {
+    readonly value: string;
+    readonly parent?: ScopeChain | undefined;
+}
+/**
+ * A string representing a scope chain separated by spaces
+ *
+ * Example: `comment.block.documentation.ts meta.interface.ts source.ts`
+ */
+export declare type ScopeString = string;
+export declare type Scope = ScopeChain | ScopeString;
+//# sourceMappingURL=Parser.d.ts.map

package/dist/Parser.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Parser.js.map

package/dist/configFields.js

@@ -47,6 +47,9 @@ exports.ConfigFields = {
     usePnP: 'usePnP',
     userWords: 'userWords',
     words: 'words',
+    // Experimental
+    parser: 'parser',
+    plugins: 'plugins',
 };
 // export const ConfigKeysNames = Object.values(ConfigKeysByField);
 //# sourceMappingURL=configFields.js.map

package/dist/index.d.ts

@@ -6,4 +6,5 @@ export type { CharacterSet, CharacterSetCosts, DictionaryInformation, EditCosts
 export type { Feature, Features } from './features';
 export type { SuggestionCostMapDef, SuggestionCostsDefs } from './suggestionCostsDef';
 export type { TextDocumentOffset, TextOffset } from './TextOffset';
+export type { ParseResult, ParsedText, Parser, ParserName, ParserOptions } from './Parser';
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -3,12 +3,28 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "6.1.0",
+  "version": "6.1.3-alpha.0",
   "description": "Types for cspell and cspell-lib",
+  "type": "commonjs",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "dist/*"
+      ],
+      "dist/index.d.ts": [
+        "dist/index.d.ts"
+      ],
+      "index.d.ts": [
+        "dist/index.d.ts"
+      ]
+    }
+  },
   "exports": {
     ".": "./dist/index.js",
+    "./Parser": "./dist/Parser.js",
+    "./Parser.js": "./dist/Parser.js",
     "./cspell.schema.json": "./cspell.schema.json",
     "./ajv.config": "./ajv.config.js",
     "./ajv.config.js": "./ajv.config.js"
@@ -48,10 +64,10 @@
   },
   "devDependencies": {
     "ajv-cli": "^5.0.0",
-    "jest": "^28.1.0",
+    "jest": "^28.1.1",
     "rimraf": "^3.0.2",
     "ts-json-schema-generator": "^1.0.0",
-    "typescript": "^4.7.2"
+    "typescript": "^4.7.3"
   },
-  "gitHead": "eaf6991ced2c8eb2c60bd2914095e4c686a4266b"
+  "gitHead": "b3cde7e463fd8a6f2c03f990adc70b913239baeb"
 }