Skip to content

Unify docs about .mjs, .cjs, .js and .json config files#2150

Merged
nicolo-ribaudo merged 5 commits intobabel:masterfrom
nicolo-ribaudo:config-files-all-ests
Jan 10, 2020
Merged

Unify docs about .mjs, .cjs, .js and .json config files#2150
nicolo-ribaudo merged 5 commits intobabel:masterfrom
nicolo-ribaudo:config-files-all-ests

Conversation

@nicolo-ribaudo
Copy link
Copy Markdown
Member

@nicolo-ribaudo nicolo-ribaudo commented Jan 6, 2020

Docs for babel/babel#10903 and babel/babel#10783, follow up to #2106.

@yordis yordis mentioned this pull request Jan 6, 2020
Merged
@nicolo-ribaudo nicolo-ribaudo mentioned this pull request Jan 6, 2020
Merged
@netlify
Copy link
Copy Markdown

netlify bot commented Jan 6, 2020 •
edited
Loading

Deploy preview for babel ready!

Built with commit 8ece6f8

https://deploy-preview-2150--babel.netlify.com

existentialism
existentialism reviewed Jan 6, 2020
View reviewed changes
docs/config-files.md Outdated
- `babel.config.cjs` and `.babelrc.cjs` allow you to define your configuration as CommonJS,
using `module.exports`.

- `babel.config.mjs` and `.babelrc.mjs` use native ECMAScript modules. They are only supported by
Copy link
Copy Markdown
Member

@existentialism existentialism Jan 6, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

The "only supported..." followed by "and might work" read a bit weird. Maybe:

They are supported by Node.js 13.2+ (or older versions via the --experimental-modules flag)

@existentialism
Copy link
Copy Markdown
Member

existentialism commented Jan 6, 2020

Honestly not a fan of using babel.config.* everywhere... but I think enumerating all through all the various cases in one place is a needed improvement.

@nicolo-ribaudo
Copy link
Copy Markdown
Member Author

nicolo-ribaudo commented Jan 6, 2020

What do you think about always using babel.config.json (or babel.config.js) and only mention in one place that there are different file extensions?

Btw, I copied .* from the ESLint docs (https://eslint.org/docs/user-guide/configuring)

jaydenseric
jaydenseric reviewed Jan 10, 2020
View reviewed changes
nicolo-ribaudo and others added 2 commits January 10, 2020 21:10
@nicolo-ribaudo @jaydenseric
Update docs/configuration.md
770d95a 
Co-Authored-By: Jayden Seric <me@jaydenseric.com>
@nicolo-ribaudo
Always use .json
85da025
@nicolo-ribaudo
Copy link
Copy Markdown
Member Author

nicolo-ribaudo commented Jan 10, 2020

@existentialism I changed the docs to always use the .json extension instead .* (I chose .json because it's the simpler format). The different extensions are still explained in the config-files.md page.

existentialism
existentialism reviewed Jan 10, 2020
View reviewed changes
existentialism
existentialism reviewed Jan 10, 2020
View reviewed changes
existentialism
existentialism reviewed Jan 10, 2020
View reviewed changes
existentialism
existentialism reviewed Jan 10, 2020
View reviewed changes
existentialism
existentialism approved these changes Jan 10, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@existentialism existentialism left a comment

Choose a reason for hiding this comment

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

Just a few small nits!

nicolo-ribaudo and others added 2 commits January 10, 2020 22:02
@nicolo-ribaudo @existentialism
Apply suggestions from code review
65a3796 
Co-Authored-By: Brian Ng <bng412@gmail.com>
@nicolo-ribaudo
Review
8ece6f8
@nicolo-ribaudo nicolo-ribaudo merged commit bccc1e2 into babel:master Jan 10, 2020
@nicolo-ribaudo nicolo-ribaudo deleted the config-files-all-ests branch January 10, 2020 21:12
@nicolo-ribaudo nicolo-ribaudo mentioned this pull request Jan 14, 2020
Merged
nicolo-ribaudo added a commit to nicolo-ribaudo/babel-website that referenced this pull request Jan 20, 2020
@nicolo-ribaudo
Backport misc changes from babel#2150
7969645
@nicolo-ribaudo nicolo-ribaudo mentioned this pull request Jan 20, 2020
Merged
nicolo-ribaudo added a commit that referenced this pull request Jan 20, 2020
@nicolo-ribaudo
Cleanup 7.8.0 versioned_docs (#2160)
bd32d93 
* Backport misc changes from #2150

* Remove 7.8.0 versioned_docs without updates
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@existentialism existentialism existentialism approved these changes

+1 more reviewer

@jaydenseric jaydenseric jaydenseric left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@nicolo-ribaudo @existentialism @jaydenseric