Converting packages to type: module by default #2565

smallsaucepan · 2024-01-10T03:30:18Z

Given we use the ES module import syntax almost everywhere, and are exporting CJS and ESM versions anyway, we should make our modules "ESM first".

Had to disable a few type tests, though these are only in packages where we import older third party libraries.

Didn't bother replacing node __dirname references in tests as they seem to work fine within each package without.

Use a meaningful title for the pull request. Include the name of the package modified.
Have read How To Contribute.
Run npm test at the sub modules where changes have occurred.
Run npm run lint to ensure code style at the turf module level.

…mpatibility. Flow on changes from that include requiring a js extension for relative includes, and workarounds for a couple of older third party libraries that were no longer importing smoothly. Builds successfully. Updating tests next.

…rences to __dirname. Added some re-exporting wrapper files for older packages like rbush and sweepline-intersections. See turf-line-intersects for an example.

…issues in post type: module. Maybe someone in future can exercise some typescript jujitsu to re-enable them.

.monorepolint.config.mjs

packages/turf-along/test.ts

packages/turf-hex-grid/test.ts

packages/turf/test.ts

mfedderly · 2024-01-14T21:49:43Z

packages/turf-collect/lib/rbush-export.ts

+// Manifests as "This expression is not callable ... has no call signatures"
+// https://stackoverflow.com/a/74709714
+
+import lib from "rbush";


Ditto for rbush

mfedderly · 2024-01-14T21:52:04Z

packages/turf-kinks/lib/sweepline-intersections-export.ts

@@ -0,0 +1,7 @@
+// Get around problems with moduleResolution node16 and some older libraries.
+// Manifests as "This expression is not callable ... has no call signatures"
+// https://stackoverflow.com/a/74709714


Same thing here, it appears to have default function in both the types and the code. Maybe its a weird build step from the package with the code in it?

https://github.com/rowanwins/sweepline-intersections/blob/master/src/main.js
https://github.com/rowanwins/sweepline-intersections/blob/master/types.d.ts

mfedderly · 2024-01-14T21:52:21Z

packages/turf-line-intersect/lib/sweepline-intersections-export.ts

+// Manifests as "This expression is not callable ... has no call signatures"
+// https://stackoverflow.com/a/74709714
+
+import lib from "sweepline-intersections";


Ditto on sweepline-intersections

mfedderly · 2024-01-14T21:53:22Z

packages/turf-clusters-dbscan/types.ts

@@ -1,5 +1,8 @@
+/*


For this package, what import was causing problems?

Problem was cropping up with the import RBush from "rbush" line.

With the wrapper, it looks like you're still needing to use ts-ignore and lose the rbush types in turf-clusters-dbscan/index.js?

Following the rabbit hole of one of the links you shared @smallsaucepan I found this module default-import that is also a workaround wrapper that preserves types. I haven't fully tested it in my own work (I'm doing an esm conversion) but it looks promising.

import { defaultImport } from "default-import"; import rbushDefault from "rbush"; const RBush = await defaultImport(rbushDefault); class RBushIndex extends RBush<Feature> { ...

Thanks for finding that Tim. It does do the trick though it looks like there may be some flow on effects. To use the const RBush = await defaultImport(rbushDefault); approach we need to change our JS target to at least es2022 to support the top level await. More so the umd package we generate for CDN usage can't have that top level await either, so it would be a change to how turf.min.js was included directly in the browser i.e. https://rollupjs.org/configuration-options/#output-format

Btw where were you seeing errors that required a ts-ignore? Previous approach seemed to work without complaining in my VSCode.

The lib/wrapper approach seems ok. We can use defaultImport, though I think that pushes us forward too quickly and I'm not sure the implications.

No problem if can't do it. The migration I'm doing targets es2022 so I didn't think about top-level await. One idea, wonder if can wrap the dynamic import into a little IIFE like:

import { defaultImport } from "default-import"; import rbushDefault from "rbush"; const RBush = await (async () => { const RBush = await defaultImport(rbushDefault); return RBush })() class RBushIndex extends RBush<Feature> { ...

At that point you might as well keep your wrapper if it's all the same.

I guess it was a ts-expect-error that I saw, not ts-ignore. Maybe what I saw was just the original code you'd already replaced.

packages/turf-kinks/types.ts

…ntified that the .cjs extension was causing problems for some consumers. Would have like to use .d.ts rather .d.cts for CJS type defs, but there's a but in tsup at the moment that won't allow that to be customised.

… as not supplied automatically by node any more. Updating benchmark tests. Adding some missing bench and tape @types libraries.

…removed a few that had inadvertently been added.

… Got disabled types tests working again by adjusting tsc command (needed to include node16 module and moduleResolution switched on command line). Also needed to refer to "index", etc as "index.js", etc from test.ts files to avoid "Relative import paths need explicit file extensions in ECMAScript imports when '--moduleResolution' is 'node16'" errors.

smallsaucepan · 2024-03-10T13:36:12Z

Hi @mfedderly. Have done the best as I can with this for now.

A summary of any item left unanswered seems to be something odd in the build or packaging of a third party library. Happy to chase these down one by one with the authors as it would be good to remove any wrapper files long term.

For now though, this should be good enough for us to push ahead with the goal of developing in an ESM world, and packaging ESM+CJS.

…ort library which takes care of finding the correct default to import from CJS packages.

twelch

This all matches my expectations, based on an ESM migration I'm doing in another repo, which I'm updating to use the latest Turf. I look forward to testing this out when it lands.

…faultImport library which takes care of finding the correct default to import from CJS packages." This reverts commit f8184c3.

smallsaucepan · 2024-03-11T10:40:02Z

Thanks for approving @twelch. Let me clean up (roll back the defaultImport change) and then I'll merge. Appreciate your input too @mfedderly given your earlier comments.

…module resolution.

mfedderly

My only other followups would be the rbush and sweepline-intersections import issues.

Thanks for doing all of this!

mfedderly · 2024-03-11T23:32:28Z

packages/turf-along/test.ts

 import { Feature, LineString } from "geojson";

+const __dirname = path.dirname(fileURLToPath(import.meta.url));


I found a thing in my travels that tsup will polyfill these sorts of things for us.
https://tsup.egoist.dev/#inject-cjs-and-esm-shims

smallsaucepan added 3 commits January 6, 2024 23:29

Adding js extension to more local imports in tests, and removing refe…

355c076

…rences to __dirname. Added some re-exporting wrapper files for older packages like rbush and sweepline-intersections. See turf-line-intersects for an example.

Disabling some type tests in packages we were having export / import …

44c9460

…issues in post type: module. Maybe someone in future can exercise some typescript jujitsu to re-enable them.

smallsaucepan requested a review from mfedderly January 10, 2024 03:30

smallsaucepan added typescript bundling Anything related to issues with bundling labels Jan 10, 2024

mfedderly reviewed Jan 14, 2024

View reviewed changes

sutanAE mentioned this pull request Jan 16, 2024

SvelteKit & Typescript 5: Could not find a declaration file for module #2570

Closed

3 tasks

smallsaucepan added 6 commits January 17, 2024 21:06

Reintroducing __dirname references, though need to add implementation…

63eaeef

… as not supplied automatically by node any more. Updating benchmark tests. Adding some missing bench and tape @types libraries.

Added a few __dirname references that should have been included, and …

2864049

…removed a few that had inadvertently been added.

Merge branch 'master' into type-module

0ce1c6e

Merge branch 'master' into type-module

1118ae5

Missed a .js -> .cjs in turf/turf last-checks target.

519aca9

Removing hacky cjs/esm export/import wrappers in favour of defaultImp…

f8184c3

…ort library which takes care of finding the correct default to import from CJS packages.

twelch approved these changes Mar 11, 2024

View reviewed changes

Revert "Removing hacky cjs/esm export/import wrappers in favour of de…

3de6d1f

…faultImport library which takes care of finding the correct default to import from CJS packages." This reverts commit f8184c3.

Found a few more spots to add a js extension to satisfy newer node16 …

eefa803

…module resolution.

smallsaucepan merged commit e0bdd0a into Turfjs:master Mar 11, 2024
3 checks passed

mfedderly reviewed Mar 11, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Converting packages to type: module by default #2565

Converting packages to type: module by default #2565

smallsaucepan commented Jan 10, 2024

mfedderly Jan 14, 2024

mfedderly Jan 14, 2024

mfedderly Jan 14, 2024

mfedderly Jan 14, 2024

smallsaucepan Mar 10, 2024

twelch Mar 10, 2024 •

edited

Loading

smallsaucepan Mar 11, 2024

twelch Mar 11, 2024

smallsaucepan commented Mar 10, 2024

twelch left a comment

smallsaucepan commented Mar 11, 2024

mfedderly left a comment

mfedderly Mar 11, 2024

		import { Feature, LineString } from "geojson";

		const __dirname = path.dirname(fileURLToPath(import.meta.url));

Converting packages to type: module by default #2565

Converting packages to type: module by default #2565

Conversation

smallsaucepan commented Jan 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

twelch Mar 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smallsaucepan commented Mar 10, 2024

twelch left a comment

Choose a reason for hiding this comment

smallsaucepan commented Mar 11, 2024

mfedderly left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

twelch Mar 10, 2024 •

edited

Loading