@cspell/cspell-types 6.19.2 → 6.20.1

package/dist/{CSpellReporter.d.ts → cjs/CSpellReporter.d.ts}

@@ -1,4 +1,4 @@
-import type { TextDocumentOffset, TextOffset } from './TextOffset';
+import type { TextDocumentOffset, TextOffset } from './TextOffset.js';
 export interface Suggestion {
     /**
      * Word to suggest.

package/dist/{CSpellSettingsDef.d.ts → cjs/CSpellSettingsDef.d.ts}

@@ -1,7 +1,7 @@
-import type { DictionaryDefinition, DictionaryReference } from './DictionaryDefinition';
-import type { Features } from './features';
-import type { Parser, ParserName } from './Parser';
-import type { Serializable } from './types';
+import type { DictionaryDefinition, DictionaryReference } from './DictionaryDefinition.js';
+import type { Features } from './features.js';
+import type { Parser, ParserName } from './Parser/index.js';
+import type { Serializable } from './types.js';
 /**
  * These settings come from user and workspace settings.
  */

package/dist/{DictionaryDefinition.d.ts → cjs/DictionaryDefinition.d.ts}

@@ -1,4 +1,4 @@
-import type { DictionaryInformation } from './DictionaryInformation';
+import type { DictionaryInformation } from './DictionaryInformation.js';
 export type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAugmented | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
 export type DictionaryFileTypes = 'S' | 'W' | 'C' | 'T';
 export interface DictionaryDefinitionBase {

package/dist/{DictionaryInformation.d.ts → cjs/DictionaryInformation.d.ts}

@@ -1,4 +1,4 @@
-import type { SuggestionCostsDefs } from './suggestionCostsDef';
+import type { SuggestionCostsDefs } from './suggestionCostsDef.js';
 /**
  * Use by dictionary authors to help improve the quality of suggestions
  * given from the dictionary.

package/dist/cjs/Parser/CSpellReporter.d.ts

@@ -0,0 +1,103 @@
+import type { TextDocumentOffset, TextOffset } from './TextOffset.js';
+export interface Suggestion {
+    /**
+     * Word to suggest.
+     */
+    word: 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 CSpellReporterModule {
+    getReporter: (settings: unknown) => CSpellReporter;
+}
+//# sourceMappingURL=CSpellReporter.d.ts.map