Skip to content

fix: Add btrie path to dictionary definition #8284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jason3S merged 1 commit into from
Jan 5, 2026
Merged

fix: Add btrie path to dictionary definition #8284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 36 additions & 17 deletions cspell.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,9 +200,9 @@
"type": "object"
},
"CustomDictionaryPath": {
"$ref": "#/definitions/FsDictionaryPath",
"description": "A File System Path to a dictionary file.",
"markdownDescription": "A File System Path to a dictionary file."
"description": "A path or url to a custom dictionary file.",
"markdownDescription": "A path or url to a custom dictionary file.",
"type": "string"
},
"CustomDictionaryScope": {
"description": "Specifies the scope of a dictionary.",
Expand Down Expand Up @@ -239,7 +239,7 @@
"DictionaryDefinitionAlternate": {
"additionalProperties": false,
"deprecated": true,
"deprecationMessage": "Use {@link DictionaryDefinitionPreferred } instead.",
"deprecationMessage": "Use {@link DictionaryDefinitionPreferred } instead.\nThis will be removed in a future release.",
"description": "Only for legacy dictionary definitions.",
"markdownDescription": "Only for legacy dictionary definitions.",
"properties": {
Expand Down Expand Up @@ -304,6 +304,12 @@
"description": "Used to provide extra data related to the dictionary",
"markdownDescription": "Used to provide extra data related to the dictionary",
"properties": {
"btrie": {
"$ref": "#/definitions/DictionaryPathToBTrie",
"description": "An alternative path to a bTrie dictionary file. It will be used in place of `path` if the version of CSpell being used supports btrie files.",
"markdownDescription": "An alternative path to a bTrie dictionary file.\nIt will be used in place of `path` if the version of CSpell being used\nsupports btrie files.",
"since": "9.6.0"
},
"description": {
"description": "Optional description of the contents / purpose of the dictionary.",
"markdownDescription": "Optional description of the contents / purpose of the dictionary.",
Expand All @@ -329,8 +335,8 @@
},
"path": {
"$ref": "#/definitions/DictionaryPath",
"description": "Path to the file.",
"markdownDescription": "Path to the file."
"description": "Path or url to the dictionary file.",
"markdownDescription": "Path or url to the dictionary file."
},
"repMap": {
"$ref": "#/definitions/ReplaceMap",
Expand Down Expand Up @@ -371,6 +377,12 @@
"markdownDescription": "When `true`, let's the spell checker know that words can be added to this dictionary.",
"type": "boolean"
},
"btrie": {
"$ref": "#/definitions/DictionaryPathToBTrie",
"description": "An alternative path to a bTrie dictionary file. It will be used in place of `path` if the version of CSpell being used supports btrie files.",
"markdownDescription": "An alternative path to a bTrie dictionary file.\nIt will be used in place of `path` if the version of CSpell being used\nsupports btrie files.",
"since": "9.6.0"
},
"description": {
"description": "Optional description of the contents / purpose of the dictionary.",
"markdownDescription": "Optional description of the contents / purpose of the dictionary.",
Expand All @@ -393,8 +405,8 @@
},
"path": {
"$ref": "#/definitions/CustomDictionaryPath",
"description": "Path to custom dictionary text file.",
"markdownDescription": "Path to custom dictionary text file."
"description": "A file path or url to a custom dictionary file.",
"markdownDescription": "A file path or url to a custom dictionary file."
},
"repMap": {
"$ref": "#/definitions/ReplaceMap",
Expand Down Expand Up @@ -695,6 +707,12 @@
"DictionaryDefinitionPreferred": {
"additionalProperties": false,
"properties": {
"btrie": {
"$ref": "#/definitions/DictionaryPathToBTrie",
"description": "An alternative path to a bTrie dictionary file. It will be used in place of `path` if the version of CSpell being used supports btrie files.",
"markdownDescription": "An alternative path to a bTrie dictionary file.\nIt will be used in place of `path` if the version of CSpell being used\nsupports btrie files.",
"since": "9.6.0"
},
"description": {
"description": "Optional description of the contents / purpose of the dictionary.",
"markdownDescription": "Optional description of the contents / purpose of the dictionary.",
Expand All @@ -717,8 +735,8 @@
},
"path": {
"$ref": "#/definitions/DictionaryPath",
"description": "Path to the file.",
"markdownDescription": "Path to the file."
"description": "Path or url to the dictionary file.",
"markdownDescription": "Path or url to the dictionary file."
},
"repMap": {
"$ref": "#/definitions/ReplaceMap",
Expand Down Expand Up @@ -870,8 +888,14 @@
"type": "string"
},
"DictionaryPath": {
"description": "A File System Path to a dictionary file. Pattern: `^.*\\.(?:txt|trie|dic)(?:\\.gz)?$`",
"markdownDescription": "A File System Path to a dictionary file.\nPattern: `^.*\\.(?:txt|trie|dic)(?:\\.gz)?$`",
"description": "A File System Path to a dictionary file. Pattern: `^.*\\.(?:txt|trie|btrie|dic)(?:\\.gz)?$`",
"markdownDescription": "A File System Path to a dictionary file.\nPattern: `^.*\\.(?:txt|trie|btrie|dic)(?:\\.gz)?$`",
"type": "string"
},
"DictionaryPathToBTrie": {
"description": "A File System Path to a dictionary file. Pattern: `^.*\\.(?:btrie)(?:\\.gz)?$`",
"markdownDescription": "A File System Path to a dictionary file.\nPattern: `^.*\\.(?:btrie)(?:\\.gz)?$`",
"since": "9.6.0",
"type": "string"
},
"DictionaryRef": {
Expand Down Expand Up @@ -948,11 +972,6 @@
},
"type": "object"
},
"FsDictionaryPath": {
"description": "A File System Path. Relative paths are relative to the configuration file.",
"markdownDescription": "A File System Path. Relative paths are relative to the configuration file.",
"type": "string"
},
"FsPath": {
"description": "A File System Path. Relative paths are relative to the configuration file.",
"markdownDescription": "A File System Path. Relative paths are relative to the configuration file.",
Expand Down
4 changes: 2 additions & 2 deletions packages/cspell-eslint-plugin/src/generated/schema.cts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,8 @@ export const optionsSchema: Rule.RuleMetaData['schema'] = {
"type": "string"
},
"path": {
"description": "Path to the file.",
"markdownDescription": "Path to the file.",
"description": "Path or url to the dictionary file.",
"markdownDescription": "Path or url to the dictionary file.",
"type": "string"
},
"supportNonStrictSearches": {
Expand Down
66 changes: 47 additions & 19 deletions packages/cspell-lib/api/api.d.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions packages/cspell-lib/src/lib/Settings/DictionarySettings.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ class _DictionaryDefinitionInternalWithSource implements DictionaryFileDefinitio
name,
file: undefined,
path: resolvedPath,
btrie: undefined,
addWords,
description,
dictionaryInformation,
Expand Down
53 changes: 36 additions & 17 deletions packages/cspell-types/cspell.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,9 +200,9 @@
"type": "object"
},
"CustomDictionaryPath": {
"$ref": "#/definitions/FsDictionaryPath",
"description": "A File System Path to a dictionary file.",
"markdownDescription": "A File System Path to a dictionary file."
"description": "A path or url to a custom dictionary file.",
"markdownDescription": "A path or url to a custom dictionary file.",
"type": "string"
},
"CustomDictionaryScope": {
"description": "Specifies the scope of a dictionary.",
Expand Down Expand Up @@ -239,7 +239,7 @@
"DictionaryDefinitionAlternate": {
"additionalProperties": false,
"deprecated": true,
"deprecationMessage": "Use {@link DictionaryDefinitionPreferred } instead.",
"deprecationMessage": "Use {@link DictionaryDefinitionPreferred } instead.\nThis will be removed in a future release.",
"description": "Only for legacy dictionary definitions.",
"markdownDescription": "Only for legacy dictionary definitions.",
"properties": {
Expand Down Expand Up @@ -304,6 +304,12 @@
"description": "Used to provide extra data related to the dictionary",
"markdownDescription": "Used to provide extra data related to the dictionary",
"properties": {
"btrie": {
"$ref": "#/definitions/DictionaryPathToBTrie",
"description": "An alternative path to a bTrie dictionary file. It will be used in place of `path` if the version of CSpell being used supports btrie files.",
"markdownDescription": "An alternative path to a bTrie dictionary file.\nIt will be used in place of `path` if the version of CSpell being used\nsupports btrie files.",
"since": "9.6.0"
},
"description": {
"description": "Optional description of the contents / purpose of the dictionary.",
"markdownDescription": "Optional description of the contents / purpose of the dictionary.",
Expand All @@ -329,8 +335,8 @@
},
"path": {
"$ref": "#/definitions/DictionaryPath",
"description": "Path to the file.",
"markdownDescription": "Path to the file."
"description": "Path or url to the dictionary file.",
"markdownDescription": "Path or url to the dictionary file."
},
"repMap": {
"$ref": "#/definitions/ReplaceMap",
Expand Down Expand Up @@ -371,6 +377,12 @@
"markdownDescription": "When `true`, let's the spell checker know that words can be added to this dictionary.",
"type": "boolean"
},
"btrie": {
"$ref": "#/definitions/DictionaryPathToBTrie",
"description": "An alternative path to a bTrie dictionary file. It will be used in place of `path` if the version of CSpell being used supports btrie files.",
"markdownDescription": "An alternative path to a bTrie dictionary file.\nIt will be used in place of `path` if the version of CSpell being used\nsupports btrie files.",
"since": "9.6.0"
},
"description": {
"description": "Optional description of the contents / purpose of the dictionary.",
"markdownDescription": "Optional description of the contents / purpose of the dictionary.",
Expand All @@ -393,8 +405,8 @@
},
"path": {
"$ref": "#/definitions/CustomDictionaryPath",
"description": "Path to custom dictionary text file.",
"markdownDescription": "Path to custom dictionary text file."
"description": "A file path or url to a custom dictionary file.",
"markdownDescription": "A file path or url to a custom dictionary file."
},
"repMap": {
"$ref": "#/definitions/ReplaceMap",
Expand Down Expand Up @@ -695,6 +707,12 @@
"DictionaryDefinitionPreferred": {
"additionalProperties": false,
"properties": {
"btrie": {
"$ref": "#/definitions/DictionaryPathToBTrie",
"description": "An alternative path to a bTrie dictionary file. It will be used in place of `path` if the version of CSpell being used supports btrie files.",
"markdownDescription": "An alternative path to a bTrie dictionary file.\nIt will be used in place of `path` if the version of CSpell being used\nsupports btrie files.",
"since": "9.6.0"
},
"description": {
"description": "Optional description of the contents / purpose of the dictionary.",
"markdownDescription": "Optional description of the contents / purpose of the dictionary.",
Expand All @@ -717,8 +735,8 @@
},
"path": {
"$ref": "#/definitions/DictionaryPath",
"description": "Path to the file.",
"markdownDescription": "Path to the file."
"description": "Path or url to the dictionary file.",
"markdownDescription": "Path or url to the dictionary file."
},
"repMap": {
"$ref": "#/definitions/ReplaceMap",
Expand Down Expand Up @@ -870,8 +888,14 @@
"type": "string"
},
"DictionaryPath": {
"description": "A File System Path to a dictionary file. Pattern: `^.*\\.(?:txt|trie|dic)(?:\\.gz)?$`",
"markdownDescription": "A File System Path to a dictionary file.\nPattern: `^.*\\.(?:txt|trie|dic)(?:\\.gz)?$`",
"description": "A File System Path to a dictionary file. Pattern: `^.*\\.(?:txt|trie|btrie|dic)(?:\\.gz)?$`",
"markdownDescription": "A File System Path to a dictionary file.\nPattern: `^.*\\.(?:txt|trie|btrie|dic)(?:\\.gz)?$`",
"type": "string"
},
"DictionaryPathToBTrie": {
"description": "A File System Path to a dictionary file. Pattern: `^.*\\.(?:btrie)(?:\\.gz)?$`",
"markdownDescription": "A File System Path to a dictionary file.\nPattern: `^.*\\.(?:btrie)(?:\\.gz)?$`",
"since": "9.6.0",
"type": "string"
},
"DictionaryRef": {
Expand Down Expand Up @@ -948,11 +972,6 @@
},
"type": "object"
},
"FsDictionaryPath": {
"description": "A File System Path. Relative paths are relative to the configuration file.",
"markdownDescription": "A File System Path. Relative paths are relative to the configuration file.",
"type": "string"
},
"FsPath": {
"description": "A File System Path. Relative paths are relative to the configuration file.",
"markdownDescription": "A File System Path. Relative paths are relative to the configuration file.",
Expand Down
Loading
Loading