From 35bc0962b50b87933a6a9ecc0d21fb7cc2444d30 Mon Sep 17 00:00:00 2001
From: Dmitry Jemerov <yole@jetbrains.com>
Date: Thu, 5 Dec 2019 10:10:38 +0100
Subject: [PATCH] Stop teaching people to use components (#233)

- Replace documentation on writing components with documentation on migrating away from components
- Split documentation on extensions and extension points (extensions are always needed and EPs are quite uncommon)
- Add documentation on listeners
- Remove application and project components in sample plugins whenever possible
---
 plugin_sample/resources/META-INF/plugin.xml   | 25 --------------
 .../sample/DummyApplicationComponent.java     |  9 -----
 .../sample/DummyApplicationComponentImpl.java | 24 -------------
 .../sample/DummyProjectComponent.java         |  9 -----
 .../sample/DummyProjectComponentImpl.java     | 34 -------------------
 5 files changed, 101 deletions(-)
 delete mode 100644 plugin_sample/src/org/jetbrains/tutorials/sample/DummyApplicationComponent.java
 delete mode 100644 plugin_sample/src/org/jetbrains/tutorials/sample/DummyApplicationComponentImpl.java
 delete mode 100644 plugin_sample/src/org/jetbrains/tutorials/sample/DummyProjectComponent.java
 delete mode 100644 plugin_sample/src/org/jetbrains/tutorials/sample/DummyProjectComponentImpl.java

diff --git a/plugin_sample/resources/META-INF/plugin.xml b/plugin_sample/resources/META-INF/plugin.xml
index 72c398865..5e48764c7 100644
--- a/plugin_sample/resources/META-INF/plugin.xml
+++ b/plugin_sample/resources/META-INF/plugin.xml
@@ -28,31 +28,6 @@
   <!-- Resource bundle from which the text of plugin descriptions, action names and etc. will be loaded -->
   <resource-bundle>org.jetbrains.tutorials.sample.PluginSampleBundle</resource-bundle>
 
-  <!-- Plugin's application components -->
-  <application-components>
-    <component>
-      <!-- Component's interface class -->
-      <interface-class>org.jetbrains.tutorials.sample.DummyApplicationComponent</interface-class>
-      <!-- Component's implementation class -->
-      <implementation-class>org.jetbrains.tutorials.sample.DummyApplicationComponentImpl</implementation-class>
-    </component>
-  </application-components>
-
-  <!-- Plugin's project components -->
-  <project-components>
-    <component>
-      <!-- Interface and implementation classes are the same -->
-      <interface-class>org.jetbrains.tutorials.sample.DummyProjectComponent</interface-class>
-      <implementation-class>org.jetbrains.tutorials.sample.DummyProjectComponentImpl</implementation-class>
-      <!-- If the "workspace" option is set "true", the component saves its state to the .iws file
-        instead of the .ipr file.  Note that the <option> element is used only if the component implements the JDOMExternalizable interface. Otherwise, the use of the <option> element takes no effect.-->
-
-      <option name="workspace" value="true"/>
-      <!-- If the "loadForDefaultProject" tag is present, the project component is instantiated also for the default project. -->
-      <loadForDefaultProject/>
-    </component>
-  </project-components>
-
   <!-- Actions -->
   <actions>
     <!-- The <action> element defines an action to register.
diff --git a/plugin_sample/src/org/jetbrains/tutorials/sample/DummyApplicationComponent.java b/plugin_sample/src/org/jetbrains/tutorials/sample/DummyApplicationComponent.java
deleted file mode 100644
index 31b94247b..000000000
--- a/plugin_sample/src/org/jetbrains/tutorials/sample/DummyApplicationComponent.java
+++ /dev/null
@@ -1,9 +0,0 @@
-package org.jetbrains.tutorials.sample;
-
-import com.intellij.openapi.components.BaseComponent;
-
-/**
- * @author Anna Bulenkova
- */
-interface DummyApplicationComponent extends BaseComponent {
-}
diff --git a/plugin_sample/src/org/jetbrains/tutorials/sample/DummyApplicationComponentImpl.java b/plugin_sample/src/org/jetbrains/tutorials/sample/DummyApplicationComponentImpl.java
deleted file mode 100644
index 85c2bc07a..000000000
--- a/plugin_sample/src/org/jetbrains/tutorials/sample/DummyApplicationComponentImpl.java
+++ /dev/null
@@ -1,24 +0,0 @@
-package org.jetbrains.tutorials.sample;
-
-import org.jetbrains.annotations.NotNull;
-
-/**
- * @author Anna Bulenkova
- */
-public class DummyApplicationComponentImpl implements DummyApplicationComponent {
-  @Override
-  public void initComponent() {
-
-  }
-
-  @Override
-  public void disposeComponent() {
-
-  }
-
-  @NotNull
-  @Override
-  public String getComponentName() {
-    return "DummyApplicationComponent";
-  }
-}
diff --git a/plugin_sample/src/org/jetbrains/tutorials/sample/DummyProjectComponent.java b/plugin_sample/src/org/jetbrains/tutorials/sample/DummyProjectComponent.java
deleted file mode 100644
index 3713d6889..000000000
--- a/plugin_sample/src/org/jetbrains/tutorials/sample/DummyProjectComponent.java
+++ /dev/null
@@ -1,9 +0,0 @@
-package org.jetbrains.tutorials.sample;
-
-import com.intellij.openapi.components.ProjectComponent;
-
-/**
- * @author Anna Bulenkova
- */
-public interface DummyProjectComponent extends ProjectComponent {
-}
diff --git a/plugin_sample/src/org/jetbrains/tutorials/sample/DummyProjectComponentImpl.java b/plugin_sample/src/org/jetbrains/tutorials/sample/DummyProjectComponentImpl.java
deleted file mode 100644
index f7325927b..000000000
--- a/plugin_sample/src/org/jetbrains/tutorials/sample/DummyProjectComponentImpl.java
+++ /dev/null
@@ -1,34 +0,0 @@
-package org.jetbrains.tutorials.sample;
-
-import org.jetbrains.annotations.NotNull;
-
-/**
- * @author Anna Bulenkova
- */
-public class DummyProjectComponentImpl implements DummyProjectComponent {
-  @Override
-  public void projectOpened() {
-
-  }
-
-  @Override
-  public void projectClosed() {
-
-  }
-
-  @Override
-  public void initComponent() {
-
-  }
-
-  @Override
-  public void disposeComponent() {
-
-  }
-
-  @NotNull
-  @Override
-  public String getComponentName() {
-    return "DummyProjectComponent";
-  }
-}