|
| 1 | +<!-- Copyright 2000-2024 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> |
| 2 | + |
| 3 | +# Incompatible Changes in IntelliJ Platform and Plugins API 2025.* |
| 4 | + |
| 5 | +<!-- |
| 6 | +Before documenting a breaking API change, please make sure that the change cannot be avoided in an alternative way. |
| 7 | +
|
| 8 | +APIs marked with @Deprecated(forRemoval=true), @ApiStatus.Experimental, @ApiStatus.Internal/IntellijInternalApi, or @ApiStatus.ScheduledForRemoval don't need to be documented. |
| 9 | +
|
| 10 | +To document a new incompatible change, add a new line with the problem pattern followed by a 2nd line with ": "-prefixed human-readable description |
| 11 | +and recommended fix/action (REQUIRED, please write full sentence ending with '.', see existing entries as reference). |
| 12 | +Non-platform changes must be grouped under relevant section for plugin. |
| 13 | +
|
| 14 | +The following problem patterns are supported and must be followed EXACTLY (e.g., no '#' instead of '.'): |
| 15 | +
|
| 16 | +<package name> package removed |
| 17 | +
|
| 18 | +<class name> class removed |
| 19 | +<class name> class renamed to <new class name> |
| 20 | +<class name> class moved to package <package name> |
| 21 | +
|
| 22 | +<class name>.<method name>(<human-readable parameters>) marked abstract |
| 23 | +<class name>.<method name>(<human-readable parameters>) abstract method added |
| 24 | +<class name>.<method name>(<human-readable parameters>) method removed |
| 25 | +<class name>.<method name>(<human-readable parameters>) method moved to the superclass |
| 26 | +<class name>.<method name>(<human-readable parameters>) method return type changed from <before> to <after> |
| 27 | +<class name>.<method name>(<human-readable parameters>) method visibility changed from <before> to <after> |
| 28 | +<class name>.<method name>(<human-readable parameters>) method marked final |
| 29 | +<class name>.<method name>(<human-readable parameters>) method parameter <type> removed |
| 30 | +<class name>.<method name>(<human-readable parameters>) method parameter type changed from <before> to <after> |
| 31 | +<class name>.<method name> method <parameter name> parameter marked @<class name> |
| 32 | +<class name> (class|interface) now (extends|implements) <class name> and inherits its final method <method name>(<human-readable parameters>)? |
| 33 | +<class name> (class|interface) now (extends|implements) <class name> and inherits its abstract method <method name>(<human-readable parameters>)? |
| 34 | +<class name> class now interface |
| 35 | +
|
| 36 | +<class name>(<human-readable parameters>) constructor removed |
| 37 | +<class name>(<human-readable parameters>) constructor parameter <type> removed |
| 38 | +<class name>(<human-readable parameters>) constructor parameter type changed from <before> to <after> |
| 39 | +<class name>(<human-readable parameters>) constructor visibility changed from <before> to <after> |
| 40 | +
|
| 41 | +<class name>.<field name> field removed |
| 42 | +<class name>.<field name> field moved to the superclass |
| 43 | +<class name>.<field name> field type changed from <before> to <after> |
| 44 | +<class name>.<field name> field visibility changed from <before> to <after> |
| 45 | +
|
| 46 | +<property name> property removed from resource bundle <bundle name> |
| 47 | +
|
| 48 | +Where the placeholders must be enclosed in code quotes (`name`): |
| 49 | +
|
| 50 | +<class name> is a fully-qualified name of the class, e.g. `com.intellij.openapi.actionSystem.AnAction$InnerClass`. |
| 51 | +<method name> is the exact method's name. Note that constructors have dedicated patterns. |
| 52 | +<human-readable parameters> is a string representing parameters, which are not necessarily fully qualified. They do not affect the parser. For example, instead of (java.lang.Object, java.util.List, int) you are free to write (Object, List<String>, int) |
| 53 | +<parameter name> is exact name of the method's parameter |
| 54 | +<property name> is a full name of a property from .properties file, like `some.action.description` |
| 55 | +<bundle name> is a fully qualified name of the property bundle, which includes its package, like `message.IdeBundle` |
| 56 | +
|
| 57 | +NOTE: If a code change you're trying to document doesn't match any of the above patterns, please ask in #plugins-verifier |
| 58 | +
|
| 59 | +NOTE: You are allowed to prettify the pattern using links: [`org.example.Foo`](https://github.com/JetBrains/intellij-community/tree/master/) |
| 60 | +
|
| 61 | +NOTE: Entries not starting with code quotes (`name`) can be added to document non-code changes and will be skipped in API verification. |
| 62 | +--> |
| 63 | + |
| 64 | +<link-summary>List of known Breaking API Changes in 2025.*</link-summary> |
| 65 | + |
| 66 | +<include from="snippets.md" element-id="apiChangesHeader"/> |
| 67 | + |
| 68 | +<include from="snippets.md" element-id="apiChangesJavaVersion"/> |
| 69 | + |
| 70 | +<include from="snippets.md" element-id="gradlePluginVersion"/> |
| 71 | + |
| 72 | +## 2025.1 |
| 73 | + |
| 74 | +### IntelliJ Platform 2025.1 |
0 commit comments