From 6095dc02e55fd5c1e8dc555f2819d0008be5ce13 Mon Sep 17 00:00:00 2001
From: Mika Vilpas <mika.vilpas@gmail.com>
Date: Sat, 30 Nov 2024 21:07:37 +0200
Subject: [PATCH] docs: add a useful example for runExCommand

---
 packages/integration-tests/cypress/support/tui-sandbox.ts    | 3 +++
 packages/library/src/server/cypress-support/contents.test.ts | 3 +++
 packages/library/src/server/cypress-support/contents.ts      | 3 +++
 3 files changed, 9 insertions(+)

diff --git a/packages/integration-tests/cypress/support/tui-sandbox.ts b/packages/integration-tests/cypress/support/tui-sandbox.ts
index c7c32ad..8c144cc 100644
--- 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
index 0bf699b..5a81eaf 100644
--- 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
index dd56027..cbc1b0e 100644
--- 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>
     }
   }