Add documentation

JetBrains · lippfi · Aug 24, 2024 · Aug 28, 2024 · Aug 29, 2024 · Aug 29, 2024
commit 5f19d7b4b9cff1ced3e4fd2be86e2a40d9cea24e
diff --git a/vim-engine/src/test/kotlin/com/maddyhome/idea/vim/model/EmptyTestCase.kt b/vim-engine/src/test/kotlin/com/maddyhome/idea/vim/model/EmptyTestCase.kt
@@ -0,0 +1,18 @@
+/*
+ * Copyright 2003-2024 The IdeaVim authors
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE.txt file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+package com.maddyhome.idea.vim.model
+
+/**
+ * A stub that can be placed in the [SharedTestCaseList] to resolve compilation issues
+ * when there's insufficient time or ability to implement a proper test case.
+ * This class can be used to temporarily stub unimplemented functionality in cases where,
+ * due to varying development speeds, one of the IDEs hasn't fully implemented vim-engine features.
+ * It serves as a placeholder, allowing compilation to succeed while marking areas that need future attention.
+ */
+class EmptyTestCase : SharedTestCase
diff --git a/vim-engine/src/test/kotlin/com/maddyhome/idea/vim/model/SharedTestCase.kt b/vim-engine/src/test/kotlin/com/maddyhome/idea/vim/model/SharedTestCase.kt
@@ -0,0 +1,14 @@
+/*
+ * Copyright 2003-2024 The IdeaVim authors
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE.txt file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+package com.maddyhome.idea.vim.model
+
+/**
+ * Test class without IDE-specific functionality that should be run in all IDEs
+ */
+interface SharedTestCase
diff --git a/vim-engine/src/test/kotlin/com/maddyhome/idea/vim/model/SharedTestCaseList.kt b/vim-engine/src/test/kotlin/com/maddyhome/idea/vim/model/SharedTestCaseList.kt
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2003-2024 The IdeaVim authors
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE.txt file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+package com.maddyhome.idea.vim.model
+
+/**
+ * List of all shared test classes.
+ * Every IDE (Fleet, IJ-based, etc.) should have a successor to this class in its test files.
+ * When a new test is added to vim-engine (and listed in this class), compilation of tests in all IDEs will fail,
+ * requiring developers of the Vim plugin for each IDE to take action and implement the missing test.
+ * This class doesn't run any tests; it only declares them.
+ * Compilation errors resulting from this class will help IDE developers understand whether they have implemented all the vim-engine tests.
+ */
+abstract class SharedTestCaseList {
+}
diff --git a/vim-engine/src/test/kotlin/com/maddyhome/idea/vim/model/VimTestCase.kt b/vim-engine/src/test/kotlin/com/maddyhome/idea/vim/model/VimTestCase.kt
@@ -23,7 +23,7 @@ import javax.swing.KeyStroke
 import kotlin.test.assertNull
 import kotlin.test.assertContains
 
-interface VimTestCase {
+interface VimTestCase : SharedTestCase {
   val editor: VimEditor
 
   fun <T> assertEmpty(collection: Collection<T>) {