Update sections and wording based on #9 #10
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
frehner
commented
Aug 31, 2022
| @@ -171,11 +190,10 @@ There are some good docs from the [NodeJS team](https://nodejs.org/api/packages. | |||
| "exports": { | |||
| ".": { | |||
| "types": "index.d.ts", | |||
| "script": "index.umd.js", | |||
| "browser": "index.umd.js", | |||
There was a problem hiding this comment.
I was initially a little hesitant about the browser field, due to some misunderstandings I had about how Vite currently handles it. However, I went through and re-read the latest PR again and realized I had misunderstood.
frehner
commented
Aug 31, 2022
README.md
Outdated
|
|
||
| If a bundler or environment understands the `exports` field, then the `package.json`'s top-level [main](#set-the-main-field), [types](#set-the-types-field), [module](#set-the-module-field), and [browser](#set-the-browser-field) fields are ignored, as `exports` supersedes those fields. However, it's still importantant to set those fields, for tools or runtimes that do not yet understand the `exports` field. | ||
|
|
||
| If you have a "development" and a "production" bundle (for example, you have warnings in the development bundle that don't exist in the production bundle), then you can also set them in the `exports` field with `"development"` and `"production"`. `webpack` will recognize these conditions automatically, and Rollup [can be configured](https://github.com/rollup/plugins/tree/master/packages/node-resolve/#exportconditions) to recognize them as well. | ||
| If you have a "development" and a "production" bundle (for example, you have warnings in the development bundle that don't exist in the production bundle), then you can also set them in the `exports` field with `"development"` and `"production"`. `webpack` and `vite` will recognize these conditions automatically; however, while Rollup [can be configured](https://github.com/rollup/plugins/tree/master/packages/node-resolve/#exportconditions) to recognize them, that is something that you would have to instruct developers to do in their own bundler config. |
There was a problem hiding this comment.
Confirmed that vite also understands the prod/dev conditions. Yay!
SyMind
added a commit
to SyMind/modern-guide-to-packaging-js-library
that referenced
this pull request
Sep 2, 2022
SyMind
added a commit
to SyMind/modern-guide-to-packaging-js-library
that referenced
this pull request
Sep 2, 2022
SyMind
added a commit
to SyMind/modern-guide-to-packaging-js-library
that referenced
this pull request
Sep 2, 2022
SyMind
added a commit
to SyMind/modern-guide-to-packaging-js-library
that referenced
this pull request
Sep 2, 2022
SyMind
added a commit
to SyMind/modern-guide-to-packaging-js-library
that referenced
this pull request
Sep 2, 2022
SyMind
added a commit
to SyMind/modern-guide-to-packaging-js-library
that referenced
this pull request
Sep 2, 2022
SyMind
added a commit
to SyMind/modern-guide-to-packaging-js-library
that referenced
this pull request
Sep 2, 2022
SyMind
added a commit
to SyMind/modern-guide-to-packaging-js-library
that referenced
this pull request
Sep 2, 2022
SyMind
added a commit
to SyMind/modern-guide-to-packaging-js-library
that referenced
this pull request
Sep 2, 2022
SyMind
added a commit
to SyMind/modern-guide-to-packaging-js-library
that referenced
this pull request
Sep 2, 2022
SyMind
added a commit
to SyMind/modern-guide-to-packaging-js-library
that referenced
this pull request
Sep 2, 2022
SyMind
added a commit
to SyMind/modern-guide-to-packaging-js-library
that referenced
this pull request
Sep 2, 2022
frehner
pushed a commit
that referenced
this pull request
Sep 2, 2022
* translated into Chinese * feat: name and version field * translate dual package hazard * fix: h type * feat: exports * translate the rest * Update README-zh_CN.md * translate files and type * revise the translation * fix anchor * add zh_CN entry * fix code style * changes a bit of the content ( #10 ) * remove default field in example Co-authored-by: zheng-chuang <zhengchuang_kindle@163.com> Co-authored-by: 薛健超 <2289565671@qq.com>
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.
@developit Thanks for the feedback/issue!
I'm a little unsure about how to address the point brought up for the
Set the default module type for your JS filessection, so any ideas there would be great!Also, I'm not entirely sure if the way I phrased the
Minifysection is correct or good enough, so please feel free to put extra focus / requests for changes there.Thanks again.
Closes #9