Dust renaming and index template

mobify / stencil

DEPRECIATED - The latest Stencil development is currently taking place in the Adaptive.js repo.

MIT License

4 stars 0 forks source link

Dust renaming and index template #122

Closed nastiatikk closed 9 years ago

nastiatikk commented 9 years ago

Updates:

*.dust files don't have underscore in the filename as there is no need for it.
index.html template added to the /templates folder.

Status: Ready for Review

Reviewers: @jeffkamo @avelinet @ry5n @mlworks @kpeatt @cole-sanderson

kpeatt commented 9 years ago

@nastiatikk what's the goal of this?

nastiatikk commented 9 years ago

@kpeatt consistency in filenames and providing all necessary files to work with

Dust templates don't need in the filename. It was used to detach visually partials from components in the earlier projects, but then partials were moved to its own folder and was discarded.
index.html is a template for /test folder to start building the test page (instead of copying index.html from the other component)

ry5n commented 9 years ago

I agree we don’t need the underscore in front of template filenames.

As far as adding the index.html, this is a template for the component’s test html. The trouble is that with the current folder structure, the tests live separately, so the name and placement here doesn’t mirror the rest of the repo, and could be confusing. I think we should move it to template/tests/visual/index.html and add templates/tests/visual/template.scss.

nastiatikk commented 9 years ago

In this case we also need to create a /template folder in the /dist folder and remove /template from the root directory.

From the other side this folder (by name) contains all templates. There are not many of them to get confused. And in the documentation (that hopefully will be merged soon) you'll see each file destination.

I'm fine with any of these solutions.

ry5n commented 9 years ago

No, we don’t want scaffolding in dist. What I mean is instead of index.html right inside templates, move it to templates/tests/visual/ so that it’s clear what it’s for. It’s not perfect, but until we have each component in a separate repo I think it’s a good compromise.

nastiatikk commented 9 years ago

Hm… I can't agree. For me it looks much more complicated. If we do this we also should move scss and dust files to /templates/dist/components and /templates/dist/utils (even if they're the same) what becomes super complicated for just 5 files. And if we move just test files to its own folder it won't be consistent and will be confusing.

ry5n commented 9 years ago

I see what you mean, but I agree I don’t want to do that either. We definitely need some way of clarifying what index.html is though. I’d be happy for now if we just put it in templates/tests/.

nastiatikk commented 9 years ago

@ry5n Will it be more clear with these instructions? What do you think https://github.com/mobify/stencil/pull/123

ry5n commented 9 years ago

That will definitely help. I still think we should at least have scaffolding for tests in their own subfolder. It’s not a big change from what you have.

jeffkamo commented 9 years ago

@nastiatikk: So for now can we put index.html in /tests? We can flesh out the test directory structure later. But in the mean time, let's not block #123

nastiatikk commented 9 years ago

Can we for now leave it in the /template folder? https://github.com/mobify/stencil/pull/123 instructions use /template folder structure, not /template/tests/visual

jeffkamo commented 9 years ago

sure