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
intellij-sdk-code-samples/reference_guide/api_changes_list.md
Yann Cébron 3eb8ff0ea5 api_changes_list.md: inspections wording
2019-12-04 10:09:24 +01:00

5.2 KiB
Raw Blame History

title
Incompatible Changes in IntelliJ Platform and Plugins API

IntelliJ API may be occasionally changed between releases, leading to incompatibilities of existing plugins with newer IDE builds.

Note

Starting with 2020.1 release, IntelliJ Platform–based IDEs will use compatibility check information provided by the JetBrains plugin repository to highlight possible compatibility issues to users directly in the IDE's "Plugins" manager. Therefore, it is important to keep your plugins up to date with regard to the existing and upcoming API changes.

Compatibility with newer IDEs can easily be verified for plugins hosted on the JetBrains plugin repository using the built-in Plugin Verifier.

For non-public plugins, intellij-plugin-verifier can be used standalone as well.

Consider using the following IDE inspections to get additional alerts about code that uses unstable API features:

  • JVM languages | Unstable API Usage
  • JVM languages | Unstable type is used in signature

The following pages list the breaking changes in IDE/plugin releases with required/recommended steps to take by plugin authors.

Note

Changes from API marked with org.jetbrains.annotations.ApiStatus.@Experimental/ScheduledForRemoval are not listed here, as incompatible changes are to be expected.