DocumentUpdatingActionOnSave was made internal, but is public API

jansorg · June 22, 2026, 8:30pm

To implement „format on save“, the abstract class ActionsOnSaveFileDocumentManagerListener.DocumentUpdatingActionOnSave is extended.

But the outer class of it was made internal recently, which breaks the public API based on nested classes. Plugin verifier complained on the Marketplace.

In regard to API, this eap cycle is really bad. A lot of API is made internal even though there are obvious uses and extensions using it. I‘m feeling very frustrated with it right now…

github.com/JetBrains/intellij-community

platform/platform-impl/src/com/intellij/ide/actionsOnSave/impl/ActionsOnSaveFileDocumentManagerListener.kt

88f2bff50


      
          private val EP_NAME = ExtensionPointName<ActionsOnSaveFileDocumentManagerListener.ActionOnSave>("com.intellij.actionOnSave")
          
          @ApiStatus.Internal
          class ActionsOnSaveFileDocumentManagerListener private constructor(private val project: Project) : FileDocumentManagerListener {
            /**
             * **Note:** If the Action on Save is going to update file contents, for example, to format a file on save,
             * then extend [DocumentUpdatingActionOnSave].
             * Unlike [ActionOnSave.processDocuments], which assumes modal progress,
             * [DocumentUpdatingActionOnSave.updateDocument] runs with cancelable background progress.
             */
            abstract class ActionOnSave {
              /**
               * Invoked in EDT, maybe inside write action. Should be fast. It's ok to return `true` and then do nothing in [processDocuments]
               *
               * @param project it's initialized, open, not disposed, and not the default one; no need to double-check in implementations
               */
              @RequiresReadLock
              open fun isEnabledForProject(project: Project): Boolean = false
          
              /**
               * **Note:** If the Action on Save is going to update file contents, for example, to format a file on save,

nik · June 23, 2026, 7:32am

Hi Joachim!

I’ll restore visibility of `ActionOnSave` (IJPL-248128), thank you for reporting!

In regard to API, this eap cycle is really bad. A lot of API is made internal even though there are obvious uses and extensions using it.

I’m sorry for that. When I was adding @ApiStatus.Internal annotation, I used information about usages from existing plugins on the Marketplace to avoid such problems. However, it appears that some corner cases (an inner class that has usages like here, or usages of inherited methods like in this case) usages weren’t found. I’ve already added some internal checks to help us not to repeat such mistakes.

jansorg · June 23, 2026, 7:38am

Thank you for your helpful reply!

nik · June 26, 2026, 6:21am

Hi Joachim!

The new IntelliJ IDEA 2026.2 EAP 8 should restore visibility for the cases reported by you. Also, I processed all other classes that were recently marked as internal and fixed a few other cases where they can be indirectly used via outer classes or subclasses. If you found something that is not fixed, please tell us about that. Thank you!

jansorg · June 26, 2026, 9:05am

Thank you. With the latest eap the plugin verifier did not complain, so it seems much better now.