hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-28 01:07:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

spell_checking.md: cleanup, RuntimeDictionaryProvider

Browse Source
This commit is contained in:
Yann Cébron 2023-02-28 12:08:50 +01:00
parent 2a50faa830
commit 93f5b77b34
2 changed files with 21 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
topics/intro/content_updates.md
View File

@ -18,6 +18,7 @@ Inspection Options
Minor Changes and Additions Minor Changes and Additions
: :
- Add section on [](work_with_icons_and_images.md#mapping-new-ui-icons). - Add section on [](work_with_icons_and_images.md#mapping-new-ui-icons).
- Document [](spell_checking.md#runtimedictionaryprovider) EP for spellchecking.
### January-23 ### January-23

27
topics/reference_guide/custom_language_support/spell_checking.md
View File

@ -1,6 +1,8 @@
[//]: # (title: Spell Checking) # Spell Checking
<!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2023 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
<link-summary>Providing spellchecking for custom language.</link-summary>
<tldr> <tldr>
@ -14,6 +16,7 @@ Language plugins can implement customized spell checking by implementing
and registering it in the `com.intellij.spellchecker.support` extension point. and registering it in the `com.intellij.spellchecker.support` extension point.
**Examples:** **Examples:**
- [Custom Language Support Tutorial: Spell Checking](spell_checking_strategy.md) - [Custom Language Support Tutorial: Spell Checking](spell_checking_strategy.md)
- [`JavaSpellcheckingStrategy`](%gh-ic%/java/java-impl/src/com/intellij/spellchecker/JavaSpellcheckingStrategy.java) - [`JavaSpellcheckingStrategy`](%gh-ic%/java/java-impl/src/com/intellij/spellchecker/JavaSpellcheckingStrategy.java)
- [`HtmlSpellcheckingStrategy`](%gh-ic%/xml/impl/src/com/intellij/spellchecker/xml/HtmlSpellcheckingStrategy.java) - [`HtmlSpellcheckingStrategy`](%gh-ic%/xml/impl/src/com/intellij/spellchecker/xml/HtmlSpellcheckingStrategy.java)
@ -75,7 +78,7 @@ splits identifiers into separate words.
A custom language can define special splitting rules for elements by deriving from `Splitter` and A custom language can define special splitting rules for elements by deriving from `Splitter` and
implementing the logic for obtaining words from the passed text in the `split()` method. implementing the logic for obtaining words from the passed text in the `split()` method.
## SuppressibleSpellcheckingStrategy ## Suppressing Spellchecking
Custom languages that support the suppression of inspection annotations can derive from Custom languages that support the suppression of inspection annotations can derive from
[`SuppressibleSpellcheckingStrategy`](%gh-ic%/spellchecker/src/com/intellij/spellchecker/tokenizer/SuppressibleSpellcheckingStrategy.java) [`SuppressibleSpellcheckingStrategy`](%gh-ic%/spellchecker/src/com/intellij/spellchecker/tokenizer/SuppressibleSpellcheckingStrategy.java)
@ -86,13 +89,23 @@ overriding `getSuppressActions()` to add quick fix actions that suppress warning
**Example:** **Example:**
[`XmlSpellcheckingStrategy`](%gh-ic%/xml/impl/src/com/intellij/spellchecker/xml/XmlSpellcheckingStrategy.java) [`XmlSpellcheckingStrategy`](%gh-ic%/xml/impl/src/com/intellij/spellchecker/xml/XmlSpellcheckingStrategy.java)
## BundledDictionaryProvider ## Providing Dictionaries
Some custom languages may have a distinct set of words or key identifiers. ### BundledDictionaryProvider
Custom languages can provide these words in additional dictionaries by inheriting from
Some custom languages may have a distinct fixed set of words or key identifiers.
These words can be provided in additional dictionaries from
[BundledDictionaryProvider](%gh-ic%/spellchecker/src/com/intellij/spellchecker/BundledDictionaryProvider.java). [BundledDictionaryProvider](%gh-ic%/spellchecker/src/com/intellij/spellchecker/BundledDictionaryProvider.java).
Implement `getBundledDictionaries()` to return paths to the word dictionaries and Implement `getBundledDictionaries()` to return paths to the word dictionaries (<path>*.dic</path> files) and
register it with the `com.intellij.spellchecker.bundledDictionaryProvider` extension point. register it with the `com.intellij.spellchecker.bundledDictionaryProvider` extension point.
**Example:** **Example:**
[`PythonBundledDictionaryProvider`](%gh-ic%/python/src/com/jetbrains/python/spellchecker/PythonBundledDictionaryProvider.java) [`PythonBundledDictionaryProvider`](%gh-ic%/python/src/com/jetbrains/python/spellchecker/PythonBundledDictionaryProvider.java)
### RuntimeDictionaryProvider
[`RuntimeDictionaryProvider`](%gh-ic%/spellchecker/src/com/intellij/spellchecker/dictionary/RuntimeDictionaryProvider.java)
allows providing (dynamic) dictionaries generated at runtime, e.g., downloaded from a server, created from project sources on-the-fly, etc.
**Example**
[`PyPackagesDictionary`](%gh-ic%/python/src/com/jetbrains/python/packaging/PyPackagesDictionary.kt)