chore: added placeholder tests

Author: aryanjassal

package.json

@@ -32,8 +32,7 @@
     "lint": "eslint '{src,tests,scripts,benches}/**/*.{js,ts}'",
     "lintfix": "eslint '{src,tests,scripts,benches}/**/*.{js,ts}' --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",
-    "bench": "shx rm -rf ./benches/results && ts-node ./benches"
+    "docs": "shx rm -rf ./docs && typedoc --gitRevision master --tsconfig ./tsconfig.build.json --out ./docs src"
   },
   "dependencies": {
     "@matrixai/logger": "^4.0.3",

src/index.ts

@@ -1 +1 @@
-// todo
+// Starting project soon ™

tests/global.d.ts

@@ -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/globalSetup.ts

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

tests/globalTeardown.ts

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

tests/index.test.ts

@@ -0,0 +1,5 @@
+describe('index', () => {
+  test('test', () => {
+    expect(true).toBeTruthy();
+  });
+});

tests/setup.ts

@@ -0,0 +1,4 @@
+// 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);