-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Add new options.md and config-files.md files to replace current config-file and core options docs #1787
Add new options.md and config-files.md files to replace current config-file and core options docs #1787
Conversation
Deploy preview for babel ready! Built with commit 9fb7f99 |
3c1e249
to
1c87836
Compare
docs/config-files.md
Outdated
``` | ||
the config will now be entirely ignored, because it is across a package boundary. | ||
|
||
One alternative would be to reate a `.babelrc` in each sub-package that uses ["extends"](options.md#extends) as |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo: I suppose this should have been "create" instead of "reate"
docs/config-files.md
Outdated
directory for Babel is the individual packages), the `babel.config.js` file will not be automatically | ||
loaded, and users will be required to set the path to it manually. | ||
|
||
Project-wide configs can also be disable by setting ["configFile"](options.md#configFile) to `false`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/disable/disabled/
docs/config-files.md
Outdated
Babel loads `.babelrc` (and `.babelrc.js` / `package.json#babel`) files by searching up the | ||
directory structure starting from the ["filename"](options.md#filename) being compiled. This can | ||
be powerful because it allows you to create independent configurations for subsections of | ||
a repository. File-relative configurations are also [merge](options.md#merging) over top of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/[merge]/[merged]/
docs/configuration.md
Outdated
@@ -5,7 +5,7 @@ title: Configure Babel | |||
|
|||
Babel can be configured! Many other tools have similar configs: ESLint (`.eslintrc`), Prettier (`.prettierrc`). | |||
|
|||
All Babel API [options](core.md#options) are allowed. However if the option requires JavaScript, you may need to use a `.babelrc.js` file. | |||
All Babel API [options](options.md) are allowed. However if the option requires JavaScript, you may want to use a Javascript [configuration file](config-files.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IIRC there should be a comma after "However"
1c87836
to
9fb7f99
Compare
I think this is a pretty good way to split things up. Let me know what you think!