@checkdigit/typescript-config 2.2.0 → 3.0.0

package/.travis.yml

@@ -0,0 +1,7 @@
+language: node_js
+node_js:
+  - "16"
+arch: arm64
+notifications:
+  slack: checkdigit:KPANFpO8mCjIwBUXdElcj7Mr
+after_success: npm run coveralls

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

@@ -3,13 +3,16 @@
 [![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 +30,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,17 +1,13 @@
 {
   "name": "@checkdigit/typescript-config",
-  "version": "2.2.0",
+  "version": "3.0.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"
+    "typescript": ">=4.7.2"
   },
   "repository": {
     "type": "git",
@@ -23,7 +19,16 @@
     "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": "tsc && node build/index.js | grep -q 'complete' && rimraf build && npm run prettier"
+  },
   "devDependencies": {
-    "typescript": "4.4.2"
+    "@checkdigit/prettier-config": "2.0.1",
+    "@types/node": "^17.0.35",
+    "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",

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)}