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.

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

Restructure filesystem to better align concerns and support upgrades #133

Closed
1 task done
bmuenzenmeyer opened this issue Aug 1, 2015 · 12 comments
Closed
1 task done

Comments

@bmuenzenmeyer
Copy link
Member

Basically https://github.com/pattern-lab/patternlab-php/releases/tag/v0.7.0

  • Move _patternlab-files out of source to make upgrading easier for users
  • Restructure filesystem to allow for metapatterns
  • Make a clearer distinction between source and pl code.

  • Edit New issue
    meta patterns missing?

UPDATE
I've mapped this work on the wiki

@bmuenzenmeyer bmuenzenmeyer added this to the v1.0.0 milestone Aug 1, 2015
@bmuenzenmeyer bmuenzenmeyer mentioned this issue Aug 1, 2015
@bmuenzenmeyer bmuenzenmeyer modified the milestones: v1.0.0, v0.12.0 Aug 1, 2015
@bmuenzenmeyer bmuenzenmeyer modified the milestones: v1.0.0, v0.13.0 Sep 4, 2015
@Xiphe
Copy link

Xiphe commented Sep 24, 2015

Do you have any plans on how you want to do this?

I've lately put some time into isolating grunt tooling from our projects.
We achieve that by having all tools in one single npm package that is then loaded and configured in a projects gruntfile.
I feel that this would be a great way, for this project to maintain upgradability and prevent monkey-patching.

Let me know how you think about this :)

@e2tha-e
Copy link
Contributor

e2tha-e commented Sep 24, 2015

Excited for this to happen!

@bmuenzenmeyer
Copy link
Member Author

Hi all

My current scope for this is to clarify the source code which I'd expect a user to alter from the code necessary to make the pattern-lab style guide frontend run. PL-PHP has restructured source/_patternlab-files/* out of source for a long time now - and this would be step one.

I do want to look at the link you provided more and generally create a more future-friendly file structure that is approachable to newcomers.

Stay tuned

@Xiphe
Copy link

Xiphe commented Sep 25, 2015

Nice, feel free to contact me if you want to chat :)

Just as a feedback on this topic:
We already have a working design system with our own structure and a bunch of grunt tooling. We would have loved to use pattern-lab as a frontend and follow the suggested structures - Sadly the merge of this project into ours would have been very complicated and we would have lost/rebuild lots of our own tooling.
It would have been easier if this where a plain npm tool or grunt/gulp task that one can just use in any project. Not saying that it needs to be like this, i can totally see the benefits of having a project scaffold that just works, this is just the story of my team :)

@Xiphe
Copy link

Xiphe commented Sep 25, 2015

While re-reading i just figured, that the moving of _patternlab-files would totally enable this. These files can then live in their own project that has build tools and everything one can imagine while the pattern-lab project is just the frontend.

@e2tha-e
Copy link
Contributor

e2tha-e commented Oct 14, 2015

@bmuenzenmeyer @Xiphe Has there been any development on this? My current work requires this separation of concerns so I'll start on this myself if there's nothing already in development.

@bmuenzenmeyer
Copy link
Member Author

@e2tha-e No there isn't yet. The goal will be to align the filesystem like PL PHP wherever possible.

The roadmap places this after v0.14.0 which has the last big feature gap #95
I am slow to get to this. Would you want to take a shot at it?

@bmuenzenmeyer
Copy link
Member Author

@e2tha-e I was thinking more about this versus #95 I'd hate for us to have a bunch of conflicts due to a giant file reorg while working through this feature. Though I think this can probably get shoe-horned into pattern assembler without too much trouble...

You've been a workhorse of late, just trying to figure out how best to coordinate our time. Thoughts?

@bmuenzenmeyer
Copy link
Member Author

Also sorry for comment spam but I very much intend to include:

both of these repo's into patternlab node as part of this solution and therefore might want to tackle all this myself.

@e2tha-e
Copy link
Contributor

e2tha-e commented Oct 15, 2015

@bmuenzenmeyer I haven't begun any work on this, so it would probably be better for you to come up with an approach that accommodates the code in those other repos. I can monkey-patch things like js and css includes in the header and footer for the time being, but it won't be sustainable for very long.

@Xiphe
Copy link

Xiphe commented Oct 15, 2015

We're not using patternlab-node right now, so no progress from my site.

@bmuenzenmeyer bmuenzenmeyer changed the title Move _patternlab-files out of source to make upgrading easier for users Restructure filesystem to better align concerns and support upgrades Oct 15, 2015
@bmuenzenmeyer bmuenzenmeyer removed this from the v1.0.0 milestone Nov 25, 2015
@bmuenzenmeyer bmuenzenmeyer added this to the v1.2.0 milestone Jan 21, 2016
@bmuenzenmeyer bmuenzenmeyer self-assigned this Mar 1, 2016
@bmuenzenmeyer
Copy link
Member Author

Starting this today

bmuenzenmeyer added a commit that referenced this issue Mar 2, 2016
passing unit tests and building frontend

#133
bmuenzenmeyer added a commit that referenced this issue Mar 2, 2016
move source/_patternlab-files/pattern-header-footer to core/source/_meta
updated config entries

#133
bmuenzenmeyer added a commit that referenced this issue Mar 4, 2016
add user defined atoms-_head and atoms-_foot pattern
move patterns to account for new dir
move footer and header to proper place
inject header and footer into styleguide, index, and pattern html
bmuenzenmeyer pushed a commit that referenced this issue Feb 23, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants