-
Notifications
You must be signed in to change notification settings - Fork 11
Add --experimental-js-ts-exports flag for JavaScript/TypeScript interop #64
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sjalq
wants to merge
1
commit into
lamdera:lamdera-next
Choose a base branch
from
sjalq:experimental-js-ts-exports
base: lamdera-next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
[submodule "test/scenario-elm-pages-incompatible-wire/elm-pages"] | ||
path = test/scenario-elm-pages-incompatible-wire/elm-pages | ||
url = git@github.com:dillonkearns/elm-pages.git | ||
url = https://github.com/dillonkearns/elm-pages.git | ||
[submodule "vendor/elm-format"] | ||
path = vendor/elm-format | ||
url = git@github.com:lamdera/elm-format.git | ||
url = https://github.com/lamdera/elm-format.git |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
Add --experimental-js-ts-exports flag for JavaScript/TypeScript interop | ||
|
||
This feature enables Elm modules to be consumed directly from JavaScript | ||
and TypeScript projects while maintaining Elm's currying semantics. | ||
|
||
## Changes | ||
|
||
- Add `--experimental-js-ts-exports` CLI flag to `lamdera make` | ||
- Generate ES6 module exports for all top-level functions in modules with main | ||
- Support both curried and uncurried function calls from JavaScript | ||
- Generate TypeScript declaration files (.d.ts) alongside JavaScript output | ||
- Filter internal wire protocol functions (w3_ prefix) from exports | ||
|
||
## Implementation Details | ||
|
||
- Uses existing Lamdera global flag pattern for consistency | ||
- Reuses JavaScript AST generation infrastructure | ||
- Generates clean module.exports structure for Node.js compatibility | ||
- Preserves Elm's currying by attaching curry property to multi-arg functions | ||
|
||
## Testing | ||
|
||
- Added comprehensive property-based tests with random Elm module generation | ||
- Tests verify TypeScript declarations compile successfully | ||
- Integration with existing test suite | ||
|
||
## Usage | ||
|
||
```bash | ||
lamdera make Main.elm --experimental-js-ts-exports --output=output.js | ||
``` | ||
|
||
This generates: | ||
- output.js with exported functions | ||
- output.d.ts with TypeScript declarations | ||
|
||
## Example | ||
|
||
Given an Elm module: | ||
```elm | ||
module Main exposing (main) | ||
|
||
greet : String -> String -> String | ||
greet firstName lastName = | ||
"Hello, " ++ firstName ++ " " ++ lastName | ||
|
||
main = ... | ||
``` | ||
|
||
JavaScript usage: | ||
```javascript | ||
const { Main } = require('./output.js'); | ||
|
||
// Direct call (uncurried) | ||
Main.greet("John", "Doe"); // "Hello, John Doe" | ||
|
||
// Curried call | ||
Main.greet.curry("John")("Doe"); // "Hello, John Doe" | ||
``` | ||
|
||
TypeScript gets full type safety: | ||
```typescript | ||
import { Main } from './output'; | ||
|
||
const greeting: string = Main.greet("John", "Doe"); | ||
``` | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't think this was supposed to be committed?