tests: add comment of addon tests

versatica · May 22, 2024 · e80a59e · e80a59e
1 parent b3044ad
commit e80a59e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/node/src/workerChannel/src/test.ts b/node/src/workerChannel/src/test.ts
@@ -1,3 +1,10 @@
+/**
+ * NOTE: These tests are to be run locally only, if needed.
+ * When running them within a testing environment (jest|node) the native addon
+ * handle will remain open and the test process won't terminate, making any
+ * CI process fail.
+ */
+
 import assert = require('node:assert');
 import { beforeEach, describe, it } from 'node:test';
 

diff --git a/node/tsconfig.json b/node/tsconfig.json
@@ -10,7 +10,7 @@
 		"declaration": true,
 		"declarationMap": true
 	},
-	"include": ["src", "workerChannel/src"],
+	"include": ["src"],
 	"watchOptions": {
 		"watchFile": "useFsEvents",
 		"watchDirectory": "useFsEvents",