chore: Use type: "module" and build to cjs/mjs #190
Conversation
pan-kot
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #190 +/- ##
=======================================
Coverage 99.05% 99.05%
=======================================
Files 42 42
Lines 1165 1165
Branches 317 316 -1
=======================================
Hits 1154 1154
Misses 10 10
Partials 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
pan-kot
force-pushed
the
esm-friendly
branch
3 times, most recently
from
2d8526a to
a951be2
Compare
pan-kot
changed the title
| ], | ||
| "no-warning-comments": "warn" | ||
| "no-warning-comments": "warn", | ||
| "import/extensions": ["error", "ignorePackages"] |
There was a problem hiding this comment.
We need ".js" extensions so that mjs imports are resolved correctly. Without that, the downstream builds fail. The same issue exists in the collection-hooks. As a follow-up change, I plan to apply the same changes to the collection-hooks eslint config.
pan-kot
force-pushed
the
esm-friendly
branch
5 times, most recently
from
5ce65ae to
1cc1b31
Compare
| }, | ||
| "sideEffects": false, | ||
| "types": "./mjs/index.d.ts", | ||
| "typesVersions": { |
There was a problem hiding this comment.
This is needed to fix downstream packages that import from /dom or /internal. That will not be needed should we update the packages to use moduleResolution: "nodenext".
pan-kot
force-pushed
the
esm-friendly
branch
3 times, most recently
from
5797563 to
e03e17d
Compare
pan-kot
force-pushed
the
esm-friendly
branch
5 times, most recently
from
2e70409 to
a16e542
Compare
| packageCjs.type = 'commonjs'; | ||
|
|
||
| writeFileSync(libPkgPath, JSON.stringify(packageCjs, null, 2) + '\n'); | ||
| writeFileSync(esmPkgPath, JSON.stringify({ type: 'module' }, null, 2) + '\n'); |
There was a problem hiding this comment.
Is this writing just {type: module} as the entire file content?
There was a problem hiding this comment.
What are these two additional package.json files actually for?
There was a problem hiding this comment.
We only publish the /lib folder - that's why the /lib/package.json is needed - it describes the package. However, as the /lib includes cjs exports, we have to change the type from "module" to "commonjs" after copying it.
In /lib/mjs we have ejs exports, therefore type "module" is needed again. There is no need to copy the entire package.json though - it will extend from the one in the package's root.
2 participants
Required for: cloudscape-design/collection-hooks#130
Requires:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.