@cspell/cspell-types 8.17.1 → 8.17.3

package/dist/Parser/index.d.mts

@@ -1,2 +1,127 @@
-export * from './index.js';
-//# sourceMappingURL=index.d.mts.map
+type ParserOptions = Record<string, unknown>;
+type ParserName = string;
+interface Parser {
+    /** Name of parser */
+    readonly name: ParserName;
+    /**
+     * Parse Method
+     * @param content - full content of the file
+     * @param filename - filename
+     */
+    parse(content: string, filename: string): ParseResult;
+}
+interface ParseResult {
+    readonly content: string;
+    readonly filename: string;
+    readonly parsedTexts: Iterable<ParsedText>;
+}
+interface ParsedText {
+    /**
+     * The text extracted and possibly transformed
+     */
+    readonly text: string;
+    /**
+     * The raw text before it has been transformed
+     */
+    readonly rawText?: string | undefined;
+    /**
+     * start and end offsets of the text
+     */
+    readonly 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.
+     */
+    readonly scope?: Scope | undefined;
+    /**
+     * The source map is used to support text transformations.
+     *
+     * See: {@link SourceMap}
+     */
+    readonly map?: SourceMap | undefined;
+    /**
+     * Used to delegate parsing the contents of `text` to another parser.
+     *
+     */
+    readonly 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 --->
+ */
+type SourceMap = number[];
+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.
+ */
+interface DelegateInfo {
+    /**
+     * Proposed virtual file name including the extension.
+     * Format: `./${source_filename}/${block_number}.${ext}
+     * Example: `./README.md/1.js`
+     */
+    readonly filename: string;
+    /**
+     * The filename of the origin of the virtual file block.
+     * Example: `./README.md`
+     */
+    readonly originFilename: string;
+    /**
+     * Proposed file extension
+     * Example: `.js`
+     */
+    readonly extension: string;
+    /**
+     * Filetype to use
+     * Example: `javascript`
+     */
+    readonly fileType?: string;
+}
+/**
+ * Scope - chain of scope going from local to global
+ *
+ * Example:
+ * ```
+ * `comment.block.documentation.ts` -> `meta.interface.ts` -> `source.ts`
+ * ```
+ */
+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`
+ */
+type ScopeString = string;
+type Scope = ScopeChain | ScopeString;
+
+export type { DelegateInfo, ParseResult, ParsedText, Parser, ParserName, ParserOptions, Range, Scope, ScopeChain, ScopeString, SourceMap };

package/dist/Parser/index.d.ts

@@ -1,6 +1,6 @@
-export type ParserOptions = Record<string, unknown>;
-export type ParserName = string;
-export interface Parser {
+type ParserOptions = Record<string, unknown>;
+type ParserName = string;
+interface Parser {
     /** Name of parser */
     readonly name: ParserName;
     /**
@@ -10,12 +10,12 @@ export interface Parser {
      */
     parse(content: string, filename: string): ParseResult;
 }
-export interface ParseResult {
+interface ParseResult {
     readonly content: string;
     readonly filename: string;
     readonly parsedTexts: Iterable<ParsedText>;
 }
-export interface ParsedText {
+interface ParsedText {
     /**
      * The text extracted and possibly transformed
      */
@@ -74,14 +74,14 @@ export interface ParsedText {
  *
  * <!--- cspell:ignore Bjørvika rvika --->
  */
-export type SourceMap = number[];
-export type Range = readonly [start: number, end: number];
+type SourceMap = number[];
+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 {
+interface DelegateInfo {
     /**
      * Proposed virtual file name including the extension.
      * Format: `./${source_filename}/${block_number}.${ext}
@@ -112,7 +112,7 @@ export interface DelegateInfo {
  * `comment.block.documentation.ts` -> `meta.interface.ts` -> `source.ts`
  * ```
  */
-export interface ScopeChain {
+interface ScopeChain {
     readonly value: string;
     readonly parent?: ScopeChain | undefined;
 }
@@ -121,6 +121,7 @@ export interface ScopeChain {
  *
  * Example: `comment.block.documentation.ts meta.interface.ts source.ts`
  */
-export type ScopeString = string;
-export type Scope = ScopeChain | ScopeString;
-//# sourceMappingURL=index.d.ts.map
+type ScopeString = string;
+type Scope = ScopeChain | ScopeString;
+
+export type { DelegateInfo, ParseResult, ParsedText, Parser, ParserName, ParserOptions, Range, Scope, ScopeChain, ScopeString, SourceMap };

package/dist/Parser/index.js

@@ -1,3 +1,18 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=index.js.map
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/Parser/index.ts
+var Parser_exports = {};
+module.exports = __toCommonJS(Parser_exports);

package/dist/Parser/index.mjs

@@ -1,2 +0,0 @@
-export * from './index.js';
-//# sourceMappingURL=index.mjs.map