@checkdigit/typescript-config 3.0.1 → 3.1.0

package/README.md

@@ -1,4 +1,4 @@
-# checkdigit/typescript-config 
+# checkdigit/typescript-config
 
 [![MIT License](https://img.shields.io/github/license/checkdigit/typescript-config)](https://github.com/checkdigit/typescript-config/blob/master/LICENSE.txt)
 
@@ -7,24 +7,23 @@ Copyright (c) 2022 [Check Digit, LLC](https://checkdigit.com)
 ### Introduction
 
 This module contains the standard Check Digit Typescript configuration.
+
 - 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.
+- uses the `module` type of `commonjs`.
 - all compiler options set for maximum strictness
 
 #### A note about versioning
 
-Strict semver is a little complicated, as Typescript itself does not adhere to semver.  So our "best effort" policy is:
+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
+- 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
   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.
 
-Bear in mind, any update of Typescript can potentially break your build.  But hopefully in a way that's useful.
+Bear in mind, any update of Typescript can potentially break your build. But hopefully in a way that's useful.
 
 ### Installation
 
@@ -47,8 +46,7 @@ Make sure your project's `tsconfig.json` extends `@checkdigit/typescript-config`
   },
   "exclude": [
     "node_modules",
-    "build",
-    "dist"
+    "build"
   ]
 }
 ```

package/SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+These versions of `@checkdigit/typescript-config` are currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| \>= 3.x | :white_check_mark: |
+| \< 3.0  | :x:                |
+
+## Reporting a Vulnerability
+
+Please create an issue at https://github.com/checkdigit/typescript-config/issues

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@checkdigit/typescript-config",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "Check Digit standard Typescript configuration",
   "prettier": "@checkdigit/prettier-config",
   "engines": {
     "node": ">=16"
   },
   "peerDependencies": {
-    "typescript": ">=4.7.4",
-    "@types/node": ">=16"
+    "@types/node": ">=16",
+    "typescript": ">=4.8.2"
   },
   "repository": {
     "type": "git",
@@ -23,15 +23,19 @@
   "scripts": {
     "preversion": "npm test",
     "postversion": "git push && git push --tags",
-    "prettier": "prettier --list-different 'src/**/*.ts'",
-    "prettier:fix": "prettier --write 'src/**/*.ts'",
+    "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": "2.1.0",
+    "@checkdigit/prettier-config": "^3.0.0",
     "rimraf": "^3.0.2"
-  }
+  },
+  "files": [
+    "tsconfig.json",
+    "SECURITY.md"
+  ]
 }

package/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "module": "node16",
+    "module": "commonjs",
     "target": "es2022",
     "lib": ["esnext", "dom", "webworker"],
     "sourceMap": true,
@@ -31,9 +31,5 @@
     "useUnknownInCatchVariables": true,
     "exactOptionalPropertyTypes": true
   },
-  "exclude": [
-    "node_modules",
-    "build",
-    "dist"
-  ]
-}
+  "exclude": ["node_modules", "build"]
+}

package/.github/workflows/ci.yml

@@ -1,40 +0,0 @@
-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