@checkdigit/typescript-config 2.1.0 → 3.0.1

package/.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+    - "main"
+
+jobs:
+  branchBuild:
+    runs-on: ubuntu-latest
+    name: Branch Build
+    strategy:
+      matrix:
+        node-version: [16.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 }}
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm ci
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          CI: true
+      - name: Compile
+        run: npm run ci:compile
+        env:
+          CI: true
+      - name: Check Code Style
+        run: npm run ci:style
+        env:
+          CI: true
+      - name: Run Tests
+        run: npm run ci:test
+        env:
+          CI: true

package/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2021 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

@@ -1,15 +1,17 @@
 # checkdigit/typescript-config 
 
 [![MIT License](https://img.shields.io/github/license/checkdigit/typescript-config)](https://github.com/checkdigit/typescript-config/blob/master/LICENSE.txt)
-[![David](https://status.david-dm.org/gh/checkdigit/typescript-config.svg)](https://status.david-dm.org/gh/checkdigit/typescript-config.svg)
 
-Copyright (c) 2021 [Check Digit, LLC](https://checkdigit.com)
+Copyright (c) 2022 [Check Digit, LLC](https://checkdigit.com)
 
 ### Introduction
 
 This module contains the standard Check Digit Typescript configuration.
-- requires Node 14 or above
-- emits ES2020
+- requires Node 16 or above
+- emits ES2022
+- uses the new tsconfig `module` type of `node16`.  This specifies that whether commonjs or ESM is emitted is dependent
+  on the value of the `type` field in `package.json`.  If not supplied, the default value is `commonjs`.
+  Set `"type": "module"` to emit ESM.
 - all compiler options set for maximum strictness
 
 #### A note about versioning
@@ -27,10 +29,11 @@ Bear in mind, any update of Typescript can potentially break your build.  But ho
 ### Installation
 
 ```
-npm add -D typescript
 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`.
+
 Make sure your project's `tsconfig.json` extends `@checkdigit/typescript-config`.
 
 ### Example `tsconfig.json`

package/package.json

@@ -1,19 +1,14 @@
 {
   "name": "@checkdigit/typescript-config",
-  "version": "2.1.0",
+  "version": "3.0.1",
   "description": "Check Digit standard Typescript configuration",
-  "scripts": {
-    "prepublishOnly": "publish",
-    "postpublish": "rimraf dist .npmignore",
-    "preversion": "npm test",
-    "postversion": "git push && git push --tags",
-    "test": "rimraf build && tsc && test -f build/index.js && test -f build/index.d.ts && test -f build/index.js.map"
-  },
+  "prettier": "@checkdigit/prettier-config",
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "peerDependencies": {
-    "typescript": ">=4.3.2"
+    "typescript": ">=4.7.4",
+    "@types/node": ">=16"
   },
   "repository": {
     "type": "git",
@@ -25,9 +20,18 @@
     "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 'src/**/*.ts'",
+    "prettier:fix": "prettier --write 'src/**/*.ts'",
+    "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/publish": "^1.0.19",
-    "rimraf": "^3.0.2",
-    "typescript": "4.3.2"
+    "@checkdigit/prettier-config": "2.1.0",
+    "rimraf": "^3.0.2"
   }
 }

package/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
-    "module": "commonjs",
-    "target": "es2020",
+    "module": "node16",
+    "target": "es2022",
     "lib": ["esnext", "dom", "webworker"],
     "sourceMap": true,
     "outDir": "build",
@@ -27,7 +27,9 @@
     "noUncheckedIndexedAccess": true,
     "noPropertyAccessFromIndexSignature": true,
     "allowUnusedLabels": false,
-    "noImplicitOverride": true
+    "noImplicitOverride": true,
+    "useUnknownInCatchVariables": true,
+    "exactOptionalPropertyTypes": true
   },
   "exclude": [
     "node_modules",

package/dist/index.js

@@ -1 +0,0 @@
-"use strict";