Switch to new style imports. #410
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tomprince
force-pushed
the
module-imports
branch
4 times, most recently
from
bbad37a to
f8d690f
Compare
tomprince
commented
Mar 10, 2023
| @@ -0,0 +1,3 @@ | |||
| import * as fs from 'fs' | |||
|
|
|||
| fs.writeFileSync('./dist/main/package.json', '{"type": "commonjs"}') | |||
There was a problem hiding this comment.
Node looks at type in the nearest package.json to tell if a .jsfile should be interpreted as an ESM or commonjs module. You can use .mjs or .cjs to specify this on a per-file basis, but typescript doesn't have any support for that. See https://github.com/azu/tsconfig-to-dual-package#motivation for more details and links to discussion about this.
I elected to put type: module in the top-level package, since my impression is that the ecosystem is slowly moving towards ESM style modules.
| preset: 'ts-jest', | ||
| testEnvironment: 'node', | ||
| moduleNameMapper: { | ||
| '^(\\.{1,2}/.*)\\.js$': '$1', | ||
| }, |
There was a problem hiding this comment.
I copied this from https://kulshekhar.github.io/ts-jest/docs/guides/esm-support, but it isn't clear to me why this isn't included in any of the presets.
tomprince
force-pushed
the
module-imports
branch
from
f8d690f to
b7f863d
Compare
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
This adds support for importing postgrest-js as an ESM module in node.
What is the current behavior?
Currently, postgrest-js can only be imported as a CommonJS module on node (fixes #411).
Additional context
As written, this prevents imports like
require("@supabase/postgrest-js/dist/main/PostgrestBuilder.js"). Node's docs suggest that this is a breaking change:However, I think that is only true if you consider that kind of import to be part of your public interface. The documentation does suggest a way to continue to support that kind of import if desired.
Looking at the code, the only things that could be accessed that way that aren't available from the top-level import are in
src/types.tsandsrc/constants.ts.This seems to work when I test locally, but I don't know enough about how this package is used in the wild to know if this might cause issues for other consumers.