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

indexing_and_psi_stubs.md: cleanup

Browse Source
This commit is contained in:
Yann Cébron 2024-09-17 16:50:16 +02:00
parent 8b5e7453de
commit c05825d46c
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
topics/basics/indexing_and_psi_stubs.md
View File

@ -35,19 +35,27 @@ Violations are reported via [`IndexNotReadyException`](%gh-ic%/platform/core-api
It also provides ways of delaying code execution until indexes are ready. It also provides ways of delaying code execution until indexes are ready.
### `DumbAware` API ### `DumbAware` API
{id="DumbAwareAPI"} {id="DumbAwareAPI"}
Implementations of certain [](plugin_extension_points.md) can be marked as available during Dumb Mode by implementing #### Extension Points
Implementations of certain [extension points](plugin_extension_points.md) can be marked as available during Dumb Mode by implementing
[`DumbAware`](%gh-ic%/platform/core-api/src/com/intellij/openapi/project/DumbAware.java). [`DumbAware`](%gh-ic%/platform/core-api/src/com/intellij/openapi/project/DumbAware.java).
Such Extension Points are marked with Such extension points are marked with the
![DumbAware](https://img.shields.io/badge/-DumbAware-darkgreen?style=flat-square) ![DumbAware](https://img.shields.io/badge/-DumbAware-darkgreen?style=flat-square)
tag in [](intellij_platform_extension_point_list.md). tag in [](intellij_platform_extension_point_list.md).
Commonly used include [`CompletionContributor`](code_completion.md), [`(External)Annotator`](syntax_highlighting_and_error_highlighting.md#annotator) and various
Commonly used extension points include [`CompletionContributor`](code_completion.md), [`(External)Annotator`](syntax_highlighting_and_error_highlighting.md#annotator) and various
[run configuration](run_configurations.md) EPs. [run configuration](run_configurations.md) EPs.
Since 2024.2, also [intentions](code_intentions.md) and [quick-fixes](quick_fix.md). Since 2024.2, this includes also [intentions](code_intentions.md) and [quick-fixes](quick_fix.md).
#### Actions
For [](basic_action_system.md) available during Dumb Mode, extend [`DumbAwareAction`](%gh-ic%/platform/ide-core/src/com/intellij/openapi/project/DumbAwareAction.java). For [](basic_action_system.md) available during Dumb Mode, extend [`DumbAwareAction`](%gh-ic%/platform/ide-core/src/com/intellij/openapi/project/DumbAwareAction.java).
#### Other API
Other API might indicate its Dumb Mode compatibility by extending [`PossiblyDumbAware`](%gh-ic%/platform/core-api/src/com/intellij/openapi/project/PossiblyDumbAware.java). Other API might indicate its Dumb Mode compatibility by extending [`PossiblyDumbAware`](%gh-ic%/platform/core-api/src/com/intellij/openapi/project/PossiblyDumbAware.java).
### Testing ### Testing
@ -77,6 +85,7 @@ Please see [`VirtualFileGist`](%gh-ic%/platform/indexing-api/src/com/intellij/ut
## Improving Indexing Performance ## Improving Indexing Performance
### Performance Metrics ### Performance Metrics
<primary-label ref="2020.2"/> <primary-label ref="2020.2"/>
Indexing performance metrics in JSON format are generated in [logs directory](https://intellij-support.jetbrains.com/hc/en-us/articles/206544519-Directories-used-by-the-IDE-to-store-settings-caches-plugins-and-logs) (see [sandbox directory](ide_development_instance.md#the-development-instance-sandbox-directory) for development instance). Indexing performance metrics in JSON format are generated in [logs directory](https://intellij-support.jetbrains.com/hc/en-us/articles/206544519-Directories-used-by-the-IDE-to-store-settings-caches-plugins-and-logs) (see [sandbox directory](ide_development_instance.md#the-development-instance-sandbox-directory) for development instance).
@ -97,7 +106,7 @@ If a custom language contains lazy-parseable elements that never or rarely conta
For indexing XML, also consider using [`NanoXmlUtil`](%gh-ic%/platform/indexing-impl/src/com/intellij/util/xml/NanoXmlUtil.java). For indexing XML, also consider using [`NanoXmlUtil`](%gh-ic%/platform/indexing-impl/src/com/intellij/util/xml/NanoXmlUtil.java).
### Shared Project Indexes ### Shared Project Indexes
For bigger projects, building and providing pre-built shared project indexes can be beneficial, see [Shared project indexes](https://www.jetbrains.com/help/idea/shared-indexes.html#project-shared-indexes). For bigger projects, building and providing pre-built shared project indexes can be beneficial, see [Shared project indexes](https://www.jetbrains.com/help/idea/shared-indexes.html#project-shared-indexes).
See also [IntelliJ Shared Indexes Tool Example](https://github.com/JetBrains/intellij-shared-indexes-tool-example). See also [IntelliJ Shared Indexes Tool Example](https://github.com/JetBrains/intellij-shared-indexes-tool-example).