Merge pull request #280 from pattern-lab/133

Restructure filesystem to better align concerns and support upgrades

Author: Brian Muenzenmeyer

Gruntfile.js

@@ -15,52 +15,52 @@ module.exports = function (grunt) {
         banner: '/* \n * <%= pkg.name %> - v<%= pkg.version %> - <%= grunt.template.today("yyyy") %> \n * \n * <%= pkg.author %>, and the web community.\n * Licensed under the <%= pkg.license %> license. \n * \n * Many thanks to Brad Frost and Dave Olsen for inspiration, encouragement, and advice. \n *\n */\n\n',
       },
       patternlab: {
-        src: './builder/patternlab.js',
-        dest: './builder/patternlab.js'
+        src: './core/lib/patternlab.js',
+        dest: './core/lib/patternlab.js'
       },
       object_factory: {
-        src: './builder/object_factory.js',
-        dest: './builder/object_factory.js'
+        src: './core/lib/object_factory.js',
+        dest: './core/lib/object_factory.js'
       },
       lineage: {
-        src: './builder/lineage_hunter.js',
-        dest: './builder/lineage_hunter.js'
+        src: './core/lib/lineage_hunter.js',
+        dest: './core/lib/lineage_hunter.js'
       },
       media_hunter: {
-        src: './builder/media_hunter.js',
-        dest: './builder/media_hunter.js'
+        src: './core/lib/media_hunter.js',
+        dest: './core/lib/media_hunter.js'
       },
       patternlab_grunt: {
-        src: './builder/patternlab_grunt.js',
-        dest: './builder/patternlab_grunt.js'
+        src: './core/lib/patternlab_grunt.js',
+        dest: './core/lib/patternlab_grunt.js'
       },
       patternlab_gulp: {
-        src: './builder/patternlab_gulp.js',
-        dest: './builder/patternlab_gulp.js'
+        src: './core/lib/patternlab_gulp.js',
+        dest: './core/lib/patternlab_gulp.js'
       },
       parameter_hunter: {
-        src: './builder/parameter_hunter.js',
-        dest: './builder/parameter_hunter.js'
+        src: './core/lib/parameter_hunter.js',
+        dest: './core/lib/parameter_hunter.js'
       },
       pattern_exporter: {
-        src: './builder/pattern_exporter.js',
-        dest: './builder/pattern_exporter.js'
+        src: './core/lib/pattern_exporter.js',
+        dest: './core/lib/pattern_exporter.js'
       },
       pattern_assembler: {
-        src: './builder/pattern_assembler.js',
-        dest: './builder/pattern_assembler.js'
+        src: './core/lib/pattern_assembler.js',
+        dest: './core/lib/pattern_assembler.js'
       },
       pseudopattern_hunter: {
-        src: './builder/pseudopattern_hunter.js',
-        dest: './builder/pseudopattern_hunter.js'
+        src: './core/lib/pseudopattern_hunter.js',
+        dest: './core/lib/pseudopattern_hunter.js'
       },
       list_item_hunter: {
-        src: './builder/list_item_hunter.js',
-        dest: './builder/list_item_hunter.js'
+        src: './core/lib/list_item_hunter.js',
+        dest: './core/lib/list_item_hunter.js'
       },
       style_modifier_hunter: {
-        src: './builder/style_modifier_hunter.js',
-        dest: './builder/style_modifier_hunter.js'
+        src: './core/lib/style_modifier_hunter.js',
+        dest: './core/lib/style_modifier_hunter.js'
       }
     },
     copy: {
@@ -142,7 +142,7 @@ module.exports = function (grunt) {
       options: {
         configFile: './.eslintrc'
       },
-      target: ['./builder/*']
+      target: ['./core/lib/*']
     },
     bsReload: {
       css: path.resolve(paths().public.root + '**/*.css')
@@ -153,7 +153,7 @@ module.exports = function (grunt) {
   require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);
 
   //load the patternlab task
-  grunt.task.loadTasks('./builder/');
+  grunt.task.loadTasks('./core/lib/');
 
   grunt.registerTask('default', ['patternlab', 'copy:main', 'copy:styleguide']);
 

README.md

@@ -34,8 +34,8 @@ This repository ships with two `package.json` files, a `Gruntfile.js`, and a `gu
 To run patternlab-node using grunt, do the following in the directory you downloaded and extracted the zipped release:
 
 1. Run `npm install` from the command line
-2. Optionally, delete `package.gulp.json`, `gulpfile.js`, and `builder/patternlab_gulp.js` files if you are certain you don't need it.
-* Not deleting `builder/patternlab_gulp.js` may cause a harmless error when running grunt. Delete it.
+2. Optionally, delete `package.gulp.json`, `gulpfile.js`, and `core/lib/patternlab_gulp.js` files if you are certain you don't need it.
+* Not deleting `core/lib/patternlab_gulp.js` may cause a harmless error when running grunt. Delete it.
 3. Run `grunt` or `grunt serve` from the command line
 
 This creates all patterns, the styleguide, and the pattern lab site. It's strongly recommended to run `grunt serve` to have BrowserSync spin up and serve the files to you.
@@ -164,6 +164,16 @@ Pattern states should be lowercase and use hyphens where spaces are present.
 
 Coupled with exported css (much easier to extract with existing tools like [grunt-contrib-copy](https://github.com/gruntjs/grunt-contrib-copy)), pattern export can help to maintain the relevancy of the design system by directly placing partials in a directory of your choosing.
 
+##### cacheBust
+`config.json` has this flag to instruct Pattern Lab to append a unique query string to Javascript and CSS assets throughout the frontend.
+
+```
+"cacheBust": true
+```
+
+Default: true
+
+
 ##### baseurl
 
 If your instance of Pattern Lab lives in a subdirectory of your server, for instance on github pages (ex: yourusername.github.io/patterns-demo/), then add the baseurl here. The baseurl is everything after the hostname - ie: `patterns-demo`

config.json

@@ -5,7 +5,7 @@
       "patterns" : "./source/_patterns/",
       "data" : "./source/_data/",
       "styleguide" : "./core/styleguide/",
-      "patternlabFiles" : "./source/_patternlab-files/",
+      "patternlabFiles" : "./core/",
       "js" : "./source/js",
       "images" : "./source/images",
       "fonts" : "./source/fonts",
@@ -53,5 +53,6 @@
   },
   "patternExportKeys": [],
   "patternExportDirectory": "./pattern_exports/",
-  "baseurl" : ""
+  "baseurl" : "",
+  "cacheBust": true
 }