docs: add a useful example for runExCommand

mikavilpas · Nov 30, 2024 · 6095dc0 · 6095dc0
1 parent d999361
commit 6095dc0
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/packages/integration-tests/cypress/support/tui-sandbox.ts b/packages/integration-tests/cypress/support/tui-sandbox.ts
@@ -91,6 +91,9 @@ declare global {
 
       runLuaCode(input: LuaCodeClientInput): Chainable<RunLuaCodeOutput>
 
+      /** Run an ex command in neovim.
+       * @example "echo expand('%:.')" current file, relative to the cwd
+       */
       runExCommand(input: ExCommandClientInput): Chainable<RunExCommandOutput>
     }
   }

diff --git a/packages/library/src/server/cypress-support/contents.test.ts b/packages/library/src/server/cypress-support/contents.test.ts
@@ -96,6 +96,9 @@ it("should return the expected contents", async () => {
 
           runLuaCode(input: LuaCodeClientInput): Chainable<RunLuaCodeOutput>
 
+          /** Run an ex command in neovim.
+           * @example "echo expand('%:.')" current file, relative to the cwd
+           */
           runExCommand(input: ExCommandClientInput): Chainable<RunExCommandOutput>
         }
       }

diff --git a/packages/library/src/server/cypress-support/contents.ts b/packages/library/src/server/cypress-support/contents.ts
@@ -99,6 +99,9 @@ declare global {
 
       runLuaCode(input: LuaCodeClientInput): Chainable<RunLuaCodeOutput>
 
+      /** Run an ex command in neovim.
+       * @example "echo expand('%:.')" current file, relative to the cwd
+       */
       runExCommand(input: ExCommandClientInput): Chainable<RunExCommandOutput>
     }
   }