docs: add documentation on how to build and use the mock editor compo…

…nent used in edit.integration.test.ts on Windows
jariikonen · Feb 10, 2025 · 9e233d1 · 9e233d1
1 parent 35a2c08
commit 9e233d1
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -70,3 +70,12 @@ Commands:
 
   help [command]                              display help for command
 ```
+
+## Running tests on Windows
+
+Integration tests use a mock editor component, which on Windows must be built by running the PowerShell script `src/tests/common/executable/buildMockEditor.ps1`.
+```
+cd .\src\tests\common\executable\
+.\buildMockEditor.ps1\
+```
+This creates a single executable application (SEA) using experimental Node.js functions. The SAE `mockEditor.exe` can sometimes output warnings like this `(node:25072) ExperimentalWarning: Single executable application is an experimental feature and might change at any time`, which make the tests using it fail. Therefore, the tests using the mock editor should set environment variable `NODE_NO_WARNINGS` (at least when run on Windows).
diff --git a/project-clock.pclock.json b/project-clock.pclock.json
@@ -972,7 +972,9 @@
       "end": "2025-02-10T08:25:34.693Z"
     },
     {
-      "subject": "Add documentation on how to build the mockeditor.exe on Windows"
+      "subject": "Add documentation on how to build the mockeditor.exe on Windows",
+      "begin": "2025-02-10T08:28:45.915Z",
+      "end": "2025-02-10T08:44:29.285Z"
     },
     {
       "subject": "Make reorder command print the reordered list"