Merge pull request #178 from curveball/prep-v1

Dropping CommonJS and releasing 1.0

Author: evert

.github/workflows/bun.yml

@@ -20,5 +20,5 @@ jobs:
     - name: Use Bun
       uses: antongolub/action-setup-bun@v1
     - run: bun install
-    - run: make build
+    - run: bun run build
     - run: bun run mocha

.github/workflows/node.yml

@@ -11,14 +11,14 @@ on:
 
 jobs:
   node-test:
-    name: Node.js tests (ESM)
+    name: Node.js tests
 
     runs-on: ubuntu-latest
     timeout-minutes: 10
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x]
+        node-version: [18.x, 20.x, 21.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
@@ -31,27 +31,6 @@ jobs:
     - run: npm run build --if-present
     - run: npm test
 
-  cjs-test:
-    name: Node.js tests (CommonJS)
-
-    runs-on: ubuntu-latest
-    timeout-minutes: 10
-
-    strategy:
-      matrix:
-        node-version: [16.x, 18.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Use Node.js ${{ matrix.node-version }} (CommonJS)
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm ci
-    - run: npm run build --if-present
-    - run: make test-cjs
-
   lint:
     name: Lint
 

.github/workflows/npm-publish.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
       - run: npm ci
       - run: npm test
 
@@ -25,7 +25,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
           registry-url: https://registry.npmjs.org/
       - run: npm ci
       - run: npm publish
@@ -39,11 +39,11 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
       - run: npm ci
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
           registry-url: 'https://npm.pkg.github.com'
           scope: '@curveball'
       - run: npm publish

.gitignore

@@ -2,8 +2,7 @@
 /node_modules
 
 # typescript output
-/esm
-/cjs
+/dist
 
 # Directory used for running tests in CommonJS mode
 /cjs-test

Makefile

@@ -4,19 +4,12 @@ SOURCE_FILES:=$(shell find src/ -type f -name '*.ts')
 all: build
 
 .PHONY:build
-build: cjs/build esm/build assets
+build: dist/build assets
 
 .PHONY:test
 test:
 	npx nyc mocha
 
-.PHONY:test-cjs
-test-cjs:
-	mkdir -p cjs-test
-	cd test; npx tsc --module commonjs --outdir ../cjs-test
-	echo '{"type": "commonjs"}' > cjs-test/package.json
-	cd cjs-test; npx mocha --no-package
-
 .PHONY:lint
 lint:
 	npx eslint --quiet 'src/**/*.ts' 'test/**/*.ts'
@@ -37,34 +30,22 @@ start: build
 
 .PHONY:clean
 clean:
-	rm -rf dist esm cjs cjs-test
-
-cjs/build: $(SOURCE_FILES)
-	npx tsc --module commonjs --outDir cjs/
-	echo '{"type": "commonjs"}' > cjs/package.json
-	@# Creating a small file to keep track of the last build time
-	touch cjs/build
-
-
-esm/build: $(SOURCE_FILES)
-	npx tsc --module es2022 --outDir esm/
-	echo '{"type": "module"}' > esm/package.json
-	@# Creating a small file to keep track of the last build time
-	touch esm/build
+	rm -rf dist
 
 
+dist/build: $(SOURCE_FILES)
+	npx tsc
+	touch dist/build
 
 .PHONY:assets
 assets: assets/js/html-form-enhancer.js assets/js/serialize-json-form.js
 
 assets/js/html-form-enhancer.js: node_modules/html-form-enhancer/dist/html-form-enhancer.js
 	mkdir -p assets/js
 	cp node_modules/html-form-enhancer/dist/html-form-enhancer.* assets/js
-	touch cjs/build
 
 assets/js/serialize-json-form.js: node_modules/html-form-enhancer/dist/serialize-json-form.js
 	cp node_modules/html-form-enhancer/dist/serialize-json-form.* assets/js
 
-
 src/data/iana-links.json:
 	node util/fetch-link-relation-data.mjs > src/data/iana-links.json

changelog.md

@@ -1,6 +1,17 @@
 Changelog
 =========
 
+1.0.0 (????-??-??)
+------------------
+
+* Finally! Curveball v1. Only took 6 years.
+* CommonJS support has been dropped. The previous version of this library
+  supported both CommonJS and ESM. The effort of this no longer feels worth it.
+  ESM is the future, so we're dropping CommonJS.
+* Now requires Node 18.
+* Upgraded to Typescript 5.3.
+
+
 0.20.5 (2024-01-14)
 -------------------