fix: legacy types (#4)

* Push

* Tweak some more

* Conditional types

* tsx

* Legacy dts for both

* Seems to be working

* Bump version, changelog

* Update readme with Troubleshooting

* Fix modern default too

CHANGELOG.md

@@ -1,3 +1,11 @@
 # Changelog
 
+## 0.6.10
+
+PINNED: [email protected]
+
+### Patch Changes
+
+Fix types for neotraverse/legacy. Now both CJS and ESM are properly typed. CAVEAT: ESM import in typescript doesn't provide `TraverseContext` and `TraverseOptions` types. Import that from `neotraverse` instead.
+
 Fresh start. Check out the [CHANGELOG](https://github.com/ljharb/js-traverse/blob/main/CHANGELOG.md#v069---2024-04-08) 0.6.9 for a list of changes prior to this release.

README.md

@@ -464,6 +464,19 @@ Call this function before each of the children are traversed.
 
 Call this function after each of the children are traversed.
 
+# Troubleshooting
+
+## Next.js
+
+Next.js with Webpack automatically looks for CommonJS version of `neotraverse` and fails to build. Only option is to use `neotraverse/legacy` instead of `neotraverse`.
+
+CAVEAT: `neotraverse/legacy` does not provide additional types, so you need to import `TraverseContext` and `TraverseOptions` from `neotraverse` instead of `traverse`.
+
+```ts
+import traverse from 'neotraverse';
+import type { TraverseContext, TraverseOptions } from 'neotraverse';
+```
+
 # license
 
 MIT

examples/try-esm/index.js

@@ -1,4 +1,4 @@
-import { Traverse } from 'neotraverse/modern';
+import traverse from 'neotraverse/legacy';
 
 const obj = {
 	a: 1,
@@ -13,8 +13,8 @@ const obj = {
 	},
 };
 
-new Traverse(obj).forEach((ctx, node) => {
-	if (node === 6) ctx.update(68);
+traverse(obj).forEach(function (node) {
+	if (node === 6) this.update(68);
 });
 
 console.log(obj);

examples/try-esm/package.json

@@ -11,6 +11,6 @@
 	"license": "ISC",
 	"description": "",
 	"dependencies": {
-		"neotraverse": "0.6.9-test.1"
+		"neotraverse": "https://pkg.pr.new/PuruVJ/neotraverse@d47bc4c"
 	}
 }

examples/try/index.js

@@ -13,4 +13,6 @@ const obj = {
 	},
 };
 
-traverse.forEach(obj, (node) => {});
+traverse(obj).forEach((node) => {});
+
+console.log(obj);

examples/try/package.json

@@ -10,6 +10,6 @@
   "license": "ISC",
   "description": "",
   "dependencies": {
-    "neotraverse": "0.0.5"
+    "neotraverse": "https://pkg.pr.new/PuruVJ/neotraverse@d47bc4c"
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "neotraverse",
-	"version": "0.6.9-next.0",
+	"version": "0.6.10",
 	"description": "traverse and transform objects by visiting every node on a recursive walk",
 	"main": "dist/legacy/legacy.cjs",
 	"type": "module",
@@ -25,12 +25,17 @@
 				"development": "./dist/modern/modern.js",
 				"default": "./dist/modern/modern.js"
 			},
-			"default": "./dist/min/index.js"
+			"default": "./dist/modern/index.js"
 		},
 		"./legacy": {
-			"types": "./dist/legacy/legacy.d.ts",
-			"node": "./dist/legacy/legacy.cjs",
-			"import": "./dist/legacy/legacy.mjs",
+			"require": {
+				"types": "./dist/legacy/legacy.d.cts",
+				"default": "./dist/legacy/legacy.cjs"
+			},
+			"import": {
+				"types": "./dist/legacy/legacy.d.ts",
+				"default": "./dist/legacy/legacy.mjs"
+			},
 			"default": "./dist/legacy/index.cjs"
 		},
 		"./package.json": "./package.json"

src/legacy.cts

@@ -1,2 +1,3 @@
-const traverse = require('./index.ts');
+const traverse = require('./index.js');
+
 module.exports = traverse.default;

tsup.config.ts

@@ -49,7 +49,9 @@ export default defineConfig([
 			return { js: ctx.format === 'cjs' ? '.cjs' : '.mjs' };
 		},
 		dts: {
-			banner: `export type { TraverseContext, TraverseOptions } from '..';`,
+			banner: `declare const traverse: typeof import('..')['default'];
+export = traverse;
+`,
 		},
 		sourcemap: false,
 		clean: true,