Revamp build (#33)

nwalters512 · web-flow · commit af330647761a · 2024-11-14T16:33:23.000-08:00
* WIP build revamp

* Refine types; add GitHub Actions workflow

* Export types

* Upgrade @orchidjs/unicode-variants
diff --git a/.config/babel.config.json b/.config/babel.config.json
@@ -4,14 +4,11 @@
 		[
 			"@babel/preset-env",
 			{
-				loose: true,
-				bugfixes: true,
-				modules: false
+				"loose": true,
+				"bugfixes": true,
+				"modules": false
 			}
 		],
 		"@babel/typescript"
-	],
-	"plugins": [
-		["@babel/plugin-proposal-class-properties", { "loose": true }]
-    ]
+	]
 }
diff --git a/.config/rollup.config.mjs b/.config/rollup.config.mjs
@@ -1,9 +1,12 @@
 import babel from '@rollup/plugin-babel';
-import { terser } from 'rollup-plugin-terser';
+import terser from '@rollup/plugin-terser';
 import resolve from '@rollup/plugin-node-resolve'; // so Rollup can resolve imports without file extensions and `node_modules`
 import path from 'path';
+import { fileURLToPath } from 'url';
 
-var configs = [];
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+const configs = [];
 const banner = `/*! sifter.js | https://github.com/orchidjs/sifter.js | Apache License (v2) */`;
 
 const extensions = [
@@ -36,33 +39,6 @@ var terser_config = terser({
 });
 
 
-// esm
-configs.push({
-	input: path.resolve(__dirname,'../lib/sifter.ts'),
-	output:{
-		dir: path.resolve(__dirname,'../dist/esm'),
-		format: 'esm',
-		preserveModules: true,
-		sourcemap: true,
-		banner: banner,
-	},
-	plugins:[babel_config,resolve_config]
-});
-
-// cjs
-configs.push({
-	input: path.resolve(__dirname,'../lib/sifter.ts'),
-	output:{
-		dir: path.resolve(__dirname,'../dist/cjs'),
-		format: 'cjs',
-		preserveModules: false,
-		sourcemap: true,
-		banner: banner,
-	},
-	plugins:[babel_config,resolve_config]
-});
-
-
 // umd
 configs.push({
 		input: path.resolve(__dirname,'../lib/sifter.ts'),
diff --git a/.config/tsconfig.cjs.json b/.config/tsconfig.cjs.json
@@ -0,0 +1,8 @@
+{
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"module": "CommonJS",
+		"moduleResolution": "Node",
+		"outDir": "../dist/cjs",
+	}
+}
diff --git a/.config/tsconfig.esm.json b/.config/tsconfig.esm.json
@@ -0,0 +1,7 @@
+{
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"module": "NodeNext",
+		"outDir": "../dist/esm",
+	}
+}
diff --git a/.config/tsconfig.json b/.config/tsconfig.json
@@ -2,18 +2,18 @@
 	"include": ["../lib/**/*"],
 	"compilerOptions": {
 		"allowJs": true,
-	    "checkJs": true,
-	    "strict": true,
-		"target": "esnext",
-		"module": "esnext",
+		"checkJs": true,
+		"strict": true,
+		"target": "ESNext",
+		"module": "NodeNext",
+		"moduleResolution": "NodeNext",
 		"noUnusedLocals": true,
 		"noUnusedParameters": true,
 		"allowUnreachableCode": false,
 		"noUncheckedIndexedAccess": true,
-
 		"declaration": true,
-		"declarationDir": "../dist/types",
 		"isolatedModules": true,
-		"moduleResolution": "node"
+		"sourceMap": true,
+		"rewriteRelativeImportExtensions": true,
 	},
 }
diff --git a/.config/tsconfig.types.json b/.config/tsconfig.types.json
@@ -0,0 +1,11 @@
+{
+	// This exists for backwards compatibility. In the wild, folks are importing
+	// paths like `@orchidjs/sifter.js/dist/types/...`.
+	//
+	// Consider removing this in the next major version.
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "../dist/types",
+		"emitDeclarationOnly": true
+	}
+}
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -0,0 +1,26 @@
+name: Node.js CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: ['18.x', '20.x', '22.x']
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run build
+      - run: npm run test
+      - run: npm run test:types
diff --git a/.gitignore b/.gitignore
@@ -2,7 +2,4 @@
 node_modules
 benchmark/report*.json
 coverage
-package-lock.json
-build
-x-*
 dist
diff --git a/.travis.yml b/.travis.yml
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}
diff --git a/lib/sifter.ts b/lib/sifter.ts
@@ -14,9 +14,9 @@
  * @author Brian Reavis <brian@thirdroute.com>
  */
 
-import { scoreValue, getAttr, getAttrNesting, propToArray, iterate, cmp } from './utils';
+import { scoreValue, getAttr, getAttrNesting, propToArray, iterate, cmp } from './utils.ts';
 import { getPattern, escape_regex } from '@orchidjs/unicode-variants';
-import * as T from './types';
+import * as T from './types.ts';
 
 class Sifter{
 
@@ -353,3 +353,4 @@ class Sifter{
 }
 
 export { Sifter, scoreValue, getAttr, getAttrNesting, propToArray, iterate, cmp, getPattern }
+export * from './types.ts';
diff --git a/lib/types.ts b/lib/types.ts
@@ -1,5 +1,5 @@
 
-import {Sifter} from './sifter';
+import {Sifter} from './sifter.ts';
 
 export type Field = {
 	field: string,
diff --git a/lib/utils.ts b/lib/utils.ts
@@ -1,6 +1,6 @@
 
 import { asciifold } from '@orchidjs/unicode-variants';
-import * as T from './types';
+import * as T from './types.ts';
 
 
 /**
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -4,14 +4,11 @@`
`4`	`4`	`[`
`5`	`5`	`"@babel/preset-env",`
`6`	`6`	`{`
`7`		`- loose: true,`
`8`		`- bugfixes: true,`
`9`		`- modules: false`
	`7`	`+ "loose": true,`
	`8`	`+ "bugfixes": true,`
	`9`	`+ "modules": false`
`10`	`10`	`}`
`11`	`11`	`],`
`12`	`12`	`"@babel/typescript"`
`13`		`- ],`
`14`		`- "plugins": [`
`15`		`- ["@babel/plugin-proposal-class-properties", { "loose": true }]`
`16`		`- ]`
	`13`	`+ ]`
`17`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "typescript.tsdk": "node_modules/typescript/lib"`
	`3`	`+}`