Separate Core files from static assets resources

[mateusvahl]

Current pattern lab node is essentially the builder and test folders.

• if I wanna to start an new project I get folders related to Pattern Lab Node, examples "test, builder, .github".
• If I add my own dependecies it get mixed with pattern lab node, since it shares package.json.
• If I wanna to update the project to a new Pattern Lab version I need know exactly which folder or file needs to be replaced or merged.

Proposal

Separate the Pattern Lab core fom assets files: everything that is not directed related to the project core goes to an folder blueprint, example of project structure:

  ├ builder
  ├ tests
  ├ blueprint
  ├── core/styleguide
  ├──── other folders and files...
  ├── source
  ├──── other folders and files...
  ├── Gruntfile.js
  ├── config.json
  ├── gulpfile.js
  ├── package.gulp.json
  ├── package.json

How will be using it:

Installing
$ npm install -g patternlab-node

Generate the project at first time
$ patternlab-node generate myproject --gulp

  Generating Pattern Lab...
       ├ myproject
       ├── core
       ├──── other folders...
       ├── source
       ├──── other folders...
       ├── config.json
       ├── gulpfile.js
       ├── package.json

Running gulp or grunt server

$ patternlab-node run

Pattern lab is running on http://localhost:3000/

Questions

1. How create an global module?
   At package.json we add the follow key:

"bin": {                                                                                                                                                                                                                                                                                               
  "pattern-lab": "./some-script-to-pattern-lab.js"                                                                                                                                      
}, 

run: npm install -g

2. How create an new pattern lab project?
   run: patternlab-node generate myproject --gulp will basic copy the content of the blueprint folder.

let me know if I was not clear,
Thanks :)

[bmuenzenmeyer]

Hey @Mateuspv

Have you checked out this on the wiki? I think it addresses your core desires.

In addition to that - the file system will be undergoing some changes in the future - but it will align with the PHP version per #133 and https://github.com/pattern-lab/patternlab-node/wiki/Proposed-filesystem-restructure