Skip to content
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

docs(node-resolve): improve doc related to mainFields #138

Merged
merged 5 commits into from Jan 4, 2020
Merged

docs(node-resolve): improve doc related to mainFields #138

merged 5 commits into from Jan 4, 2020

Conversation

StreetStrider
Copy link
Contributor

@StreetStrider StreetStrider commented Jan 3, 2020

Rollup Plugin Name: rollup-plugin-node-resolve

This PR contains:

  • bugfix
  • feature
  • refactor
  • documentation
  • other

Are tests included?

  • yes (bugfixes and features will not be merged without tests)
  • no

Breaking Changes?

  • yes (breaking changes will not be merged unless absolutely necessary)
  • no

List any relevant issue numbers:

Description

More clear doc related to mainFields priority and distinct options for browser, module, jsnext and main. Rework markup to distinguish values of mainFields and corresponding values in package.json.

More clear doc related to mainFields priority and distinct options for browser, module, jsnext and main. Rework markup to distinguish values of mainFields and corresponding values in package.json.
@shellscape shellscape changed the title node-resolve: improve doc related to mainFields docs(node-resolve): improve doc related to mainFields Jan 3, 2020
@StreetStrider
Copy link
Contributor Author

Docs created according to this function.

@shellscape
Copy link
Collaborator

Note to reviewers: We can safely ignore the failing Windows tests for now. #137 contains a fix for that.

Simplify valid values

Co-Authored-By: Andrew Powell <shellscape@users.noreply.github.com>
Copy link
Collaborator

@shellscape shellscape left a comment

Choose a reason for hiding this comment

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

Great start, and thanks for opening this PR. A few modifications I'd like to see.

StreetStrider and others added 3 commits January 3, 2020 20:30
Remove Type/Default info on deprecated properties: jsnext, module and main.
Co-Authored-By: Andrew Powell <shellscape@users.noreply.github.com>
Co-Authored-By: Andrew Powell <shellscape@users.noreply.github.com>
@shellscape
Copy link
Collaborator

thanks!

@shellscape shellscape merged commit 7b0364f into rollup:master Jan 4, 2020
LarsDenBakker pushed a commit to LarsDenBakker/plugins that referenced this pull request Sep 12, 2020
* node-resolve: improve doc related to mainFields

Fixes rollup#66

More clear doc related to mainFields priority and distinct options for browser, module, jsnext and main. Rework markup to distinguish values of mainFields and corresponding values in package.json.

* Update packages/node-resolve/README.md

Simplify valid values

Co-Authored-By: Andrew Powell <shellscape@users.noreply.github.com>

* node-resolve: remove type info on deprec options

Remove Type/Default info on deprecated properties: jsnext, module and main.

* Update packages/node-resolve/README.md

Co-Authored-By: Andrew Powell <shellscape@users.noreply.github.com>

* Update packages/node-resolve/README.md

Co-Authored-By: Andrew Powell <shellscape@users.noreply.github.com>

Co-authored-by: Andrew Powell <shellscape@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants