feat: generate commonjs output from ESM source #15
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
JounQin
commented
Dec 19, 2023
| output: { | ||
| file: pkg.browser.replace(/\.js$/, '.mjs'), |
There was a problem hiding this comment.
The browser field was lib/jsox/es6.js.gz, I don't think it's working correctly because the codes mean lib/jsox/es6.js.gz will be ESM format actually. If you want to use ESM for browser, we can use default entry.
JounQin
force-pushed
the
feat/jsdoc_types
branch
from
cbb8c7d to
8707b33
Compare
JounQin
commented
Dec 19, 2023
| commonjs(), | ||
| terser(), | ||
| append('module.exports = (JSOX.JSOX = JSOX);'), |
There was a problem hiding this comment.
I don't know why the pattern module.exports = JSOX; exports.JSOX = JSOX does not work on Node now. But the hack here is also as easy as possible, and it works as expected.
JounQin
commented
Dec 19, 2023
| @@ -16,17 +16,15 @@ | |||
| "@std/esm": "cjs", | |||
| module: "lib/jsox.mjs", | |||
| main: "lib/jsox.js", | |||
| browser: "lib/jsox.es6.js.gz", | |||
There was a problem hiding this comment.
This lib/jsox.es6.js.gz file generated by build script is actually an ESM output, we can just use the mjs entry instead.
JounQin
force-pushed
the
feat/jsdoc_types
branch
from
8707b33 to
526c426
Compare
|
Frendly ping @d3x0r |
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.
This is first a POC to see whether will it be accepted.
related #13
In this PR, the only source will changed to be
lib/jsox.mjswhich is an ESM file.The commonjs entry
lib/jsox.jswill be generated withrollupautomatically, and I don't see any use of the minified commonjs. If we want to support the browser field, we should generated an umd format output instead, otherwise we should keep to use the ESM source.Secondly, the types are generated via
tscautomatically viajsdoctypes.It's a bit painful to contribute on this project because there is no
.editorconfigorformatterto be used which is very easy to code with different styles. I would recommend to addprettiersupport and tools likelint-stagedto ensure a consistent code style.