Support Typescript 5.5 (#58)

Author: carlansley

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

@@ -7,10 +7,11 @@ on:
 
 jobs:
   checkPublished:
-    runs-on: ubuntu-latest
     name: Check Published
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout Code
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}
       - name: Check Published

.github/workflows/ci.yml

@@ -5,22 +5,30 @@ on:
     branches:
       - 'main'
 
+env:
+  CI: true
+
 jobs:
   pullRequestBuild:
     name: Pull Request Build
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [20.x, 21.x]
+        node-version: ['20.x', '22.x']
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout Code
+        uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
-      - name: Install dependencies
+      - name: Install Dependencies
         run: npm ci --ignore-scripts
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Prepare
+        run: npm run prepare
       - name: Compile
         run: npm run ci:compile
       - name: Check Code Style
@@ -31,22 +39,27 @@ jobs:
         run: npm run ci:test
 
   branchBuild:
-    runs-on: ubuntu-latest
     name: Branch Build
+    runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [20.x, 21.x]
+        node-version: ['20.x', '22.x']
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout Code
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
-      - name: Install dependencies
+      - name: Install Dependencies
         run: npm ci --ignore-scripts
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Prepare
+        run: npm run prepare
       - name: Compile
         run: npm run ci:compile
       - name: Check Code Style

.github/workflows/codeql-analysis.yml

@@ -21,11 +21,11 @@ jobs:
       matrix:
         language: ['javascript']
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
+      - name: Checkout code
+        uses: actions/checkout@v4
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v3
         with:
           languages: ${{ matrix.language }}
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v3

.github/workflows/publish-beta.yml

@@ -7,8 +7,8 @@ on:
 
 jobs:
   publishBeta:
-    runs-on: ubuntu-latest
     name: Publish Beta
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
         uses: actions/checkout@v4
@@ -23,6 +23,8 @@ jobs:
         uses: checkdigit/github-actions/check-label@main
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Check Imports
+        uses: checkdigit/github-actions/check-imports@main
       - name: Install latest npm
         run: npm install -g npm@latest
       - name: Install Dependencies
@@ -38,7 +40,7 @@ jobs:
         run: npm publish --tag beta
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN_PUBLISH }}
-      - name: Comment npm publish result
+      - name: Comment
         uses: checkdigit/github-actions/comment-npm-publish@main
         with:
           betaPackage: ${{ steps.prepare-beta.outputs.betaPackage }}

.github/workflows/publish.yml

@@ -12,14 +12,16 @@ jobs:
       id-token: write
     name: Publish to NPM
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
           node-version: '20.x'
           registry-url: 'https://registry.npmjs.org'
       - name: Install latest npm
         run: npm install -g npm@latest
-      - name: Install dependencies
+      - name: Install Dependencies
         run: npm ci --ignore-scripts
       - name: Audit Signatures
         run: npm audit signatures

README.md

@@ -10,9 +10,9 @@ This module contains the standard Check Digit Typescript configuration, along wi
 
 ### Typescript Configuration
 
-- currently requires Node 20.11 or above.
+- currently requires Node 20.13 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
+  up any issues with using newer features unavailable in a particular environment. Browsers and Node.js are fast-moving
   targets, and can add language features at any time.
 - uses the `module` type of `esnext`.
 - all compiler options set for maximum strictness.
@@ -24,7 +24,7 @@ It is intended to be used when publishing a package to NPM, or to bundle a packa
 It uses `tsc` for generating types, and `esbuild` for generating code.
 
 **Note:** 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.
+dynamic `require`s by CommonJS submodules. This is not a problem for Node.js, but will cause issues in a browser environment.
 
 #### Options
 

eslint.config.js

@@ -0,0 +1,86 @@
+// eslint.config.js
+
+import { promises as fs } from 'node:fs';
+
+import eslint from '@eslint/js';
+import typescriptEslint from 'typescript-eslint';
+import prettier from 'eslint-config-prettier';
+
+const ignores = [
+  ...(await fs.readFile('.gitignore', 'utf-8')).split('\n').filter((path) => path.trim() !== ''),
+  'eslint.config.js',
+];
+
+export default [
+  { ignores },
+  eslint.configs.all,
+  ...typescriptEslint.configs.recommended,
+  ...typescriptEslint.configs.recommendedTypeChecked,
+  ...typescriptEslint.configs.strict,
+  prettier,
+  {
+    languageOptions: {
+      parserOptions: {
+        project: './tsconfig.json',
+      },
+    },
+    rules: {
+      '@typescript-eslint/non-nullable-type-assertion-style': 'error',
+      'capitalized-comments': 'off',
+      'one-var': 'off',
+      'func-names': 'off',
+      'sort-keys': 'off',
+      'sort-imports': 'off',
+      'max-lines': [
+        'error',
+        {
+          max: 500,
+          skipBlankLines: true,
+          skipComments: true,
+        },
+      ],
+      'func-style': [
+        'error',
+        'declaration',
+        {
+          allowArrowFunctions: true,
+        },
+      ],
+      'no-magic-numbers': [
+        'error',
+        {
+          ignore: [0, 1, 2],
+        },
+      ],
+      'no-undefined': 'off',
+      'no-ternary': 'off',
+    },
+  },
+  {
+    files: ['**/*.spec.ts', '**/*.test.ts'],
+    rules: {
+      '@typescript-eslint/non-nullable-type-assertion-style': 'off',
+      '@typescript-eslint/ban-types': 'off',
+      '@typescript-eslint/require-await': 'off',
+      '@typescript-eslint/consistent-type-definitions': 'off',
+      '@typescript-eslint/ban-ts-comment': 'off',
+      '@typescript-eslint/no-unnecessary-condition': 'off',
+      '@typescript-eslint/consistent-indexed-object-style': 'off',
+      '@typescript-eslint/no-unused-vars': 'off',
+      '@typescript-eslint/no-unsafe-member-access': 'off',
+      'line-comment-position': 'off',
+      'no-fallthrough': 'off',
+      'no-inline-comments': 'off',
+      'no-param-reassign': 'off',
+      'id-length': 'off',
+      'no-magic-numbers': 'off',
+      'no-duplicate-imports': 'off',
+      'symbol-description': 'off',
+      'no-invalid-this': 'off',
+      'max-lines-per-function': 'off',
+      'max-lines': 'off',
+      'max-statements': 'off',
+      'no-await-in-loop': 'off',
+    },
+  },
+];