Skip to content

Clarify comment about babel-preset-env external config support#177

Merged
ai merged 1 commit intobrowserslist:masterfrom
rmacklin:clarify-babel-present-env-comment
Sep 25, 2017
Merged

Clarify comment about babel-preset-env external config support#177
ai merged 1 commit intobrowserslist:masterfrom
rmacklin:clarify-babel-present-env-comment

Conversation

@rmacklin
Copy link
Copy Markdown
Contributor

I was reading the README and I noticed this line:
https://github.com/ai/browserslist/blob/3da9c02fee368f1aed10b9b6fd905f558f64ffe8/README.md#L10

The "no config support, only tool option" comment confused me, because if you follow the link to the babel-preset-env repository, you will find documentation about support for external config in package.json or browserlist files.

That's because the master branch of the babel-preset-env repository is for version 2.0, while the README for the latest 1.x release is only available on the 1.x branch.

Version 2.0 is currently still in beta, but it includes support for reading an external config in package.json or browserslist files (via babel/babel-preset-env#161).

With this in mind, I've updated this comment to:

external config in package.json or browserslist files supported in v2.0+

in an effort to remove this confusion. Once version 2.0 gets out of beta, we can probably remove this comment, but until then I think it's helpful, and lets users know that if they want external config support they can try the latest beta release of babel-present-env v2.0.

Previously this comment read:
> no config support, only tool option

However, this was confusing, because if you follow the link to the
babel-preset-env repository, you will find documentation about support
for external config in package.json or browserlist files:
https://github.com/babel/babel-preset-env/blame/927a3b521907fce260898208a3d30c1694917730/README.md#L108-L149

That's because the master branch of the babel-preset-env repository is
for version 2.0, while the README for the latest 1.x release is only
available on the 1.x branch.

Version 2.0 is currently still in beta, but it includes support for
reading an external config in package.json or browserslist files (via
babel/babel-preset-env#161).

With this in mind, I've updated this comment to:
> external config in package.json or browserslist files supported in v2.0+

in an effort to remove this confusion. Once version 2.0 gets out of
beta, we can probably remove this comment, but until then I think it's
helpful, and lets users know that if they want external config support
they can try the latest beta release of babel-present-env v2.0.
@ai ai merged commit 96cf993 into browserslist:master Sep 25, 2017
@rmacklin rmacklin deleted the clarify-babel-present-env-comment branch September 25, 2017 12:08
zhouyu9527 pushed a commit to zhouyu9527/browserslist that referenced this pull request Jul 5, 2022
…erslist#177)

Previously this comment read:
> no config support, only tool option

However, this was confusing, because if you follow the link to the
babel-preset-env repository, you will find documentation about support
for external config in package.json or browserlist files:
https://github.com/babel/babel-preset-env/blame/927a3b521907fce260898208a3d30c1694917730/README.md#L108-L149

That's because the master branch of the babel-preset-env repository is
for version 2.0, while the README for the latest 1.x release is only
available on the 1.x branch.

Version 2.0 is currently still in beta, but it includes support for
reading an external config in package.json or browserslist files (via
babel/babel-preset-env#161).

With this in mind, I've updated this comment to:
> external config in package.json or browserslist files supported in v2.0+

in an effort to remove this confusion. Once version 2.0 gets out of
beta, we can probably remove this comment, but until then I think it's
helpful, and lets users know that if they want external config support
they can try the latest beta release of babel-present-env v2.0.
tats-u pushed a commit to tats-u/browserslist that referenced this pull request Apr 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants