BREAKING! Hybrid build to CommonJS and ES Modules #7
Conversation
This file contains 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
|
Hi @vitalybaev, Thank you for the PR! Regarding the introduced Without export: import { Orion } from '@tailflow/laravel-orion';
import { BelongsTo } from "@tailflow/laravel-orion/lib/drivers/default/relations/belongsTo";With export import { Orion } from '@tailflow/laravel-orion';
import { BelongsTo } from "@tailflow/laravel-orion/drivers/default/relations/belongsTo"; //notice that "lib" part is goneAs for the removal of the |
|
Hey how's this going? I'd really like to use this library in my ts-node-esm project |
|
following |
|
I can take a look into it shortly, keep you posted |
|
Closing due to inactivity |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
Closes #6
Current Problem
Currently, this package doesn't expose a module. It just specifies
fileskey withlibfolder.This is why
laravel-orion-tscouldn't be used in Next.js applications.Solution
buildscript to build separately two versions: CommonJS (under./dist/cjs) and ES Modules (under./dist/esm). It's necessary because in most cases plain ES Modules aren't transpiled and couldn't be used (at least in Next.js apps right now)indexfile as entry point for our module, which currently exposes common entities.package.jsonfor both module types.Why breaking change
It could break up things, and it will be better to ship new major version.
In most cases this import would work:
Import as CommonJS module:
or as ES module:
I leave this PR in Draft while discussion isn't finished.
Possible points to discuss
distdirectory at all and build files to<package-root>/cjsand<package-root>/esmor whatever