@checkdigit/typescript-config 3.2.0-PR.23-1083 → 3.3.0-PR.29-5bac

package/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2021-2023 Check Digit, LLC
+Copyright (c) 2021-2022 Check Digit, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -8,10 +8,9 @@ Copyright (c) 2022-2023 [Check Digit, LLC](https://checkdigit.com)
 
 This module contains the standard Check Digit Typescript configuration.
 
-- requires Node 18 or above
+- requires Node 16 or above
 - emits ES2022
-- uses `esnext` for `target` and `module`
-- uses the `moduleResoltion` of `bundler`
+- uses the `module` type of `commonjs`.
 - all compiler options set for maximum strictness
 
 #### A note about versioning

package/package.json

@@ -1 +1 @@
-{"name":"@checkdigit/typescript-config","version":"3.2.0-PR.23-1083","description":"Check Digit standard Typescript configuration","prettier":"@checkdigit/prettier-config","engines":{"node":">=18"},"type":"module","peerDependencies":{"@types/node":">=18","typescript":">=5.0.2 <5.1"},"repository":{"type":"git","url":"git+https://github.com/checkdigit/typescript-config.git"},"author":"Check Digit, LLC","license":"MIT","bugs":{"url":"https://github.com/checkdigit/typescript-config/issues"},"homepage":"https://github.com/checkdigit/typescript-config#readme","scripts":{"preversion":"npm test","postversion":"git push && git push --tags","prettier":"prettier --ignore-path .gitignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --write .","test":"npm run ci:compile && npm run ci:test && npm run ci:style","build-tsc":"rimraf build && tsc","build-es":"rimraf build-es && esbuild ./src/* --platform=node --bundle --format=esm --sourcemap=inline --outdir=build-es","build-swc":"rimraf build-swc && swc ./src -d ./build-swc","ci:test":"NODE_OPTIONS=\"--no-warnings --experimental-vm-modules\" jest --coverage=false","ci:compile":"npm run build-tsc && npm run build-es && npm run build-swc","ci:style":"npm run prettier"},"devDependencies":{"@checkdigit/prettier-config":"^3.3.0","@swc/cli":"^0.1.62","@swc/core":"^1.3.42","@types/jest":"^29.5.0","esbuild":"^0.17.14","get-port":"^6.1.2","got":"11.8.6","jest":"^29.5.0","rimraf":"^4.4.1","ts-jest":"^29.0.5"},"jest":{"extensionsToTreatAsEsm":[".ts"],"transform":{"^.+\\.ts$":["ts-jest",{"isolatedModules":true,"diagnostics":false,"useESM":true}]},"collectCoverageFrom":["<rootDir>/src/**","!<rootDir>/src/**/*.spec.ts","!<rootDir>/src/**/*.test.ts"],"testMatch":["<rootDir>/src/**/*.spec.ts"]},"files":["tsconfig.json","SECURITY.md","/src/"]}
+{"name":"@checkdigit/typescript-config","version":"3.3.0-PR.29-5bac","description":"Check Digit standard Typescript configuration","prettier":"@checkdigit/prettier-config","engines":{"node":">=16"},"peerDependencies":{"@types/node":">=16","typescript":">=5.0.2 <5.1"},"repository":{"type":"git","url":"git+https://github.com/checkdigit/typescript-config.git"},"author":"Check Digit, LLC","license":"MIT","bugs":{"url":"https://github.com/checkdigit/typescript-config/issues"},"homepage":"https://github.com/checkdigit/typescript-config#readme","scripts":{"preversion":"npm test","postversion":"git push && git push --tags","prettier":"prettier --list-different .","prettier:fix":"prettier --write .","test":"npm run ci:compile && npm run ci:test && npm run ci:style","ci:compile":"tsc --noEmit","ci:test":"tsc && node build/index.js | grep -q 'complete' && rimraf build","ci:style":"npm run prettier"},"devDependencies":{"@checkdigit/prettier-config":"^3.3.0","rimraf":"^4.4.0"},"files":["tsconfig.json","SECURITY.md","/src/"]}

package/src/index.ts

@@ -0,0 +1,135 @@
+// index.ts
+
+import { strict as assert } from 'node:assert';
+
+/**
+ * Check for Typescript 4.4 features
+ */
+
+interface SymbolIndexSignature44 {
+  [name: symbol]: number;
+}
+
+assert.ok({} as SymbolIndexSignature44);
+
+interface Person44 {
+  name: string;
+  age?: number;
+}
+
+// @ts-expect-error
+const person: Person44 = {
+  name: 'Bob',
+  age: undefined, // errors with exactOptionalPropertyTypes = true.
+};
+
+try {
+  console.log('hello');
+} catch (error) {
+  // @ts-expect-error
+  console.error(err.message); // errors with useUnknownInCatchVariables = true
+}
+
+/**
+ * Check for Typescript 4.5 features
+ */
+
+// type modifiers on import names
+import { ok, type AssertPredicate } from 'node:assert';
+
+ok({} as AssertPredicate);
+
+// Awaited type
+ok({} as Awaited<Promise<string>>);
+
+// template string types as discriminants
+interface Success45 {
+  type: `${string}Success`;
+  body: string;
+}
+
+interface Error45 {
+  type: `${string}Error`;
+  message: string;
+}
+
+function handler45(r: Success45 | Error45) {
+  if (r.type === 'HttpSuccess') {
+    // 'r' has type 'Success'
+    assert.ok(r.body);
+  }
+}
+handler45({ type: 'HttpSuccess', body: 'Hello' });
+
+/**
+ * Check for Typescript 4.6 features
+ */
+
+// control flow analysis for destructured discriminated unions
+type Action46 = { kind: 'NumberContents'; payload: number } | { kind: 'StringContents'; payload: string };
+
+function processAction46(action: Action46) {
+  const { kind, payload } = action;
+  if (kind === 'NumberContents') {
+    assert.ok(payload * 2);
+  } else if (kind === 'StringContents') {
+    assert.ok(payload.trim());
+  }
+}
+assert.equal(processAction46({ kind: 'NumberContents', payload: 5 }), undefined);
+
+/**
+ * Check for Typescript 4.7 features
+ */
+
+// control-flow analysis for bracketed element access
+const key = Symbol();
+const numberOrString = Math.random() < 0.5 ? 42 : 'hello';
+const obj = {
+  [key]: numberOrString,
+};
+if (typeof obj[key] === 'string') {
+  assert.ok(obj[key].toUpperCase()); // 4.7 knows that obj[key] is a string
+}
+
+/**
+ * Check for Typescript 4.8 features
+ */
+
+// improved intersection reduction, union compatibility, and narrowing
+function f48(x: unknown, y: {} | null | undefined) {
+  x = y;
+  y = x; // works in 4.8
+  assert.equal(x, y);
+}
+f48(null, undefined);
+
+function foo48<T>(x: NonNullable<T>, y: NonNullable<NonNullable<T>>) {
+  x = y;
+  y = x; // works in 4.8
+  assert.equal(x, y);
+}
+foo48<string>('hello', 'world');
+
+function throwIfNullable48<T>(value: T): NonNullable<T> {
+  if (value === undefined || value === null) {
+    throw Error('Nullable value!');
+  }
+  return value; // works in 4.8
+}
+assert.equal(throwIfNullable48(42), 42);
+
+/**
+ * Check for Typescript 4.9 features
+ */
+type Colors49 = 'red' | 'green' | 'blue';
+type RGB49 = [red: number, green: number, blue: number];
+const palette49 = {
+  red: [255, 0, 0],
+  green: '#00ff00',
+  // @ts-expect-error
+  bleu: [0, 0, 255], //  typo is now caught
+} satisfies Record<Colors49, string | RGB49>;
+assert.equal(typeof palette49, 'object');
+
+console.log('complete');

package/tsconfig.json

@@ -1,8 +1,7 @@
 {
   "compilerOptions": {
-    "target": "esnext",
-    "module": "esnext",
-    "moduleResolution": "bundler",
+    "module": "commonjs",
+    "target": "es2022",
     "lib": ["esnext", "dom", "webworker"],
     "sourceMap": true,
     "inlineSources": true,
@@ -19,13 +18,12 @@
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "alwaysStrict": true,
-    "verbatimModuleSyntax": true,
+    "verbatimModuleSyntax": false,
     "noFallthroughCasesInSwitch": true,
     "forceConsistentCasingInFileNames": true,
     "emitDecoratorMetadata": true,
     "experimentalDecorators": true,
     "resolveJsonModule": true,
-    "esModuleInterop": true,
     "noUncheckedIndexedAccess": true,
     "noPropertyAccessFromIndexSignature": true,
     "allowUnusedLabels": false,

package/src/module-directory/index.ts

@@ -1,3 +0,0 @@
-// module-directory/index.ts
-
-export default () => 'module-directory-index';

package/src/module.ts

@@ -1,9 +0,0 @@
-// module.ts
-
-export function test() {
-  return 'export function test';
-}
-
-export default function () {
-  return 'export default function';
-}