fix(imports): remove resolve.root config in webpack

[dvdzkwsk]

…bution issues

By using resolve.root and modulesDirectories overrides with webpack, consuming packages must use webpack and must have a very specific setup in order for Stardust's imports to work correctly. By using all relative paths, Stardust is able to be consumed by any bundler/environment.

[eanplatter]

That makes sense to me, but I'm not sure if @levithomason would have any other feedback concerning this. I believe resolve.root was added in just for convenience tho.

[dvdzkwsk]

Developer convenience makes sense, but the package ultimately has to be able to be safely imported in other environments. I came across this while importing Stardust into another application without the required (and undocumented) configuration, and while it would be easy to add I wanted to put this out in the open.

[dvdzkwsk]

That said, I'm OK waiting on @levithomason for this, but it's a pretty critical fix that should be considered sooner rather than later.

[eanplatter]

Oh yeah, I just mentioned that I think convenience was the primary motivating factor, so I don't think it's a big deal to do away with. It's easy to change either way, so 🍂

[ghost]

To make this work we'll need to circle through the components in the docs directory as well.

[levithomason]

-1 to sweeping removal of root require. The test and docs are never required by consumers. Managing those paths is rather a pain without it. Example, Sidebar.js doc site component:

import META from 'src/utils/Meta';
// vs
import META from '../../../../src/utils/Meta';

^ That is a loss of readability and maintainability with no gain.

Short term
This PR does hit the right issue, the imports in src should use relative requires. This makes more sense in most cases in the src directory anyhow since most imports are from somewhere else in src directory. It also solves the original problem.

Long term
We should have a dist build.

---

EDIT
Let's update this PR to only change to the src dir imports.

[levithomason]

Side note, PR titles end up in the CHANGELOG. Let's write them in consideration of others reading them as changelog bullets.

[dvdzkwsk]

Agreed about the inconvenience in test and docs, but it's definitely a necessity for the source code. Personally I don't see how this package could be reasonably compiled to a distribution bundle due to its dependencies on lodash/jquery/semantic/etc., so it's vital that the source code be easy to import.

Sent from my iPhone

On Dec 29, 2015, at 11:10 PM, Levi Thomason notifications@github.com wrote:

-1 to sweeping removal of root require. The test and docs are never required by consumers. Managing those paths is rather a pain without it. Example, Sidebar.js doc site component:

import META from 'src/utils/Meta';
// vs
import META from '../../../../src/utils/Meta';
^ That is a loss of readability and maintainability with no gain.

Short term
This PR does hit the right issue, the imports in src should use relative requires. This makes more sense in most cases in the src directory anyhow since most imports are from somewhere else in src directory. It also solves the original problem.

Long term
We should have a dist build.

—
Reply to this email directly or view it on GitHub.

[dvdzkwsk]

Also as a side note, the only reason I removed the aliases from the test bundle is that I wanted to ensure that the source code worked without relying on webpack's custom resolve utilities.

Sent from my iPhone

On Dec 29, 2015, at 11:10 PM, Levi Thomason notifications@github.com wrote:

-1 to sweeping removal of root require. The test and docs are never required by consumers. Managing those paths is rather a pain without it. Example, Sidebar.js doc site component:

import META from 'src/utils/Meta';
// vs
import META from '../../../../src/utils/Meta';
^ That is a loss of readability and maintainability with no gain.

Short term
This PR does hit the right issue, the imports in src should use relative requires. This makes more sense in most cases in the src directory anyhow since most imports are from somewhere else in src directory. It also solves the original problem.

Long term
We should have a dist build.

—
Reply to this email directly or view it on GitHub.

[levithomason]

Cool, we should merge this as soon as possible. It's borked ATM.

EDIT
Merging :)