@checkdigit/typescript-config 3.3.0-PR.30-e4fc → 3.3.0-PR.30-0c40

package/README.md

@@ -8,20 +8,39 @@ Copyright (c) 2022-2023 [Check Digit, LLC](https://checkdigit.com)
 
 This module contains the standard Check Digit Typescript configuration.
 
-- requires Node 16 or above
-- emits ES2022
+- currently requires Node 16 or above.
+- emits `esnext`, with the default libraries, to avoid down-leveling. It is intended that application spec tests pick
+  up any issues with using newer features unavailable in a particular environment. Browsers and NodeJS are fast moving
+  targets, and can add language features at any time.
 - uses the `module` type of `commonjs`.
-- all compiler options set for maximum strictness
+- all compiler options set for maximum strictness.
 
-#### A note about versioning
+### Tests
+
+This module includes a number of integration-style tests, to ensure that a specific version of Typescript will interoperate
+with various bundlers, libraries and frameworks used by Check Digit:
+
+- Jest and `ts-jest`
+- `node:test`
+- prettier
+- tsc
+- swc
+- esbuild
+
+We do this to ensure that Typescript upgrades do not break things. New major versions of Typescript are not immediately
+supported by projects such as ts-jest, eslint, prettier, etc. Our policy is to wait until these projects fully support
+the new version of Typescript, and/or without emitting warnings during these tests, before publishing.
+
+### A note about versioning
 
 Strict semver is a little complicated, as Typescript itself does not adhere to semver. So our "best effort" policy is:
 
-- Each new target (e.g. `ES2019` to `ES2020`) will result in a new major version of this module. We coordinate this
-  with whatever the latest LTS version of Node is currently supported by Amazon Lambda, Google Cloud Functions
+- Each update to the minimum Node target (e.g. Node 16 to Node 18) will result in a new major version of this module.
+  We coordinate this with whatever the latest LTS version of Node is currently supported by Amazon Lambda, Google Cloud Functions
   and Azure Functions.
-- Each new major version of Typescript (e.g. `4.2.x` to `4.3.x`) will result in a new minor version of this module.
-- Each new minor update of Typescript (e.g. `4.3.1` to `4.3.2`) will result in a new patch version of this module.
+- Each new "major" version of Typescript (e.g. `4.2.x` to `4.3.x`) will result in a new minor version of this module.
+- A new minor update of Typescript (e.g. `4.3.1` to `4.3.2`) _may_ result in a patch, in
+  a situation where a specific need or issue requires setting a new minimum version of Typescript.
 
 Bear in mind, any update of Typescript can potentially break your build. But hopefully in a way that's useful.
 
@@ -31,7 +50,8 @@ Bear in mind, any update of Typescript can potentially break your build. But hop
 npm add -D @checkdigit/typescript-config
 ```
 
-Note: you do not need to explicitly install Typescript itself, as it comes in as a peer dependency of `@checkdigit/typescript-config`.
+Note: you do not need to explicitly install Typescript itself, as the most recent supported version comes in as a
+peer dependency of `@checkdigit/typescript-config`.
 
 Make sure your project's `tsconfig.json` extends `@checkdigit/typescript-config`.
 

package/package.json

@@ -1 +1 @@
-{"name":"@checkdigit/typescript-config","version":"3.3.0-PR.30-e4fc","description":"Check Digit standard Typescript configuration","prettier":"@checkdigit/prettier-config","engines":{"node":">=16"},"peerDependencies":{"@types/node":">=16","typescript":">=5.0.4 <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/*.ts ./src/*/*.ts --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","ci:style":"npm run prettier"},"devDependencies":{"@checkdigit/prettier-config":"^3.4.0","@swc/cli":"^0.1.62","@swc/core":"^1.3.50","@types/jest":"^29.5.0","esbuild":"^0.17.16","get-port":"^6.1.2","got":"11.8.6","jest":"^29.5.0","rimraf":"^5.0.0","ts-jest":"^29.1.0"},"jest":{"extensionsToTreatAsEsm":[".mts"],"transform":{"^.+\\.ts$":["ts-jest",{"isolatedModules":true,"diagnostics":false,"useESM":false}]},"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.30-0c40","description":"Check Digit standard Typescript configuration","prettier":"@checkdigit/prettier-config","engines":{"node":">=16"},"peerDependencies":{"@types/node":">=16","typescript":">=5.0.4 <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/*.ts ./src/*/*.ts --platform=node --bundle --format=cjs --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 && node --test build/*.spec.js build/*/*.spec.js && node --test build-es/*.spec.js build-es/*/*.spec.js","ci:compile":"npm run build-tsc && npm run build-es","ci:style":"npm run prettier"},"devDependencies":{"@checkdigit/prettier-config":"^3.4.0","@swc/cli":"^0.1.62","@swc/core":"^1.3.50","@types/jest":"^29.5.0","esbuild":"^0.17.16","get-port":"^6.1.2","got":"11.8.6","jest":"^29.5.0","rimraf":"^5.0.0","ts-jest":"^29.1.0"},"jest":{"extensionsToTreatAsEsm":[".mts"],"transform":{"^.+\\.ts$":["ts-jest",{"isolatedModules":true,"diagnostics":false,"useESM":false}]},"collectCoverageFrom":["<rootDir>/src/**","!<rootDir>/src/**/*.spec.ts","!<rootDir>/src/**/*.test.ts"],"testMatch":["<rootDir>/src/**/*.spec.ts"]},"files":["tsconfig.json","SECURITY.md","/src/"]}

package/src/describe-it.ts

@@ -0,0 +1,11 @@
+// describe-it.ts
+
+import { describe as nodeDescribe, it as nodeIt } from 'node:test';
+
+/**
+ * If we're running inside a Jest environment, "describe" and "it" will be defined globally.  If not, we fall back to
+ * the built-in node.js test runner.
+ */
+
+export const describe = globalThis.describe ?? nodeDescribe;
+export const it = globalThis.it ?? nodeIt;