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

code samples: MD reformat

Browse Source
This commit is contained in:
Yann Cébron 2021-11-08 17:29:37 +01:00
parent 67159b343f
commit b97554a6e9
24 changed files with 72 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -32,7 +32,7 @@ Please see [Code Samples][docs:code-samples] topic on how to import and run code
In the following table, you may find all available samples provided in the separated directories as stand-alone projects available for running with the Gradle `:runIde` task.
| Code Sample | Description |
| ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
|------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Action Basics](./action_basics) | Action and Action Group patterns implementation, adds entries to the Tools menu. |
| [Comparing References Inspection](./comparing_references_inspection) | Local Inspection Tool, adds entries to **Settings/Preferences | Editor | Inspections | Java | Probable Bugs**. |
| [Conditional Operator Intention](./conditional_operator_intention) | Intention action, suggests converting a ternary operator into an `if` block and adds entry to **Settings/Preferences | Editor | Intentions | SDK Intentions**. |

6
SAMPLE_README.md
View File

@ -8,7 +8,7 @@ The Sample implements `com.intellij.sample` Extension Point, which should be exp
### Extension Points
| Name | Implementation | Extension Point Class |
| --------------------- | ------------------------------------------------- | --------------------- |
|-----------------------|---------------------------------------------------|-----------------------|
| `com.intellij.sample` | [SampleExtensionPoint][file:SampleExtensionPoint] | `ExtensionPoint` |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*
@ -16,7 +16,7 @@ The Sample implements `com.intellij.sample` Extension Point, which should be exp
### Actions
| ID | Implementation | Base Action Class |
| -------------------------------------- | --------------------------------- | ----------------- |
|----------------------------------------|-----------------------------------|-------------------|
| `org.intellij.sdk.action.SampleAction` | [SampleAction][file:SampleAction] | `AnAction` |
*Reference: [Action System in IntelliJ SDK Docs][docs:actions]*
@ -24,7 +24,7 @@ The Sample implements `com.intellij.sample` Extension Point, which should be exp
### Listeners
| Name | Implementation | Listener Class |
| -------- | ------------------------------------- | -------------- |
|----------|---------------------------------------|----------------|
| listener | [SampleListener][file:SampleListener] | `Listener` |
*Reference: [Plugin Listeners in IntelliJ SDK Docs][docs:listeners]*

2
action_basics/README.md
View File

@ -18,7 +18,7 @@ Additional features of the plugin:
### Actions
| ID | Implementation | Base Action Class |
| -------------------------------------------------- | --------------------------------------------------------- | ----------------- |
|----------------------------------------------------|-----------------------------------------------------------|-------------------|
| `org.intellij.sdk.action.GroupPopDialogAction` | [PopupDialogAction][file:PopupDialogAction] | `AnAction` |
| `org.intellij.sdk.action.PopupDialogAction` | [PopupDialogAction][file:PopupDialogAction] | `AnAction` |
| `org.intellij.sdk.action.CustomGroupedAction` | [PopupDialogAction][file:PopupDialogAction] | `AnAction` |

2
comparing_references_inspection/README.md
View File

@ -11,7 +11,7 @@ If such a check finds a comparison using the `==` or !`=` operators instead of t
### Extension Points
| Name | Implementation | Extension Point Class |
| ------------------------------ | ------------------------------------------------------------------- | ------------------------------------- |
|--------------------------------|---------------------------------------------------------------------|---------------------------------------|
| `com.intellij.localInspection` | [ComparingReferencesInspection][file:ComparingReferencesInspection] | `AbstractBaseJavaLocalInspectionTool` |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*

2
conditional_operator_intention/README.md
View File

@ -36,7 +36,7 @@ The converter in the `isAvailable` method, has defined the token check to match
### Extension Points
| Name | Implementation | Extension Point Class |
| ------------------------------ | ----------------------------------------------------------------- | ------------------------------- |
|--------------------------------|-------------------------------------------------------------------|---------------------------------|
| `com.intellij.intentionAction` | [ConditionalOperatorConverter][file:ConditionalOperatorConverter] | `PsiElementBaseIntentionAction` |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*

4
editor_basics/README.md
View File

@ -13,7 +13,7 @@ In addition, three actions are available in the Editor context menu:
### Extension Points
| Name | Implementation | Extension Point Class |
| --------------------------- | ------------------------------------- | ---------------------- |
|-----------------------------|---------------------------------------|------------------------|
| `com.intellij.typedHandler` | [MyTypedHandler][file:MyTypedHandler] | `TypedHandlerDelegate` |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*
@ -21,7 +21,7 @@ In addition, three actions are available in the Editor context menu:
### Actions
| ID | Implementation | Base Action Class |
| ------------------------------------------ | ----------------------------------------------------------- | ----------------- |
|--------------------------------------------|-------------------------------------------------------------|-------------------|
| `EditorBasics.EditorIllustrationAction` | [EditorIllustrationAction][file:EditorIllustrationAction] | `AnAction` |
| `EditorBasics.EditorHandlerIllustration` | [EditorHandlerIllustration][file:EditorHandlerIllustration] | `AnAction` |
| `EditorBasics.LogicalPositionIllustration` | [EditorAreaIllustration][file:EditorAreaIllustration] | `AnAction` |

2
facet_basics/README.md
View File

@ -12,7 +12,7 @@ It allows us to specify any configuration specified by the `FacetConfiguration`
### Extension Points
| Name | Implementation | Extension Point Class |
| ------------------------ | ----------------------------------- | --------------------- |
|--------------------------|-------------------------------------|-----------------------|
| `com.intellij.facetType` | [DemoFacetType][file:DemoFacetType] | `FacetType` |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*

2
framework_basics/README.md
View File

@ -9,7 +9,7 @@ This sample implementation adds a new *SDK Demo Framework* support in the Java t
### Extension Points
| Name | Implementation | Extension Point Class |
| ----------------------------- | ----------------------------------- | --------------------- |
|-------------------------------|-------------------------------------|-----------------------|
| `com.intellij.framework.type` | [DemoFramework][file:DemoFramework] | `FrameworkTypeEx` |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*

2
inspection_basics/README.md
View File

@ -10,7 +10,7 @@ Inspection, enabled by default, uses a visitor passing all PSI elements with no
### Extension Points
| Name | Implementation | Extension Point Class |
| ------------------------------ | --------------------------------------------- | --------------------- |
|--------------------------------|-----------------------------------------------|-----------------------|
| `com.intellij.localInspection` | [DemoCodeInspection][file:DemoCodeInspection] | `LocalInspectionTool` |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*

2
kotlin_demo/README.md
View File

@ -10,7 +10,7 @@ Action, added to the Main Menu, shows a message dialog when invoked.
### Actions
| ID | Implementation | Base Action Class |
| ---------------- | ------------------------------- | ----------------- |
|------------------|---------------------------------|-------------------|
| `MyPlugin.Hello` | [HelloAction][file:HelloAction] | `AnAction` |
*Reference: [Action System in IntelliJ SDK Docs][docs:actions]*

2
live_templates/README.md
View File

@ -11,7 +11,7 @@ Live Templates Sample Project implements two example live templates for the Mark
### Extension Points
| Name | Implementation | Extension Point Class |
| ----------------------------------- | --------------------------------------- | --------------------- |
|-------------------------------------|-----------------------------------------|-----------------------|
| `com.intellij.defaultLiveTemplates` | [Markdown][file:Markdown] | n/a |
| `com.intellij.liveTemplateContext` | [MarkdownContext][file:MarkdownContext] | `TemplateContextType` |
| `com.intellij.liveTemplateMacro` | [TitleCaseMacro][file:TitleCaseMacro] | `MacroBase` |

4
max_opened_projects/README.md
View File

@ -11,7 +11,7 @@ After opening each one, a message dialog is presented to the user with the curre
### Extension Points
| Name | Implementation | Extension Point Class |
| --------------------------------- | ----------------------------------------------------- | --------------------- |
|-----------------------------------|-------------------------------------------------------|-----------------------|
| `com.intellij.applicationService` | [ProjectCountingService][file:ProjectCountingService] | n/a |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*
@ -19,7 +19,7 @@ After opening each one, a message dialog is presented to the user with the curre
### Application Listeners
| Name | Implementation | Listener Class |
| -------- | --------------------------------------------------------- | ------------------------ |
|----------|-----------------------------------------------------------|--------------------------|
| listener | [ProjectOpenCloseListener][file:ProjectOpenCloseListener] | `ProjectManagerListener` |
*Reference: [Plugin Listeners in IntelliJ SDK Docs][docs:listeners]*

2
module/README.md
View File

@ -9,7 +9,7 @@ Module with a custom name, description, and icon set provides a `ModuleBuilder`
### Extension Points
| Name | Implementation | Extension Point Class |
| ------------------------- | ------------------------------------- | --------------------- |
|---------------------------|---------------------------------------|-----------------------|
| `com.intellij.moduleType` | [DemoModuleType][file:DemoModuleType] | `ModuleType` |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*

2
product_specific/pycharm_basics/README.md
View File

@ -9,7 +9,7 @@ The implementation utilizes a simple action added to the *MainMenu* group displa
### Actions
| ID | Implementation | Base Action Class |
| -------------------------------------------- | ------------------------------------------- | ----------------- |
|----------------------------------------------|---------------------------------------------|-------------------|
| `org.intellij.sdk.pycharm.PopupDialogAction` | [PopupDialogAction][file:PopupDialogAction] | `AnAction` |
*Reference: [Action System in IntelliJ SDK Docs][docs:actions]*

2
project_model/README.md
View File

@ -14,7 +14,7 @@ Within the implemented actions, you will be able to:
### Actions
| ID | Implementation | Base Action Class |
| --------------------------------- | ----------------------------------------------------------------- | ----------------- |
|-----------------------------------|-------------------------------------------------------------------|-------------------|
| `ProjectModel.SourceRoots` | [ShowSourceRootsActions][file:ShowSourceRootsActions] | `AnAction` |
| `ProjectModel.ProjectSdk` | [ProjectSdkAction][file:ProjectSdkAction] | `AnAction` |
| `ProjectModel.ProjectFileIndex` | [ProjectFileIndexSampleAction][file:ProjectFileIndexSampleAction] | `AnAction` |

2
project_view_pane/README.md
View File

@ -9,7 +9,7 @@ The current demo describes an implementation of the `com.intellij.projectViewPan
### Extension Points
| Name | Implementation | Extension Point Class |
| ------------------------------ | --------------------------------------------------- | ---------------------------- |
|--------------------------------|-----------------------------------------------------|------------------------------|
| `com.intellij.projectViewPane` | [ImagesProjectViewPane][file:ImagesProjectViewPane] | `AbstractProjectViewPSIPane` |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*

2
project_wizard/README.md
View File

@ -9,7 +9,7 @@ The new step contains a simple `JLabel` element as an example presentation of th
### Extension Points
| Name | Implementation | Extension Point Class |
| ---------------------------- | ------------------------------------------------- | --------------------- |
|------------------------------|---------------------------------------------------|-----------------------|
| `com.intellij.moduleBuilder` | [DemoModuleWizardStep][file:DemoModuleWizardStep] | `ModuleBuilder` |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*

2
psi_demo/README.md
View File

@ -12,7 +12,7 @@ PSI Demo project demonstrates working with the PSI Navigation by implementing `A
### Actions
| ID | Implementation | Base Action Class |
| ------------------- | ------------------------------------------------------- | ----------------- |
|---------------------|---------------------------------------------------------|-------------------|
| `PsiNavigationDemo` | [PsiNavigationDemoAction][file:PsiNavigationDemoAction] | `AnAction` |
*Reference: [Action System in IntelliJ SDK Docs][docs:actions]*

2
run_configuration/README.md
View File

@ -9,7 +9,7 @@ In this example, a new *Demo* configuration is added together with `Configuratio
### Extension Points
| Name | Implementation | Extension Point Class |
| -------------------------------- | --------------------------------------------------------- | --------------------- |
|----------------------------------|-----------------------------------------------------------|-----------------------|
| `com.intellij.configurationType` | [DemoRunConfigurationType][file:DemoRunConfigurationType] | `ConfigurationType` |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*

2
settings/README.md
View File

@ -11,7 +11,7 @@ This project illustrates a custom Application-level Settings through the impleme
### Extension Points
| Name | Implementation | Extension Point Class |
| -------------------------------------- | ------------------------------------------------------- | -------------------------- |
|----------------------------------------|---------------------------------------------------------|----------------------------|
| `com.intellij.applicationConfigurable` | [AppSettingsConfigurable][file:AppSettingsConfigurable] | `Configurable` |
| `com.intellij.applicationService` | [AppSettingsState][file:AppSettingsState] | `PersistentStateComponent` |

2
simple_language_plugin/README.md
View File

@ -8,7 +8,7 @@ Defines a new language, _Simple language_ with support for syntax highlighting,
### Extension Points
| Name | Implementation | Extension Point Class |
| --------------------------------------------- | --------------------------------------------------------------------------------------- | ------------------------------------ |
|-----------------------------------------------|-----------------------------------------------------------------------------------------|-------------------------------------|
| `com.intellij.fileType` | [SimpleFileType][file:SimpleFileType] | `LanguageFileType` |
| `com.intellij.lang.parserDefinition` | [SimpleParserDefinition][file:SimpleParserDefinition] | `ParserDefinition` |
| `com.intellij.lang.syntaxHighlighterFactory` | [SimpleSyntaxHighlighterFactory][file:SimpleSyntaxHighlighterFactory] | `SyntaxHighlighterFactory` |

2
theme_basics/README.md
View File

@ -23,7 +23,7 @@ It describes definitions of the actions, extensions, or listeners provided by th
### Extension Points
| Name | Implementation | Extension Point Class |
| ---------------------------- | ------------------------------------------------------- | --------------------- |
|------------------------------|---------------------------------------------------------|-----------------------|
| `com.intellij.themeProvider` | [theme_basics.theme.json][file:theme_basics.theme.json] | |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*

2
tool_window/README.md
View File

@ -12,7 +12,7 @@ Component is provided by the `MyToolWindow` class through the `getContent()` met
### Extension Points
| Name | Implementation | Extension Point Class |
| ------------------------- | ----------------------------------------------- | --------------------- |
|---------------------------|-------------------------------------------------|-----------------------|
| `com.intellij.toolWindow` | [MyToolWindowFactory][file:MyToolWindowFactory] | `ToolWindowFactory` |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*

2
tree_structure_provider/README.md
View File

@ -12,7 +12,7 @@ Otherwise, an element is not included in the results list, so only directories a
### Extension Points
| Name | Implementation | Extension Point Class |
| ------------------------------------ | ------------------------------------------------------------------- | ----------------------- |
|--------------------------------------|---------------------------------------------------------------------|-------------------------|
| `com.intellij.treeStructureProvider` | [TextOnlyTreeStructureProvider][file:TextOnlyTreeStructureProvider] | `TreeStructureProvider` |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*