Move components up a level?

[dylans]

Now that widgets have been split from widget-core, I think we should move the contents of /components up a level into src. Or do we really want things to be @dojo/widgets/components/createFoo ?

[agubler]

I think you absolutely right (i noticed it the other day but forgot), I also think we should drop components directory.

[tomdye]

Agreed 👍

[rishson]

Can we also move example usage into the widget's tests dir please?
This removes the parallel dirs, and keeps everything together.
I propose someWidget/tests/example or someWidget/tests/functional as the location for the example usage / test harness.
Also happy just with top level: someWidget/example

[agubler]

@rishson I don't think that the examples should not be in the test directory, personally I think they should live along side the widgets. Such src/dialog/createDialog.ts would have src/dialog/example(s)/dialog.ts.

[rishson]

So were agreed on:

src/dialog/example
src/dialog/styles
src/dialog/createDialog.ts
tests/unit/createDialog.ts

[msssk]

I'm in favor of src only containing code relevant to the repo's core purpose, which for dojo-widgets is providing widgets. tests are not the core purpose and are rightly placed as a sibling of src, I feel like examples (which I slightly favor renaming to demos) should also be in a sibling folder of src.

This could also simplify builds - if we want to build a distribution for consumption as a dependency, the consumer just wants the widgets, not tests or examples. Compile and build everything in src and we're done, no need to specify exclusions.

Basically, everything that should be provided to a dependency consumer should go in src, anything not relevant to dependency consumers should be kept out of src.

demos/dialog/index.html
demos/dialog/index.ts
src/dialog/styles/dialog.css
src/dialog/createDialog.ts
tests/unit/createDialog.ts

[agubler]

I understand where you're coming from, but I would even prefer to have the tests in src (like jest), because then everything related is together. Don't forget just because it is src doesn't mean we'll publish it (we won't) so consumer of the package won't receive the examples.

[dylans]

@agubler would this approach just be for @dojo/widgets? I guess I would argue that examples and test probably should be there for someone learning Dojo 2, but not for a production-ready distribution?

Regardless, I think this approach would get cumbersome for something like @dojo/core, but I can see the logic for widgets because the idea is to think of each widget as independent (so each widget could live in a separate repo, but we don't want the overhead of ever widget being in a separate repo).

The only potential negative I see with this is that it will make the Intern config more complex (with regards to how you describe paths for testing and what to exclude from testing, but not overly arduous.