Add routes to simplify cherry picking #343
Merged
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
`main` and `module` allows us to provide an entry points for both
bundler and node. However this doesn't work with modules cherry picking.
In this diff I suggest to add `package.json` with `main` and `module`
fields to each module. This will allow to import this library like this
```js
import { create } from 'gl-matrix/vec2';
```
The structure looks like this
```
README.md
LICENSE.md
cjs/*.js
esm/*.js
mat2/package.json
mat2d/package.json
mat3/package.json
mat4/package.json
quat/package.json
quat2/package.json
vec2/package.json
vec3/package.json
vec4/package.json
gl-matrix-min.js
gl-matrix.js
```
Each `package.json` looks like this
```json
{
"name": "gl-matrix/vec2",
"main": "../cjs/vec2.js",
"module": "../esm/vec2.js"
}
```
To prevent root folder pollution I made it private and copy necessary
files like `package.json`, `README.md` and `LICENSE.md` into dist
folder. To publish package you need to go first to `dist` folder.
|
/cc @stefnotch After this one I'm gonna send one last PR to improve umd bundles. |
|
Seems to be taking shape nicely! Nice one! |
|
@stefnotch Can this be merged? |
|
Oh, sorry for the late response. Yes, this does look quite fine, so, I'm merging it. |
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.
mainandmoduleallows us to provide an entry points for bothbundler and node. However this doesn't work with modules cherry picking.
In this diff I suggest to add
package.jsonwithmainandmodulefields to each module. This will allow to import this library like this
The structure looks like this
Each
package.jsonlooks like this{ "name": "gl-matrix/vec2", "main": "../cjs/vec2.js", "module": "../esm/vec2.js" }To prevent root folder pollution I made it private and copy necessary
files like
package.json,README.mdandLICENSE.mdinto distfolder. To publish package you need to go first to
distfolder.