Skip to content

Add extra information about ES modules inside the js-interop document #4932

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
wants to merge 4 commits into
base: kotlin-js-doc-update
Choose a base branch
from

Conversation

JSMonk
Copy link
Member

@JSMonk JSMonk commented Jun 27, 2025

No description provided.

@JSMonk JSMonk requested a review from a team as a code owner June 27, 2025 15:40
@AlejandraPedroza AlejandraPedroza self-assigned this Jul 1, 2025
@AlejandraPedroza AlejandraPedroza changed the base branch from master to kotlin-js-doc-update July 10, 2025 14:43
@AlejandraPedroza AlejandraPedroza force-pushed the add-information-about-es-modules branch from cb9e823 to 4789de7 Compare July 10, 2025 14:44
@@ -33,8 +34,9 @@ Check the article on [JavaScript Modules](js-modules.md) for more information on

## Package structure

Kotlin exposes its package structure to JavaScript, so unless you define your declarations in the root package,
you have to use fully qualified names in JavaScript. For example:
For most of the module systems, Kotlin exposes its package structure to JavaScript,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess it's worth mentioning which module systems, since Kotlin supports four only (not considering PLAIN).
Plus, you say ESM is an exception, so CJS, AMD and UMD are the one with the package structure.

@@ -54,6 +56,15 @@ Or, in the case of using `plain` as a module system setting:
alert(myModule.my.qualified.packagename.foo());
```

However, there is an exception for `ES` modules.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you apply my suggestion above, you could reword this one to

The ECMAScript Modules target instead loses package information, to improve the package' bundle size and to match the typical layout of ESM packages.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Applied your suggestions

Copy link
Contributor

@AlejandraPedroza AlejandraPedroza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this. I made some minor style changes. Can you please check the new version?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants