Better support monorepos by allowing users to opt into automatically resolving 'root' with rootMode: "upward".
#8660
Conversation
loganfsmyth
added
PR: New Feature 🚀
|
Build successful! You can test your changes in the REPL here: https://babeljs.io/repl/build/9097/ |
|
Build successful! You can test your changes in the REPL here: https://babeljs.io/repl/build/9063/ |
loganfsmyth
force-pushed
the
config-root-search-2
branch
from
c4a4119
to
aeea6a4
Compare
| throw Object.assign( | ||
| (new Error( | ||
| `Babel was run with autoRoot:true but a root babel.config.js could not ` + | ||
| `be found when searching from "${rootDir}"`, |
There was a problem hiding this comment.
To help the user troubleshoot its setup, we could log every dir?
[...] when searching in
/babel/a,/babel,/, ...
There was a problem hiding this comment.
I tweaked the text to mention the upward search, do you think that's enough? I worry that including all the directories would make the error harder to read.
|
Note for members: need documentation |
| @@ -24,6 +24,30 @@ const BABELRC_FILENAME = ".babelrc"; | |||
| const BABELRC_JS_FILENAME = ".babelrc.js"; | |||
| const BABELIGNORE_FILENAME = ".babelignore"; | |||
|
|
|||
| export function findClosestConfig(rootDir: string): string { | |||
There was a problem hiding this comment.
Instead of Closes, which is not very accurate, could we name this: findConfigUpwards, findParentConfig, etc.
There was a problem hiding this comment.
Those are good suggestions, thanks. I'll go with findConfigUpwards.
loganfsmyth
force-pushed
the
config-root-search-2
branch
from
aeea6a4
to
827b30c
Compare
loganfsmyth
changed the title
autoRoot: true.rootMode: "upward".
|
|
||
| throw Object.assign( | ||
| (new Error( | ||
| `Babel was run with rootMode:"${rootMode}" but a root could not ` + |
There was a problem hiding this comment.
Nit: No need to interpolate, you can just write rootMode: "upward".
There was a problem hiding this comment.
Thanks! I moved the code around and forgot to update this snippet.
loganfsmyth
force-pushed
the
config-root-search-2
branch
from
827b30c
to
859bde0
Compare
|
Docs posted in babel/website#1822 |
| ); | ||
| } | ||
| default: | ||
| throw new Error(`Assertion failure - unknown rootMode value`); |
There was a problem hiding this comment.
We could also link to the website to learn more.
There was a problem hiding this comment.
I don't generally do that with assertions. This is mostly here to satisfy Flow. The user should never see this and if we got here, it means Flow didn't catch a type error somewhere, since it would mean we got a RootMode type that didn't match the type definition.
There was a problem hiding this comment.
Got you, there's a config validation before that anyway (assertRootMode).
Just FYI I used to use https://github.com/xtuc/mamacro#examples for only assertion, they are quite close to C ones.
|
|
||
| const nextDir = path.dirname(dirname); | ||
| if (dirname === nextDir) break; | ||
| dirname = nextDir; |
There was a problem hiding this comment.
Maybe we could set a max limit, we can be almost sure to not find any config after 30 iterations. That will avoid tranversing the whole system in some special setups.
There was a problem hiding this comment.
We do this type of loop in several places during config resolution. I'm not sure it's worth it to over-optimize up front, especially since you have to opt into the upward-optional mode for it to have been wasted time.
There was a problem hiding this comment.
Ok that make sense, i'm just worried about some undebuggable issues that it could cause.
|
@hzoo Good call, done! |
lock
bot
added
the
outdated
This is an alternative to #8636 that is a bit simpler. It introduces a separate
rootMode: "root" | "upward" | "upward-optional"option. From the docs PR:"root"- Passes the"root"value through as unchanged."upward"- Walks upward from the"root"directory, lookingfor a directory containing a
babel.config.jsfile, and throws an error if a
babel.config.jsis not found.
"upward-optional"- Walk upward from the"root"directory,looking for a directory containing a
babel.config.jsfile, and falls back to
"root"if ababel.config.jsis not found.
Otherwise, this is very similar to #8636 and has all of the same requirements of it being an opt-in feature.