Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: add section on module resolution #184

Closed
iamclaytonray opened this issue Jul 1, 2018 · 2 comments · Fixed by #229
Closed

docs: add section on module resolution #184

iamclaytonray opened this issue Jul 1, 2018 · 2 comments · Fixed by #229
Labels
enhancement help wanted

Comments

@iamclaytonray
Copy link

I am currently playing around with Parcel on a new React app I created. Almost everything I do in JavaScript, I do in TypeScript. With that being said, I take advantage of Module Resolution. I know that absolute paths/imports were finalized in the 1.7.0 release and in this PR, but I'd like to document this.

I read some comments and while I can respect different perspectives, I know that for larger projects I work on, it's important to use absolute imports or the imports themselves get too deep/convoluted. Trying out the solution in the PR mentioned above, I do have absolute imports working but my IDE (VS Code) is going crazy with errors. This doesn't affect the actual app running but can be distracting when I am trying to debug. I think a new section on module resolution / absolute imports with Parcel can help developer experience and adoption with Parcel. (This was the biggest reason I didn't try Parcel. I just learned that this feature existed the other day.)

I can't commit to having this PR in an hour or even a week. I'd like to fully understand how everything works so I can provide some stellar docs for other people. If this sounds good to project maintainers, please let me know! Thanks for all the hard work, ladies and gents.
@iamclaytonray
Copy link
Author

Actually, that was much easier than I thought it would be. So, I can add docs if/when this get approved. Thanks!

@DeMoorJasper
Copy link
Member

Would be awesome if you could create a PR for this. (we haven't gotten around to documenting every new feature since 1.7.0 yet, see #132 ).

Every bit of help is very welcome.

@iamclaytonray iamclaytonray mentioned this issue Jul 1, 2018
Closed
@DeMoorJasper DeMoorJasper mentioned this issue Jul 5, 2018
Closed
3 tasks
@jthegedus jthegedus mentioned this issue Aug 23, 2018
Merged
DeMoorJasper pushed a commit that referenced this issue Aug 25, 2018
@jthegedus @DeMoorJasper
document module resolution strategies (#229)
ea55206 
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:
- I would like to answer this question in the docs parcel-bundler/parcel#850 (comment)
- clarify terminology of:
	- project root: top-level package.json?
	- package root: package.json in node_module module? where does this start to resolve from?
- these comments https://github.com/parcel-bundler/parcel/pull/850/files#diff-f90b0caefa8028ff5ec8f2f2c2e6e39dR8 seem to suggest I may be missing some important information that should be documented

Closes #184
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement help wanted
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

document module resolution strategies
2 participants
@DeMoorJasper @iamclaytonray