@cspell/cspell-types 8.16.1 → 8.17.0

package/cspell.schema.json

@@ -1331,6 +1331,12 @@
           "markdownDescription": "Optional identifier.",
           "type": "string"
         },
+        "ignoreRandomStrings": {
+          "default": true,
+          "description": "Ignore sequences of characters that look like random strings.",
+          "markdownDescription": "Ignore sequences of characters that look like random strings.",
+          "type": "boolean"
+        },
         "ignoreRegExpList": {
           "$ref": "#/definitions/RegExpPatternList",
           "description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\b[A-Z]+\\b/g ```\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).",
@@ -1385,6 +1391,12 @@
           "markdownDescription": "The maximum number of problems to report in a file.",
           "type": "number"
         },
+        "minRandomLength": {
+          "default": 40,
+          "description": "The minimum length of a random string to be ignored.",
+          "markdownDescription": "The minimum length of a random string to be ignored.",
+          "type": "number"
+        },
         "minWordLength": {
           "default": 4,
           "description": "The minimum length of a word before checking it against a dictionary.",
@@ -1869,6 +1881,12 @@
       "markdownDescription": "Glob patterns of files to be ignored.\n\nGlob patterns are relative to the  {@link  globRoot }  of the configuration file that defines them.",
       "type": "array"
     },
+    "ignoreRandomStrings": {
+      "default": true,
+      "description": "Ignore sequences of characters that look like random strings.",
+      "markdownDescription": "Ignore sequences of characters that look like random strings.",
+      "type": "boolean"
+    },
     "ignoreRegExpList": {
       "$ref": "#/definitions/RegExpPatternList",
       "description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\b[A-Z]+\\b/g ```\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).",
@@ -1939,6 +1957,12 @@
       "markdownDescription": "The maximum number of problems to report in a file.",
       "type": "number"
     },
+    "minRandomLength": {
+      "default": 40,
+      "description": "The minimum length of a random string to be ignored.",
+      "markdownDescription": "The minimum length of a random string to be ignored.",
+      "type": "number"
+    },
     "minWordLength": {
       "default": 4,
       "description": "The minimum length of a word before checking it against a dictionary.",

package/dist/CSpellReporter.d.ts

@@ -120,6 +120,18 @@ export interface ReporterConfigurationBase {
      * @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 {
     /**

package/dist/configFields.js

@@ -22,6 +22,7 @@ exports.ConfigFields = {
     ignorePaths: 'ignorePaths',
     ignoreRegExpList: 'ignoreRegExpList',
     ignoreWords: 'ignoreWords',
+    ignoreRandomStrings: 'ignoreRandomStrings',
     import: 'import',
     includeRegExpList: 'includeRegExpList',
     language: 'language',
@@ -31,6 +32,7 @@ exports.ConfigFields = {
     maxDuplicateProblems: 'maxDuplicateProblems',
     maxNumberOfProblems: 'maxNumberOfProblems',
     minWordLength: 'minWordLength',
+    minRandomLength: 'minRandomLength',
     name: 'name',
     noConfigSearch: 'noConfigSearch',
     noSuggestDictionaries: 'noSuggestDictionaries',

package/dist/defaultConfigSettings.d.ts

@@ -0,0 +1,5 @@
+export declare const defaultCSpellSettings: {
+    readonly ignoreRandomStrings: true;
+    readonly minRandomLength: 40;
+};
+//# sourceMappingURL=defaultConfigSettings.d.ts.map

package/dist/defaultConfigSettings.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultCSpellSettings = void 0;
+exports.defaultCSpellSettings = {
+    ignoreRandomStrings: true,
+    minRandomLength: 40,
+};
+//# sourceMappingURL=defaultConfigSettings.js.map

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export { ConfigFields } from './configFields.js';
 export type { CSpellReporter, CSpellReporterModule, DebugEmitter, ErrorEmitter, ErrorLike, Issue, MessageEmitter, MessageType, MessageTypeLookup, ProgressBase, ProgressEmitter, ProgressFileBase, ProgressFileBegin, ProgressFileComplete, ProgressItem, ProgressTypes, ReporterConfiguration, ResultEmitter, RunResult, SpellingErrorEmitter, } from './CSpellReporter.js';
 export { IssueType, MessageTypes } from './CSpellReporter.js';
 export type { AdvancedCSpellSettings, AdvancedCSpellSettingsWithSourceTrace, BaseSetting, CacheFormat, CacheSettings, CacheStrategy, CommandLineSettings, CSpellPackageSettings, CSpellSettings, CSpellSettingsWithSourceTrace, CSpellUserSettings, CSpellUserSettingsWithComments, ExperimentalBaseSettings, ExperimentalFileSettings, ExtendableSettings, FileSettings, FileSource, FsPath, FSPathResolvable, Glob, GlobDef, ImportFileRef, InMemorySource, LanguageId, LanguageIdMultiple, LanguageIdMultipleNeg, LanguageIdSingle, LanguageSetting, LanguageSettingFilterFields, LanguageSettingFilterFieldsDeprecated, LanguageSettingFilterFieldsPreferred, LegacySettings, LocaleId, LocalId, MatchingFileType, MergeSource, OverrideFilterFields, OverrideSettings, Pattern, PatternId, PatternRef, Plugin, PnPSettings, PredefinedPatterns, RegExpPatternDefinition, RegExpPatternList, ReporterSettings, ReportingConfiguration, Settings, SimpleGlob, Source, SuggestionsConfiguration, TrustLevel, Version, VersionLatest, VersionLegacy, WorkspaceTrustSettings, } from './CSpellSettingsDef.js';
+export { defaultCSpellSettings } from './defaultConfigSettings.js';
 export { defineConfig } from './defineConfig.js';
 export type { CustomDictionaryPath, CustomDictionaryScope, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionInline, DictionaryDefinitionInlineFlagWords, DictionaryDefinitionInlineIgnoreWords, DictionaryDefinitionInlineWords, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryFileTypes, DictionaryId, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, ReplaceEntry, ReplaceMap, } from './DictionaryDefinition.js';
 export type { CharacterSet, CharacterSetCosts, DictionaryInformation, EditCosts } from './DictionaryInformation.js';

package/dist/index.js

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defineConfig = exports.MessageTypes = exports.IssueType = exports.ConfigFields = void 0;
+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

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "8.16.1",
+  "version": "8.17.0",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "sideEffects": false,
@@ -88,5 +88,5 @@
     "node": ">=18"
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-types#readme",
-  "gitHead": "773bb6e701ff0b7fbeb30e4621119bb4315415ad"
+  "gitHead": "cac17fe7b993db5965aa441648b1c22cb5486929"
 }