@cspell/cspell-types 8.17.0 → 8.17.2

package/dist/index.js

@@ -1,13 +1,116 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defineConfig = exports.defaultCSpellSettings = exports.MessageTypes = exports.IssueType = exports.ConfigFields = void 0;
-var configFields_js_1 = require("./configFields.js");
-Object.defineProperty(exports, "ConfigFields", { enumerable: true, get: function () { return configFields_js_1.ConfigFields; } });
-var CSpellReporter_js_1 = require("./CSpellReporter.js");
-Object.defineProperty(exports, "IssueType", { enumerable: true, get: function () { return CSpellReporter_js_1.IssueType; } });
-Object.defineProperty(exports, "MessageTypes", { enumerable: true, get: function () { return CSpellReporter_js_1.MessageTypes; } });
-var defaultConfigSettings_js_1 = require("./defaultConfigSettings.js");
-Object.defineProperty(exports, "defaultCSpellSettings", { enumerable: true, get: function () { return defaultConfigSettings_js_1.defaultCSpellSettings; } });
-var defineConfig_js_1 = require("./defineConfig.js");
-Object.defineProperty(exports, "defineConfig", { enumerable: true, get: function () { return defineConfig_js_1.defineConfig; } });
-//# sourceMappingURL=index.js.map
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+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/index.ts
+var index_exports = {};
+__export(index_exports, {
+  ConfigFields: () => ConfigFields,
+  IssueType: () => IssueType,
+  MessageTypes: () => MessageTypes,
+  defaultCSpellSettings: () => defaultCSpellSettings,
+  defineConfig: () => defineConfig
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/configFields.ts
+var ConfigFields = {
+  allowCompoundWords: "allowCompoundWords",
+  cache: "cache",
+  caseSensitive: "caseSensitive",
+  description: "description",
+  dictionaries: "dictionaries",
+  dictionaryDefinitions: "dictionaryDefinitions",
+  enabled: "enabled",
+  enabledLanguageIds: "enabledLanguageIds",
+  enableFiletypes: "enableFiletypes",
+  enabledFileTypes: "enabledFileTypes",
+  enableGlobDot: "enableGlobDot",
+  failFast: "failFast",
+  features: "features",
+  files: "files",
+  flagWords: "flagWords",
+  gitignoreRoot: "gitignoreRoot",
+  globRoot: "globRoot",
+  ignorePaths: "ignorePaths",
+  ignoreRegExpList: "ignoreRegExpList",
+  ignoreWords: "ignoreWords",
+  ignoreRandomStrings: "ignoreRandomStrings",
+  import: "import",
+  includeRegExpList: "includeRegExpList",
+  language: "language",
+  languageId: "languageId",
+  languageSettings: "languageSettings",
+  loadDefaultConfiguration: "loadDefaultConfiguration",
+  maxDuplicateProblems: "maxDuplicateProblems",
+  maxNumberOfProblems: "maxNumberOfProblems",
+  minWordLength: "minWordLength",
+  minRandomLength: "minRandomLength",
+  name: "name",
+  noConfigSearch: "noConfigSearch",
+  noSuggestDictionaries: "noSuggestDictionaries",
+  numSuggestions: "numSuggestions",
+  overrides: "overrides",
+  patterns: "patterns",
+  pnpFiles: "pnpFiles",
+  readonly: "readonly",
+  reporters: "reporters",
+  showStatus: "showStatus",
+  spellCheckDelayMs: "spellCheckDelayMs",
+  suggestionNumChanges: "suggestionNumChanges",
+  suggestionsTimeout: "suggestionsTimeout",
+  suggestWords: "suggestWords",
+  useGitignore: "useGitignore",
+  usePnP: "usePnP",
+  userWords: "userWords",
+  validateDirectives: "validateDirectives",
+  words: "words",
+  // Experimental
+  parser: "parser"
+};
+
+// src/CSpellReporter.ts
+var IssueType = /* @__PURE__ */ ((IssueType2) => {
+  IssueType2[IssueType2["spelling"] = 0] = "spelling";
+  IssueType2[IssueType2["directive"] = 1] = "directive";
+  return IssueType2;
+})(IssueType || {});
+var MessageTypes = {
+  Debug: "Debug",
+  Info: "Info",
+  Warning: "Warning"
+};
+
+// src/defaultConfigSettings.ts
+var defaultCSpellSettings = {
+  ignoreRandomStrings: true,
+  minRandomLength: 40
+};
+
+// src/defineConfig.ts
+function defineConfig(config) {
+  return config;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ConfigFields,
+  IssueType,
+  MessageTypes,
+  defaultCSpellSettings,
+  defineConfig
+});

package/dist/index.mjs

@@ -1,2 +1,85 @@
-export * from './index.js';
-//# sourceMappingURL=index.mjs.map
+// src/configFields.ts
+var ConfigFields = {
+  allowCompoundWords: "allowCompoundWords",
+  cache: "cache",
+  caseSensitive: "caseSensitive",
+  description: "description",
+  dictionaries: "dictionaries",
+  dictionaryDefinitions: "dictionaryDefinitions",
+  enabled: "enabled",
+  enabledLanguageIds: "enabledLanguageIds",
+  enableFiletypes: "enableFiletypes",
+  enabledFileTypes: "enabledFileTypes",
+  enableGlobDot: "enableGlobDot",
+  failFast: "failFast",
+  features: "features",
+  files: "files",
+  flagWords: "flagWords",
+  gitignoreRoot: "gitignoreRoot",
+  globRoot: "globRoot",
+  ignorePaths: "ignorePaths",
+  ignoreRegExpList: "ignoreRegExpList",
+  ignoreWords: "ignoreWords",
+  ignoreRandomStrings: "ignoreRandomStrings",
+  import: "import",
+  includeRegExpList: "includeRegExpList",
+  language: "language",
+  languageId: "languageId",
+  languageSettings: "languageSettings",
+  loadDefaultConfiguration: "loadDefaultConfiguration",
+  maxDuplicateProblems: "maxDuplicateProblems",
+  maxNumberOfProblems: "maxNumberOfProblems",
+  minWordLength: "minWordLength",
+  minRandomLength: "minRandomLength",
+  name: "name",
+  noConfigSearch: "noConfigSearch",
+  noSuggestDictionaries: "noSuggestDictionaries",
+  numSuggestions: "numSuggestions",
+  overrides: "overrides",
+  patterns: "patterns",
+  pnpFiles: "pnpFiles",
+  readonly: "readonly",
+  reporters: "reporters",
+  showStatus: "showStatus",
+  spellCheckDelayMs: "spellCheckDelayMs",
+  suggestionNumChanges: "suggestionNumChanges",
+  suggestionsTimeout: "suggestionsTimeout",
+  suggestWords: "suggestWords",
+  useGitignore: "useGitignore",
+  usePnP: "usePnP",
+  userWords: "userWords",
+  validateDirectives: "validateDirectives",
+  words: "words",
+  // Experimental
+  parser: "parser"
+};
+
+// src/CSpellReporter.ts
+var IssueType = /* @__PURE__ */ ((IssueType2) => {
+  IssueType2[IssueType2["spelling"] = 0] = "spelling";
+  IssueType2[IssueType2["directive"] = 1] = "directive";
+  return IssueType2;
+})(IssueType || {});
+var MessageTypes = {
+  Debug: "Debug",
+  Info: "Info",
+  Warning: "Warning"
+};
+
+// src/defaultConfigSettings.ts
+var defaultCSpellSettings = {
+  ignoreRandomStrings: true,
+  minRandomLength: 40
+};
+
+// src/defineConfig.ts
+function defineConfig(config) {
+  return config;
+}
+export {
+  ConfigFields,
+  IssueType,
+  MessageTypes,
+  defaultCSpellSettings,
+  defineConfig
+};

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "8.17.0",
+  "version": "8.17.2",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "sideEffects": false,
@@ -53,8 +53,9 @@
   },
   "scripts": {
     "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
-    "build": "pnpm build:tsc && pnpm run build-schema",
+    "build": "pnpm build:tsc && pnpm build:tsup && pnpm run build-schema",
     "build:tsc": "tsc -p tsconfig.json",
+    "build:tsup": "tsup-node --entry src/index.ts --entry src/Parser/index.ts --format cjs,esm  --dts --out-dir dist",
     "build-schema": "pnpm build-cspell-schema",
     "clean-build": "pnpm run clean && pnpm run build",
     "coverage": "vitest run --coverage",
@@ -88,5 +89,5 @@
     "node": ">=18"
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-types#readme",
-  "gitHead": "cac17fe7b993db5965aa441648b1c22cb5486929"
+  "gitHead": "160c982e8d1e3b4951acb6fc003d013f3b0597e0"
 }

package/dist/CSpellReporter.d.ts

@@ -1,164 +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;
-    /**
-     * Ignore sequences of characters that look like random strings.
-     *
-     * @default true
-     */
-    ignoreRandomStrings?: boolean;
-    /**
-     * The minimum length of a random string to be ignored.
-     *
-     * @default 40
-     */
-    minRandomLength?: 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/CSpellReporter.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MessageTypes = exports.IssueType = void 0;
-var IssueType;
-(function (IssueType) {
-    IssueType[IssueType["spelling"] = 0] = "spelling";
-    IssueType[IssueType["directive"] = 1] = "directive";
-})(IssueType || (exports.IssueType = IssueType = {}));
-exports.MessageTypes = {
-    Debug: 'Debug',
-    Info: 'Info',
-    Warning: 'Warning',
-};
-//# sourceMappingURL=CSpellReporter.js.map