RubyMine Extension Point and Listener List

Edit pageLast modified: 13 November 2024

Product-Specific Plugin Development: RubyMine

80 Extension Points and 13 Listeners for RubyMine

See IntelliJ Platform Extension Point and Listener List for IntelliJ Platform.

Legend

tip

See also Explore the IntelliJ Platform API for more information and strategies.

Listeners

Topic searches for usages inside existing implementations of open-source IntelliJ Platform plugins via IntelliJ Platform Explorer.

Listener links corresponding listener to implement.

See Listeners on how to register listeners.

Extension Points

Extension Point searches for usages inside existing implementations of open-source IntelliJ Platform plugins via IntelliJ Platform Explorer.

Implementation is the related Extension Point class.

See Extensions on how to declare extensions in your plugin.

Tags

See Verifying Plugin Compatibility for overview of API status.

Icon

Description

Details

Deprecated

Deprecated API

See code documentation for replacement.

Removal

Scheduled for Removal API

See code documentation for replacement.

Obsolete

Obsolete API

Do not use in new code.

See code documentation for replacement (Obsolete API).

Experimental API

Experimental API

Annotated with @ApiStatus.Experimental.

API might be altered or removed without prior notice.

Internal API

Internal API

Annotated with @ApiStatus.Internal.

Must not be used by third party plugins, see Internal API Migration.

Project-Level

Project-Level

Extension Point/Topic

Can have Project as constructor parameter.

- Extension Point: Declared with area="IDEA_PROJECT"

- Listener: registered in <projectListeners>

Non-Dynamic

Non-Dynamic

Extension Point

Installation/update of plugin requires IDE restart (Dynamic Plugins).

DumbAware

DumbAware

Extension Point

Implementations marked with DumbAware will be processed during dumb mode.

RubyMine

RubyMine – Listeners

Topic

Listener

RbsLanguageSettingsChangedListener#TOPIC

RbsLanguageSettingsChangedListener

ChefTopics#COOKBOOK

CookbooksListener

GemManager#GEMSET_CHANGED_TOPIC

GemSetListener

GemManager#MODULE_GEMS_CHANGED_TOPIC Project-Level

ModuleGemsListener

GemRequirementsHolder#GEM_REQUIREMENTS_CHANGED_TOPIC Project-Level

RequirementsChangedListener

InflectorService#INFLECTIONS_CHANGED

InflectionChanged

AssetsRegistrationWatcher#ASSETS_CHANGED_TOPIC

AssetsListener

MigrationParser#MIGRATIONS_CHANGED_TOPIC Project-Level

MigrationListener

RailsPathsChangedListener#TOPIC

RailsPathsChangedListener

RubyRemoteInterpreterManager#RUBY_REMOTE_SDK_TRANSFER_LISTENER_TOPIC

RubyRemoteSdkTransferListener

RequireSetChangedListener#TOPIC

RequireSetChangedListener

RubySdkType#SDK_PATHS_INITIALIZED_TOPIC

SdkPathsInitializedListener

RVMSupportUtil#RVM_GEMSET_ADDED_TOPIC

RVMGemsetListener

intellij.ruby.coverage.xml

Extension Point

Implementation

org.jetbrains.plugins.ruby.coverage.deserializer

RubyCoverageDeserializationProvider

ruby-core.xml

Extension Point

Implementation

org.jetbrains.plugins.ruby.associationFactory

AssociationFactory

org.jetbrains.plugins.ruby.attributeProvider

AttributeProvider

org.jetbrains.plugins.ruby.autoImportProvider

RubyAutoImportProvider

org.jetbrains.plugins.ruby.callNavigationOffsetProvider

StructureCallNavigationOffsetProvider

org.jetbrains.plugins.ruby.callTypeProvider

RubyCallTypeProvider

org.jetbrains.plugins.ruby.completionProvider

RubyCompletionProvider

org.jetbrains.plugins.ruby.fileLocationProvider

FileLocationProvider

org.jetbrains.plugins.ruby.gem.module.gemInfrastructure

GemInfrastructure

org.jetbrains.plugins.ruby.gemScannerSuppressor

GemScannerSuppressor

org.jetbrains.plugins.ruby.implicitGemProvider

ImplicitRequireGemProvider

org.jetbrains.plugins.ruby.implicitRequireProvider

ImplicitRequireProvider

org.jetbrains.plugins.ruby.includeExtendReceiverFqnProvider

RubyIncludeExtendReceiverFqnProvider

org.jetbrains.plugins.ruby.methodMissingProvider

MethodMissingProvider

org.jetbrains.plugins.ruby.model.psiSymbolDeclarationsSearch

QueryExecutor

org.jetbrains.plugins.ruby.moduleGemDependencyProvider

ModuleGemDependencyProvider

org.jetbrains.plugins.ruby.moduleGemProvider

ModuleGemProvider

org.jetbrains.plugins.ruby.overriddenMethodGenerator

OverriddenMethodGenerator

org.jetbrains.plugins.ruby.paramDefProvider

ParamDefProvider

org.jetbrains.plugins.ruby.rails.viewFileTemplateProvider

RailsViewFileTemplateProvider

org.jetbrains.plugins.ruby.renameHelper

RubyRenameHelper

org.jetbrains.plugins.ruby.routesProvider

RubyRoutesProvider

org.jetbrains.plugins.ruby.ruby.coercibleExpressionTypeProvider

RubyCoercibleExpressionTypeProvider

org.jetbrains.plugins.ruby.ruby.expectedArgumentTypeProvider

RubyExpectedArgumentTypeProvider

org.jetbrains.plugins.ruby.ruby.expectedConstantTypeProvider

RubyExpectedConstantTypeProvider

org.jetbrains.plugins.ruby.ruby.expectedGlobalVariableTypeProvider

RubyExpectedGlobalVariableTypeProvider

org.jetbrains.plugins.ruby.ruby.expectedParameterTypeProvider

RubyExpectedParameterTypeProvider

org.jetbrains.plugins.ruby.ruby.expectedReturnTypeProvider

RubyExpectedReturnTypeProvider

org.jetbrains.plugins.ruby.ruby.expectedVariableTypeProvider

RubyExpectedVariableTypeProvider

org.jetbrains.plugins.ruby.ruby.findUsagesSecondaryElementsProvider

RubyFindUsagesSecondaryElementsProvider

org.jetbrains.plugins.ruby.ruby.run.runEnvironmentProvider

RunEnvironmentProvider

org.jetbrains.plugins.ruby.ruby.run.testFrameworkConfigurator

TestFrameworkConfigurator

org.jetbrains.plugins.ruby.rubyElementNameAndDescriptionProvider

RubyElementNameAndDescriptionProvider

org.jetbrains.plugins.ruby.rubyLocalVariablesProvider

RubyLocalVariablesProvider

org.jetbrains.plugins.ruby.rubyParamDefSearchTextProvider

RubyParamDefSearchTextProvider

org.jetbrains.plugins.ruby.rubyParameterInfoDelegateProvider

RubyParameterInfoDelegateProvider

org.jetbrains.plugins.ruby.rubyRenameProcessor

RenameProcessor

org.jetbrains.plugins.ruby.rubySdkConfigurator

RubySdkConfigurator

org.jetbrains.plugins.ruby.rubySdkRefresher

SdkRefresher

org.jetbrains.plugins.ruby.rubySuperMethodsSearch

QueryExecutor

org.jetbrains.plugins.ruby.rubySupportProvider

RubySupportProvider

org.jetbrains.plugins.ruby.rubyTypeProvider

RubyTypeProvider

org.jetbrains.plugins.ruby.run.console.filter

RubyConsoleFilterProvider

org.jetbrains.plugins.ruby.runnableScriptFilter

RunnableScriptFilter

org.jetbrains.plugins.ruby.superMethodInfoProvider

RubySuperMethodInfoProvider

org.jetbrains.plugins.ruby.symbolMixinsProvider

RubySymbolMixinsProvider

org.jetbrains.plugins.ruby.symbolProvider

RubySymbolProvider

org.jetbrains.plugins.ruby.symbolicTypeInferenceProvider

SymbolicTypeInferenceProvider

org.jetbrains.plugins.ruby.templates.integration

TemplateIntegration

org.jetbrains.plugins.ruby.versionManagerHandler

RubyVersionManagerHandler

ruby-plugin.xml

Extension Point

Implementation

com.intellij.ruby.projectStructure.sourceRootEditHandler

RubyModuleSourceRootEditProvider

org.jetbrains.plugins.ruby.breadcrumbsCustomizer

RubyBreadcrumbsCustomizer

org.jetbrains.plugins.ruby.debug.infoProvider

ContextInfoProvider

org.jetbrains.plugins.ruby.gem.detector

GemDetector

org.jetbrains.plugins.ruby.gemFacetEditorTab

GemFacetEditorTabFactory

org.jetbrains.plugins.ruby.generatorConfigurator

GeneratorActionConfigurator

org.jetbrains.plugins.ruby.i18n.i18nProvider

I18nProvider

org.jetbrains.plugins.ruby.inflectionsProvider

RubyInflectionsProvider

org.jetbrains.plugins.ruby.rails.assetsPathsProvider

SprocketAssetsPathProvider

org.jetbrains.plugins.ruby.rails.sprocketsDirectiveContextProvider

SprocketsDirectiveContextProvider

org.jetbrains.plugins.ruby.rails.viewFileTypesProvider

RailsViewFileTypesProvider

org.jetbrains.plugins.ruby.railsFacetEditorTab

FacetEditorTabFactory

org.jetbrains.plugins.ruby.railsModelFieldsProvider

RailsModelFieldsProvider

org.jetbrains.plugins.ruby.railsNavigateFrom

RailsNavigateFromProvider

org.jetbrains.plugins.ruby.railsSchemaParser

RailsSchemaParser

org.jetbrains.plugins.ruby.rake.rakeRunCommandLineModifierProvider

RakeRunCommandLineModifierProvider

org.jetbrains.plugins.ruby.rake.runConfigurationSettingsFactory

RakeRunConfigurationSettingsFactory

org.jetbrains.plugins.ruby.rerunFailedTestsActionProvider

RubyRerunFailedTestsProvider

org.jetbrains.plugins.ruby.ruby.associatedDeclarationProvider DumbAware

RubyAssociatedDeclarationProvider

org.jetbrains.plugins.ruby.ruby.run.configuration.debugger.rubyDebugHelperFactory

RubyDebugHelperFactory

org.jetbrains.plugins.ruby.ruby.topLevelSymbolProvider

RubyTopLevelSymbolProvider

org.jetbrains.plugins.ruby.ruby.typeSignatureProvider DumbAware

RubyTypeSignatureProvider

org.jetbrains.plugins.ruby.rubyFileStructureProvider

RubyFileStructureViewProvider

org.jetbrains.plugins.ruby.rubyInsertHandlerProvider

RubyInsertHandlerProvider

org.jetbrains.plugins.ruby.rubyMethodTypeDocPresentationProvider

RubyMethodTypeDocPresentationProvider

org.jetbrains.plugins.ruby.runConfigurationExtension

RubyRunConfigurationExtension

org.jetbrains.plugins.ruby.structureViewCustomizer

RubyStructureViewCustomizer

org.jetbrains.plugins.ruby.testing.rspec.rspecContextNameProvider

RSpecContextNameProvider

org.jetbrains.plugins.ruby.testing.rspec.rspecContextSymbolProvider

RSpecContextSymbolProvider

ruby-rbs.xml

Extension Point

Implementation

com.intellij.lang.ruby.rbs.containerHierarchyMapper

RbsContainerHierarchyMapper