Merge pull request #305 from remarkablemark/build/esm

fix(package): fix "module" field in package.json

.github/workflows/build.yml

@@ -33,7 +33,7 @@ jobs:
         run: npm run test:ci
 
       - name: Run module tests
-        run: npm run test:module
+        run: npm run test:esm
 
       - name: Codecov
         uses: codecov/codecov-action@v3

.gitignore

@@ -41,8 +41,9 @@ jspm_packages
 .node_repl_history
 
 # Build files
+cjs/
 docs/
-lib/
+esm/
 
 # Vim swap files
 *.swp

.husky/pre-commit

@@ -3,4 +3,5 @@
 
 npm run lint:tsc
 npm run test:ci
+npm run test:esm
 npx lint-staged

package.json

@@ -3,27 +3,28 @@
   "version": "2.2.1",
   "description": "Track users, send messages, export data, and more with Braze API.",
   "author": "Mark <mark@remarkablemark.org>",
-  "main": "lib/index.js",
-  "module": "index.mjs",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
   "exports": {
-    "types": "./lib/index.d.ts",
-    "import": "./module/index.mjs",
-    "require": "./lib/index.js"
+    "import": "./esm/index.js",
+    "require": "./cjs/index.js"
   },
   "scripts": {
-    "build": "tsc --project tsconfig.build.json",
-    "clean": "rm -rf coverage docs lib",
+    "build": "npm run build:cjs && npm run build:esm",
+    "build:cjs": "tsc",
+    "build:esm": "tsc --module nodenext --outDir esm",
+    "clean": "rm -rf cjs coverage docs esm",
     "docs": "typedoc",
     "docs:watch": "npm run docs -- --watch",
-    "lint": "eslint --ignore-path .gitignore --ext .js,.ts .",
+    "lint": "eslint --ignore-path .gitignore --ext .js,.mjs,.ts .",
     "lint:fix": "npm run lint -- --fix",
-    "lint:tsc": "tsc && tsc --project tsconfig.test.json",
+    "lint:tsc": "tsc --noEmit && tsc --project tsconfig.test.json",
     "postinstall": "husky install",
     "postpublish": "pinst --enable",
-    "prepublishOnly": "pinst --disable && npm run lint && npm run lint:tsc && npm run test:ci && npm run clean && npm run build",
+    "prepublishOnly": "pinst --disable && npm run lint && npm run lint:tsc && npm run test:ci && npm run test:esm && npm run clean && npm run build",
     "test": "jest",
     "test:ci": "CI=true jest --ci --colors --coverage",
-    "test:module": "npm run build && node --test module",
+    "test:esm": "npm run build:esm && node --test src",
     "test:watch": "jest --watch"
   },
   "repository": {
@@ -64,8 +65,8 @@
     "typescript": "5.1.6"
   },
   "files": [
-    "lib/",
-    "module/"
+    "cjs/",
+    "esm/"
   ],
   "engines": {
     "node": ">=14"

module/index.test.mjs → src/index.test.mjs

@@ -2,7 +2,7 @@ import { describe, it } from 'node:test'
 
 import assert from 'assert'
 
-import { Braze } from './index.mjs'
+import { Braze } from '../esm/index.js'
 
 describe('index', () => {
   it('exports "Braze" class', () => {

tsconfig.json

@@ -8,9 +8,8 @@
     "sourceMap": true,
     "forceConsistentCasingInFileNames": true,
     "strict": true,
-    "outDir": "lib",
-    "noEmit": true
+    "outDir": "cjs"
   },
   "include": ["src"],
-  "exclude": ["**/*.test.ts"]
+  "exclude": ["node_modules", "**/*.test.ts"]
 }

tsconfig.test.json

@@ -1,7 +1,8 @@
 {
   "extends": "./tsconfig.json",
   "compilerOptions": {
-    "lib": ["es2020", "dom"]
+    "lib": ["es2020", "dom"],
+    "noEmit": true
   },
   "include": ["**/*.test.ts"],
   "exclude": []