document module resolution strategies #229
Conversation
add section on monorepo resolution
better explain JS named export aliasing
| } | ||
| ``` | ||
|
|
||
| Avoid using `~` in your aliases as it is already used by parcel as mentioned earlier. |
There was a problem hiding this comment.
Users should probably avoid using any special characters all together.
@ will try to resolve npm orgs
~ will try to resolve tilde paths
and more characters might be added in the future either from npm, parcel or some third party extension/plugin
|
|
||
| ## Absolute Paths | ||
|
|
||
| `/foo` will resolve `foo` relative to the **project root** (top-level `package.json`) |
There was a problem hiding this comment.
This isn't correct, project-root isn't related to package.json as package.json is an optional file and therefore makes it impossible for us to use it as a project root.
Project root is the directory of the entrypoint or the shared root in case of multiple entrypoints, you can have a look at how it works here: https://github.com/parcel-bundler/parcel/blob/master/src/utils/getRootDir.js
|
|
||
| ### Monorepo Resolution | ||
|
|
||
| TODO: answer this - https://github.com/parcel-bundler/parcel/pull/850#issuecomment-372105317 |
There was a problem hiding this comment.
As far as I've tried tilde paths don't work inside aliased packages and monorepos, I might be wrong though.
My advice would be to avoid tilde paths altogether and use relative paths as much as possible and preferably as explicit as possible (use extensions and such). And if you really need a root path, use /
fix emoji
* fill out monorepo section * better advice around special characters as aliases * fix error about project-root terminology
* clarify feedback comment applies to monorepo users
* fix noun capitalisation
|
@DeMoorJasper Thanks for the feedback, I've made updates which I think provide sufficient fixes 😃 |
* fix json codeblock so github diff isn't angry
* properly fix json codeblock so github diff isn't angry
| Advised usage: | ||
|
|
||
| - use relative paths. | ||
| - be as explicit as possible (use file extensions). |
There was a problem hiding this comment.
This wasn't scoped at monorepo's this should be advised across all code as not using extensions causes Parcel to guess the extension possibly linking the wrong file. (if 2+ files would have the same name but diff extension)
Everything else looks good :)
* move recommendation of file ext specificity to alias section
This is my initial attempt at resolving #184, #132 and documenting parcel-bundler/parcel#850
I have a few questions which I believe should be answered and better described before merging:
Closes #184