✨✅ add tsconfigs & tests

Author: dudeofawesome

typescript-configs/.gitignore

@@ -0,0 +1 @@
+dist/

typescript-configs/README.md

@@ -0,0 +1,32 @@
+# @dudeofawesome/typescript-configs
+
+My set of tsc config files
+
+## Usage
+
+1. Install this config plugin as a dev dependency.
+
+    ```sh
+    npm i -D @dudeofawesome/eslint-config-typescript
+    ```
+
+1. Pick the appropriate config to base yours on.
+1. Create your `tsconfig.json`.
+
+    ```json
+    {
+        "extends": "./node.json"
+    }
+    ```
+
+1. Set your `include` and `exclude` paths.
+
+    Here's an example of something that might work for you:
+
+    ```json
+    {
+        ...
+        "include": ["src/"],
+        "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+    }
+    ```

typescript-configs/base.json

@@ -6,9 +6,11 @@
     // input
     "skipLibCheck": false, // TODO: do we actually want false?
     "allowJs": true,
+    "checkJs": true,
     "incremental": true,
-    "forceConsistentCasingInFileNames": false,
+    "forceConsistentCasingInFileNames": true,
     "resolveJsonModule": true,
+    "lib": ["ES2022"],
 
     // output
     "declaration": true,
@@ -34,7 +36,5 @@
     // "strictPropertyInitialization": true,
     "useUnknownInCatchVariables": true,
     "noUncheckedIndexedAccess": true // TODO: can we actually do this?
-  },
-  "include": ["src/"],
-  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+  }
 }

typescript-configs/browser.json

@@ -1,3 +1,7 @@
 {
-  "extends": "./base.json"
+  "extends": "./base.json",
+  "compilerOptions": {
+    "lib": ["DOM"],
+    "target": "ES2019" // TODO: what browsers do we want to support?
+  }
 }

typescript-configs/jest.json

@@ -1,3 +1 @@
-{
-  "extends": "./base.json"
-}
+{}

typescript-configs/library.json

@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true
+  }
+}

typescript-configs/package.json

@@ -15,13 +15,16 @@
   "license": "MIT",
   "main": "base.json",
   "scripts": {
-    "test": "# node --require ts-node/register --test test/index.ts"
+    "test": "node --require ts-node/register --test test/index.ts"
   },
   "peerDependencies": {
     "typescript": "^5.0.0, <=5.2.0"
   },
   "devDependencies": {
+    "@types/jest": "^29.5.5",
     "@types/node": "^20.6.3",
-    "ts-node": "^10.9.1"
+    "@types/react": "^18.2.23",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.0, <=5.2.0"
   }
 }

typescript-configs/react.json

@@ -0,0 +1,5 @@
+{
+  "compilerOptions": {
+    "jsx": "react"
+  }
+}

typescript-configs/test/index.ts

@@ -0,0 +1,112 @@
+import { describe, it } from 'node:test';
+import { deepEqual, strictEqual, match } from 'node:assert';
+import { exec as execCallback } from 'node:child_process';
+import { promisify } from 'node:util';
+import { basename, join } from 'node:path';
+import { readFile } from 'node:fs/promises';
+
+const exec = promisify(execCallback);
+
+describe('typescript-configs', () => {
+  describe('jest', async () => {
+    await transpile_and_test({ dir: 'jest', code_fragment: 'function foo()' });
+    await transpile_and_test({
+      dir: 'jest',
+      ts_config: 'tsconfig.test.json',
+      output_files: [
+        'index.js',
+        'index.js.map',
+        'index.d.ts',
+        'index.spec.js',
+        'index.spec.js.map',
+        'index.spec.d.ts',
+      ],
+      search_file: 'test/index.spec.js',
+      code_fragment: 'expect',
+    });
+  });
+
+  describe('library', async () => {
+    await transpile_and_test({
+      dir: 'library',
+      output_files: [
+        'index.js',
+        'index.js.map',
+        'index.d.ts',
+        'index.d.ts.map',
+      ],
+      code_fragment: `return 'bar'`,
+    });
+  });
+
+  describe('node', async () => {
+    await transpile_and_test({
+      dir: 'node',
+      code_fragment: 'process.env.PATH',
+    });
+  });
+
+  describe('react', async () => {
+    await transpile_and_test({
+      dir: 'react',
+      code_fragment: 'window.location.href',
+    });
+  });
+});
+
+interface TranspileAndTestOpts {
+  dir: string;
+  ts_config?: string;
+  output_files?: string[];
+  search_file?: string;
+  code_fragment?: string;
+}
+async function transpile_and_test({
+  dir,
+  ts_config = 'tsconfig.json',
+  output_files = ['index.js', 'index.js.map', 'index.d.ts'],
+  search_file = 'index.js',
+  code_fragment,
+}: TranspileAndTestOpts): Promise<{
+  stdout: string;
+  stderr: string;
+}> {
+  const cwd = join(__dirname, dir);
+  const out_dir = join(cwd, 'dist');
+  const out = await exec(
+    `tsc --project "${ts_config}" --outDir "${out_dir}" --incremental false --listEmittedFiles`,
+    {
+      cwd,
+      env: {
+        ...process.env,
+        // prevent debugging TSC
+        NODE_OPTIONS: undefined,
+      },
+    },
+  );
+
+  it('should not output any errors', () => {
+    strictEqual(out.stderr, '');
+  });
+
+  it('should create transpiled files', () => {
+    deepEqual(
+      out.stdout
+        .split('\n')
+        .filter(Boolean)
+        .map((line) => basename(line.split('TSFILE: ')[1])),
+      output_files,
+    );
+  });
+
+  if (code_fragment != null) {
+    it('should contain some expected code', async () => {
+      match(
+        (await readFile(join(out_dir, search_file))).toString(),
+        new RegExp(code_fragment),
+      );
+    });
+  }
+
+  return out;
+}

typescript-configs/test/jest/src/index.ts

@@ -0,0 +1,3 @@
+export function foo(): string {
+  return 'bar';
+}