feat: adding generic test files and necessary packages

Author: CDeltakai

package-lock.json

@@ -27,9 +27,19 @@
     "lint": "eslint '{src,tests,scripts,benches}/**/*.{js,mjs,ts,mts,jsx,tsx}'",
     "lintfix": "eslint '{src,tests,scripts,benches}/**/*.{js,mjs,ts,mts,jsx,tsx}' --fix",
     "lint-shell": "find ./src ./tests ./scripts -type f -regextype posix-extended -regex '.*\\.(sh)' -exec shellcheck {} +",
-    "docs": "shx rm -rf ./docs && typedoc --gitRevision master --tsconfig ./tsconfig.build.json --out ./docs src"
-  },
+    "docs": "shx rm -rf ./docs && typedoc --gitRevision master --tsconfig ./tsconfig.build.json --out ./docs src",
+    "test": "node ./scripts/test.mjs"
+    },
   "devDependencies": {
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "^3.9.0",
+    "@swc/jest": "^0.2.26",
+    "@types/jest": "^28.1.3",
+    "jest": "^28.1.1",
+    "jest-extended": "^3.0.1",
+    "jest-junit": "^14.0.0",
+    "jest-mock-process": "^2.0.0",
+    "ts-jest": "^28.0.5",
     "@eslint/compat": "^1.2.5",
     "@swc/core": "1.3.82",
     "@types/node": "^20.5.7",

package.json

@@ -0,0 +1,12 @@
+/* eslint-disable no-var */
+
+/// <reference types="jest-extended" />
+
+/**
+ * Follows the globals in jest.config.ts
+ * @module
+ */
+declare var projectDir: string;
+declare var testDir: string;
+declare var defaultTimeout: number;
+declare var maxTimeout: number;

tests/global.d.ts

@@ -0,0 +1,6 @@
+async function setup() {
+    // eslint-disable-next-line no-console
+    console.log('\nGLOBAL SETUP');
+  }
+  
+  export default setup;

tests/globalSetup.ts

@@ -0,0 +1,6 @@
+async function teardown() {
+    // eslint-disable-next-line no-console
+    console.log('GLOBAL TEARDOWN');
+  }
+  
+  export default teardown;

tests/globalTeardown.ts

@@ -0,0 +1,5 @@
+
+describe('index', () => {
+  test('some arbitrary test', () => {
+  });
+});

tests/index.test.ts

@@ -0,0 +1,5 @@
+import jest from "@jest/globals"
+// Default timeout per test
+// some tests may take longer in which case you should specify the timeout
+// explicitly for each test by using the third parameter of test function
+jest.setTimeout(globalThis.defaultTimeout);