@checkdigit/typescript-config 2.2.0 → 3.1.0

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,36 +1,38 @@
-# 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)
-[![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 `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
 
 ```
-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`
@@ -44,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,17 +1,14 @@
 {
   "name": "@checkdigit/typescript-config",
-  "version": "2.2.0",
+  "version": "3.1.0",
   "description": "Check Digit standard Typescript configuration",
-  "scripts": {
-    "preversion": "npm test",
-    "postversion": "git push && git push --tags",
-    "test": "tsc --noEmit"
-  },
+  "prettier": "@checkdigit/prettier-config",
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "peerDependencies": {
-    "typescript": ">=4.4.2"
+    "@types/node": ">=16",
+    "typescript": ">=4.8.2"
   },
   "repository": {
     "type": "git",
@@ -23,7 +20,22 @@
     "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 .",
+    "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": {
-    "typescript": "4.4.2"
-  }
+    "@checkdigit/prettier-config": "^3.0.0",
+    "rimraf": "^3.0.2"
+  },
+  "files": [
+    "tsconfig.json",
+    "SECURITY.md"
+  ]
 }

package/tsconfig.json

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

package/dist/index.d.ts

@@ -1,11 +0,0 @@
-/**
- * Check for Typescript 4.4 features
- */
-interface SymbolIndexSignature {
-    [name: symbol]: number;
-}
-interface Person {
-    name: string;
-    age?: number;
-}
-declare const person: Person;

package/dist/index.js

@@ -1 +0,0 @@
-"use strict";try{console.log("hello")}catch(e){console.error(e.message)}