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: grammar checks

Browse Source
This commit is contained in:
Yann Cébron 2024-05-14 16:53:11 +02:00
parent 579116dd77
commit f6b65fa909
2 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
topics/intro/content_updates.md
View File

@ -12,6 +12,12 @@ See [GitHub Changelog](https://github.com/JetBrains/intellij-sdk-docs/commits/ma
## 2024
### May
{may-24}
Minor Changes and Additions
:
- How to support [grammar checks](spell_checking.md#grammar-checks) provided by Grazie plugin in custom languages.
### April
{april-24}

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

@ -110,3 +110,27 @@ Register in `com.intellij.spellchecker.dictionary.runtimeDictionaryProvider` ext
**Example**
[`PyPackagesDictionary`](%gh-ic%/python/src/com/jetbrains/python/packaging/PyPackagesDictionary.kt)
## Grammar Checks (Grazie plugin)
{id="grammar-checks"}
[Grazie Lite](https://plugins.jetbrains.com/plugin/12175-grazie-lite) (bundled) and
[Grazie Pro](https://plugins.jetbrains.com/plugin/16136-grazie-pro/)
plugins provide intelligent spelling and grammar checks for all texts.
To use the API mentioned below, add a [dependency](plugin_dependencies.md) on plugin ID `tanvd.grazi`.
### `TextExtractor`
To define how to extract natural language text from PSI, implement
[`TextExtractor`](%gh-ic%/plugins/grazie/src/main/kotlin/com/intellij/grazie/text/TextExtractor.java)
and register in `com.intellij.grazie.textExtractor` extension point.
**Example:** [`JavaTextExtractor`](%gh-ic%/plugins/grazie/java/src/main/kotlin/com/intellij/grazie/ide/language/java/JavaTextExtractor.java)
### `ProblemFilter`
To ignore specific reported problems, implement [`ProblemFilter`](%gh-ic%/plugins/grazie/src/main/kotlin/com/intellij/grazie/text/ProblemFilter.java)
registered in `com.intellij.grazie.problemFilter` extension point.
**Example:** [`JavadocProblemFilter`](%gh-ic%/plugins/grazie/java/src/main/kotlin/com/intellij/grazie/ide/language/java/JavadocProblemFilter.java)