Support typescript 5.2 (#41)

Author: carlansley

.github/workflows/check-pr-reviews.yml

@@ -8,9 +8,6 @@ jobs:
   checkPrReviews:
     runs-on: ubuntu-latest
     name: Check PR Reviews
-    strategy:
-      matrix:
-        node-version: [18.x]
     steps:
       - name: Perform Check of PR Reviews
         uses: checkdigit/github-actions/check-pr-reviews@main

.github/workflows/check-published-scheduled.yml

@@ -0,0 +1,22 @@
+name: Check Published
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '30 20 * * *'
+
+jobs:
+  checkPublished:
+    runs-on: ubuntu-latest
+    name: Check Published
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: Check Published
+        uses: checkdigit/github-actions/check-published@main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN_PUBLISH }}
+          DEBUG: '*'
+          SLACK_PUBLISH_MISMATCH: ${{ secrets.SLACK_PUBLISH_MISMATCH }}

.github/workflows/ci.yml

@@ -19,6 +19,10 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
+      - name: Check Label
+        uses: checkdigit/github-actions/check-label@main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Install dependencies
         run: npm ci --ignore-scripts
       - name: Audit Signatures
@@ -47,6 +51,10 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
+      - name: Check Label
+        uses: checkdigit/github-actions/check-label@main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Install dependencies
         run: npm ci --ignore-scripts
       - name: Audit Signatures

.github/workflows/publish-beta.yml

@@ -9,17 +9,14 @@ jobs:
   publishBeta:
     runs-on: ubuntu-latest
     name: Publish Beta
-    strategy:
-      matrix:
-        node-version: [18.x]
     steps:
       - uses: actions/checkout@v3
         with:
           ref: ${{ github.event.pull_request.head.sha }}
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v3
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version: '20.x'
           registry-url: 'https://registry.npmjs.org'
       - name: Install dependencies
         run: npm ci --ignore-scripts

.github/workflows/publish.yml

@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: '18.x'
+          node-version: '20.x'
           registry-url: 'https://registry.npmjs.org'
       - name: Install dependencies
         run: npm ci --ignore-scripts

.gitignore

@@ -1,37 +1,5 @@
-.DS_Store
-# Logs
-logs
-*.log
-npm-debug.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# IntelliJ
 .idea
-
-# Coverage directory used by tools like istanbul
 coverage
-
-# node-waf configuration
-.lock-wscript
-
-# Build directories
 build-*
-
-# Dependency directory
 node_modules
-
-# Optional npm cache directory
-.npm
-
-# Optional REPL history
-.node_repl_history
-
-# built commands
 bin

README.md

@@ -23,6 +23,9 @@ This module contains the standard Check Digit Typescript configuration, along wi
 to be used when publishing a package to NPM, or to bundle a package for deployment. It uses `tsc` for generating
 types, and `esbuild` for generating code.
 
+**Note:** if building an ESM bundle, the `require` function will be defined as a global variable, to allow
+dynamic `require`s by CommonJS submodules. This is not a problem for NodeJS, but will cause issues in a browser environment.
+
 #### Options
 
 - `--type` the type of output to generate. Defaults to `module` (ESM). Valid values are `commonjs`, `module` or `types`.
@@ -72,7 +75,8 @@ the new version of Typescript, and/or without emitting warnings during these tes
 
 Strict semver is a little complicated, as Typescript itself does not adhere to semver. So our "best effort" policy is:
 
-- Each update to the minimum Node target (e.g. Node 16 to Node 18) will result in a new major version of this module.
+- Each update to the minimum Node target (e.g. Node 18 to Node 20), or a change to a major compiler output option
+  (e.g. `module`, `target` or `moduleResolution`) 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.
@@ -96,18 +100,14 @@ Make sure your project's `tsconfig.json` extends `@checkdigit/typescript-config`
 
 ```
 {
-  "extends": "@checkdigit/typescript-config",
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "build"
-  },
-  "exclude": [
-    "node_modules",
-    "build"
-  ]
+  "extends": "@checkdigit/typescript-config"
 }
 ```
 
+Note this configuration has `moduleResolution` set to `bundler`. This requires that you use the `builder` command
+to produce working code for deployment. However, for simply running Jest tests, this is not necessary if
+used in conjunction with [`@checkdigit/jest-config`](https://github.com/checkdigit/jest-config).
+
 ## License
 
 MIT

SECURITY.md

@@ -6,8 +6,8 @@ These versions of `@checkdigit/typescript-config` are currently being supported
 
 | Version | Supported          |
 | ------- | ------------------ |
-| \>= 3.x | :white_check_mark: |
-| \< 3.0  | :x:                |
+| \>= 5.x | :white_check_mark: |
+| \< 5.0  | :x:                |
 
 ## Reporting a Vulnerability