@cspell/cspell-types 7.0.2 → 7.2.0

package/dist/Parser/index.d.mts

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

package/dist/Parser/index.mjs

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

package/dist/index.d.mts

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

package/dist/index.mjs

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

package/package.json

@@ -3,19 +3,19 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "7.0.2",
+  "version": "7.2.0",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.mjs",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
   "exports": {
     ".": {
-      "import": "./dist/esm/index.mjs",
-      "require": "./dist/cjs/index.js"
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
     },
     "./Parser": {
-      "import": "./dist/esm/Parser/index.mjs",
-      "require": "./dist/cjs/Parser/index.js"
+      "import": "./dist/Parser/index.mjs",
+      "require": "./dist/Parser/index.js"
     },
     "./cspell.schema.json": {
       "import": "./cspell.schema.json",
@@ -28,28 +28,31 @@
   "types": "index.d.ts",
   "typesVersions": {
     "*": {
+      "*.d.ts": [
+        "dist/*.d.ts"
+      ],
       "*.d.mts": [
-        "dist/esm/*.d.mts"
+        "dist/*.d.mts"
       ],
       "index.d.ts": [
-        "dist/cjs/index.d.ts"
+        "dist/index.d.ts"
       ],
-      "dist/esm/index.d.ts": [
-        "dist/esm/index.d.ts"
+      "dist/index.d.ts": [
+        "dist/index.d.ts"
       ],
       "Parser": [
-        "dist/cjs/Parser/index.d.ts"
+        "dist/Parser/index.d.ts"
       ],
       "*": [
-        "dist/cjs/*.d.ts",
-        "dist/cjs/*/index.d.ts"
+        "dist/*.d.ts",
+        "dist/*/index.d.ts"
       ]
     }
   },
   "scripts": {
     "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
     "build": "pnpm build:tsc && pnpm run build-schema",
-    "build:tsc": "tsc -b tsconfig.json && ts2mjs  dist/esm",
+    "build:tsc": "tsc -b tsconfig.json",
     "build-schema": "ts-json-schema-generator --no-top-ref --path src/CSpellSettingsDef.ts --type CSpellSettings --validation-keywords markdownDescription  --validation-keywords scope --validation-keywords deprecated --validation-keywords deprecationMessage -o  ./cspell.schema.json && shx cp ./cspell.schema.json ../..",
     "clean-build": "pnpm run clean && pnpm run build",
     "coverage": "vitest run --coverage",
@@ -87,5 +90,5 @@
     "ajv-cli": "^5.0.0",
     "ts-json-schema-generator": "^1.3.0"
   },
-  "gitHead": "25aa083421fc81e4d5b7cedb4755f9b327120cfc"
+  "gitHead": "b08f7ddc3a4aa22cc80c69ca6638b2a943659a31"
 }

package/dist/esm/CSpellReporter.d.mts

@@ -1,152 +0,0 @@
-import type { TextDocumentOffset, TextOffset } from './TextOffset.mjs';
-export interface Suggestion {
-    /**
-     * Word to suggest.
-     */
-    word: string;
-    /**
-     * The suggested word adjusted to match the original case.
-     */
-    wordAdjustedToMatchCase?: string;
-    /**
-     * `true` - if this suggestion can be an automatic fix.
-     */
-    isPreferred?: boolean;
-}
-export interface Issue extends Omit<TextDocumentOffset, 'doc'> {
-    /** text surrounding the issue text */
-    context: TextOffset;
-    /**
-     * true if the issue has been flagged as a forbidden word.
-     */
-    isFlagged?: boolean;
-    /**
-     * An optional array of replacement strings.
-     */
-    suggestions?: string[];
-    /**
-     * An optional array of suggestions.
-     */
-    suggestionsEx?: Suggestion[];
-    /**
-     * Issues are spelling issues unless otherwise specified.
-     */
-    issueType?: IssueType;
-    /**
-     * Optional message to show.
-     */
-    message?: string;
-}
-export declare enum IssueType {
-    spelling = 0,
-    directive = 1
-}
-export type MessageType = 'Debug' | 'Info' | 'Warning';
-export type MessageTypeLookup = {
-    [key in MessageType]: key;
-};
-export declare const MessageTypes: MessageTypeLookup;
-export type MessageEmitter = (message: string, msgType: MessageType) => void;
-export type DebugEmitter = (message: string) => void;
-export type ErrorLike = Error | {
-    message: string;
-    name: string;
-    toString: () => string;
-};
-export type ErrorEmitter = (message: string, error: ErrorLike) => void;
-export type SpellingErrorEmitter = (issue: Issue) => void;
-export type ProgressTypes = 'ProgressFileBegin' | 'ProgressFileComplete';
-export type ProgressItem = ProgressFileBegin | ProgressFileComplete;
-export interface ProgressBase {
-    type: ProgressTypes;
-}
-export interface ProgressFileBase extends ProgressBase {
-    type: ProgressTypes;
-    fileNum: number;
-    fileCount: number;
-    filename: string;
-}
-export interface ProgressFileComplete extends ProgressFileBase {
-    type: 'ProgressFileComplete';
-    elapsedTimeMs: number | undefined;
-    processed: boolean | undefined;
-    numErrors: number | undefined;
-    cached?: boolean;
-}
-/**
- * Notification sent just before processing a file.
- */
-export interface ProgressFileBegin extends ProgressFileBase {
-    type: 'ProgressFileBegin';
-}
-export type ProgressEmitter = (p: ProgressItem | ProgressFileComplete) => void;
-export interface RunResult {
-    /** Number of files processed. */
-    files: number;
-    /** Set of files where issues were found. */
-    filesWithIssues: Set<string>;
-    /** Number of issues found. */
-    issues: number;
-    /** Number of processing errors. */
-    errors: number;
-    /** Number files that used results from the cache. */
-    cachedFiles?: number;
-}
-export type ResultEmitter = (result: RunResult) => void | Promise<void>;
-export interface CSpellReporter {
-    issue?: SpellingErrorEmitter;
-    info?: MessageEmitter;
-    debug?: DebugEmitter;
-    error?: ErrorEmitter;
-    progress?: ProgressEmitter;
-    result?: ResultEmitter;
-}
-export interface ReporterConfigurationBase {
-    /**
-     * The maximum number of problems to report in a file.
-     *
-     * @default 10000
-     */
-    maxNumberOfProblems?: number;
-    /**
-     * The maximum number of times the same word can be flagged as an error in a file.
-     *
-     * @default 5
-     */
-    maxDuplicateProblems?: number;
-    /**
-     * The minimum length of a word before checking it against a dictionary.
-     *
-     * @default 4
-     */
-    minWordLength?: number;
-}
-interface ReporterCommandLineOptions {
-    /**
-     * Display verbose information
-     */
-    verbose?: boolean;
-    /**
-     * Show extensive output.
-     */
-    debug?: boolean;
-    /**
-     * Only report the words, no line numbers or file names.
-     */
-    wordsOnly?: boolean;
-    /**
-     * unique errors per file only.
-     */
-    unique?: boolean;
-    /**
-     * root directory, defaults to `cwd`
-     */
-    root?: string;
-}
-export interface ReporterConfiguration extends ReporterCommandLineOptions, ReporterConfigurationBase {
-}
-export interface CSpellReporterModule {
-    getReporter: (settings: unknown, config: ReporterConfiguration) => CSpellReporter;
-}
-export {};
-//# sourceMappingURL=CSpellReporter.d.mts.map

package/dist/esm/CSpellReporter.d.ts

@@ -1,152 +0,0 @@
-import type { TextDocumentOffset, TextOffset } from './TextOffset.js';
-export interface Suggestion {
-    /**
-     * Word to suggest.
-     */
-    word: string;
-    /**
-     * The suggested word adjusted to match the original case.
-     */
-    wordAdjustedToMatchCase?: string;
-    /**
-     * `true` - if this suggestion can be an automatic fix.
-     */
-    isPreferred?: boolean;
-}
-export interface Issue extends Omit<TextDocumentOffset, 'doc'> {
-    /** text surrounding the issue text */
-    context: TextOffset;
-    /**
-     * true if the issue has been flagged as a forbidden word.
-     */
-    isFlagged?: boolean;
-    /**
-     * An optional array of replacement strings.
-     */
-    suggestions?: string[];
-    /**
-     * An optional array of suggestions.
-     */
-    suggestionsEx?: Suggestion[];
-    /**
-     * Issues are spelling issues unless otherwise specified.
-     */
-    issueType?: IssueType;
-    /**
-     * Optional message to show.
-     */
-    message?: string;
-}
-export declare enum IssueType {
-    spelling = 0,
-    directive = 1
-}
-export type MessageType = 'Debug' | 'Info' | 'Warning';
-export type MessageTypeLookup = {
-    [key in MessageType]: key;
-};
-export declare const MessageTypes: MessageTypeLookup;
-export type MessageEmitter = (message: string, msgType: MessageType) => void;
-export type DebugEmitter = (message: string) => void;
-export type ErrorLike = Error | {
-    message: string;
-    name: string;
-    toString: () => string;
-};
-export type ErrorEmitter = (message: string, error: ErrorLike) => void;
-export type SpellingErrorEmitter = (issue: Issue) => void;
-export type ProgressTypes = 'ProgressFileBegin' | 'ProgressFileComplete';
-export type ProgressItem = ProgressFileBegin | ProgressFileComplete;
-export interface ProgressBase {
-    type: ProgressTypes;
-}
-export interface ProgressFileBase extends ProgressBase {
-    type: ProgressTypes;
-    fileNum: number;
-    fileCount: number;
-    filename: string;
-}
-export interface ProgressFileComplete extends ProgressFileBase {
-    type: 'ProgressFileComplete';
-    elapsedTimeMs: number | undefined;
-    processed: boolean | undefined;
-    numErrors: number | undefined;
-    cached?: boolean;
-}
-/**
- * Notification sent just before processing a file.
- */
-export interface ProgressFileBegin extends ProgressFileBase {
-    type: 'ProgressFileBegin';
-}
-export type ProgressEmitter = (p: ProgressItem | ProgressFileComplete) => void;
-export interface RunResult {
-    /** Number of files processed. */
-    files: number;
-    /** Set of files where issues were found. */
-    filesWithIssues: Set<string>;
-    /** Number of issues found. */
-    issues: number;
-    /** Number of processing errors. */
-    errors: number;
-    /** Number files that used results from the cache. */
-    cachedFiles?: number;
-}
-export type ResultEmitter = (result: RunResult) => void | Promise<void>;
-export interface CSpellReporter {
-    issue?: SpellingErrorEmitter;
-    info?: MessageEmitter;
-    debug?: DebugEmitter;
-    error?: ErrorEmitter;
-    progress?: ProgressEmitter;
-    result?: ResultEmitter;
-}
-export interface ReporterConfigurationBase {
-    /**
-     * The maximum number of problems to report in a file.
-     *
-     * @default 10000
-     */
-    maxNumberOfProblems?: number;
-    /**
-     * The maximum number of times the same word can be flagged as an error in a file.
-     *
-     * @default 5
-     */
-    maxDuplicateProblems?: number;
-    /**
-     * The minimum length of a word before checking it against a dictionary.
-     *
-     * @default 4
-     */
-    minWordLength?: number;
-}
-interface ReporterCommandLineOptions {
-    /**
-     * Display verbose information
-     */
-    verbose?: boolean;
-    /**
-     * Show extensive output.
-     */
-    debug?: boolean;
-    /**
-     * Only report the words, no line numbers or file names.
-     */
-    wordsOnly?: boolean;
-    /**
-     * unique errors per file only.
-     */
-    unique?: boolean;
-    /**
-     * root directory, defaults to `cwd`
-     */
-    root?: string;
-}
-export interface ReporterConfiguration extends ReporterCommandLineOptions, ReporterConfigurationBase {
-}
-export interface CSpellReporterModule {
-    getReporter: (settings: unknown, config: ReporterConfiguration) => CSpellReporter;
-}
-export {};
-//# sourceMappingURL=CSpellReporter.d.ts.map

package/dist/esm/CSpellReporter.js

@@ -1,10 +0,0 @@
-export var IssueType;
-(function (IssueType) {
-    IssueType[IssueType["spelling"] = 0] = "spelling";
-    IssueType[IssueType["directive"] = 1] = "directive";
-})(IssueType || (IssueType = {}));
-export const MessageTypes = {
-    Debug: 'Debug',
-    Info: 'Info',
-    Warning: 'Warning',
-};

package/dist/esm/CSpellReporter.mjs

@@ -1,10 +0,0 @@
-export var IssueType;
-(function (IssueType) {
-    IssueType[IssueType["spelling"] = 0] = "spelling";
-    IssueType[IssueType["directive"] = 1] = "directive";
-})(IssueType || (IssueType = {}));
-export const MessageTypes = {
-    Debug: 'Debug',
-    Info: 'Info',
-    Warning: 'Warning',
-};