@checkdigit/typescript-config 3.0.1 → 3.2.0-PR.23-dcac

package/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2021-2022 Check Digit, LLC
+Copyright (c) 2021-2023 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,30 +1,30 @@
-# 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)
 
-Copyright (c) 2022 [Check Digit, LLC](https://checkdigit.com)
+Copyright (c) 2023 [Check Digit, LLC](https://checkdigit.com)
 
 ### Introduction
 
 This module contains the standard Check Digit Typescript configuration.
-- requires Node 16 or above
+
+- requires Node 18 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 `esnext` for `target` and `module`
+- uses the `moduleResoltion` of `bundler`
 - 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 +47,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,37 +1 @@
-{
-  "name": "@checkdigit/typescript-config",
-  "version": "3.0.1",
-  "description": "Check Digit standard Typescript configuration",
-  "prettier": "@checkdigit/prettier-config",
-  "engines": {
-    "node": ">=16"
-  },
-  "peerDependencies": {
-    "typescript": ">=4.7.4",
-    "@types/node": ">=16"
-  },
-  "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 --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/prettier-config": "2.1.0",
-    "rimraf": "^3.0.2"
-  }
-}
+{"name":"@checkdigit/typescript-config","version":"3.2.0-PR.23-dcac","description":"Check Digit standard Typescript configuration","prettier":"@checkdigit/prettier-config","engines":{"node":">=18"},"type":"module","peerDependencies":{"@types/node":">=18","typescript":"^5.0.0-beta"},"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/* --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 && npm run build-swc","ci:style":"npm run prettier"},"devDependencies":{"@checkdigit/prettier-config":"^3.2.0","@swc/cli":"^0.1.61","@swc/core":"^1.3.32","@types/jest":"^29.4.0","esbuild":"^0.17.6","get-port":"^6.1.2","got":"11.8.6","jest":"^29.4.1","rimraf":"^4.1.2","ts-jest":"^29.0.5"},"jest":{"extensionsToTreatAsEsm":[".ts"],"transform":{"^.+\\.ts$":["ts-jest",{"isolatedModules":true,"diagnostics":false,"useESM":true}]},"collectCoverageFrom":["<rootDir>/src/**","!<rootDir>/src/**/*.spec.ts"],"testMatch":["<rootDir>/src/**/*.spec.ts"]},"overrides":{"ts-jest":{"typescript":"^5.0.0-beta"}},"files":["tsconfig.json","SECURITY.md","/src/"]}

package/src/module-directory/index.ts

@@ -0,0 +1,3 @@
+// module-directory/index.ts
+
+export default () => 'module-directory-index';

package/src/module.ts

@@ -0,0 +1,9 @@
+// module.ts
+
+export function test() {
+  return 'export function test';
+}
+
+export default function () {
+  return 'export default function';
+}

package/tsconfig.json

@@ -1,9 +1,11 @@
 {
   "compilerOptions": {
-    "module": "node16",
-    "target": "es2022",
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "bundler",
     "lib": ["esnext", "dom", "webworker"],
     "sourceMap": true,
+    "inlineSources": true,
     "outDir": "build",
     "declaration": true,
     "removeComments": false,
@@ -17,7 +19,7 @@
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "alwaysStrict": true,
-    "importsNotUsedAsValues": "error",
+    "verbatimModuleSyntax": true,
     "noFallthroughCasesInSwitch": true,
     "forceConsistentCasingInFileNames": true,
     "emitDecoratorMetadata": true,
@@ -31,9 +33,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