Merge pull request #361 from pattern-lab/dev-2.0-core

2.0.0-alpha

Author: Brian Muenzenmeyer

.eslintrc

@@ -14,8 +14,8 @@
     "eqeqeq": [2, "allow-null"],
     "global-strict": [0, "never"],
     "guard-for-in": 2,
-    "indent": [2, 2, {"SwitchCase": 1, "VariableDeclarator": 1}],
-    "lines-around-comment": [2, {
+    "indent": [1, 2, {"SwitchCase": 1, "VariableDeclarator": 1}],
+    "lines-around-comment": [1, {
       "beforeBlockComment": true,
       "beforeLineComment": true,
       "allowBlockStart": true,

.gitignore

@@ -1,5 +1,4 @@
 node_modules/
-npm-debug.log
 .DS_Store
 latest-change.txt
 patternlab.json

.travis.yml

@@ -1,10 +1,10 @@
 language: node_js
 
 node_js:
-  - stable
-  - 4.0
-  - 0.12
-  - 0.11
+  - node
+  - 6
+  - 5
+  - 4
 
 before_install:
   - phantomjs --version
@@ -16,3 +16,12 @@ branches:
   only:
     - master
     - dev
+    - dev-2.0-core
+
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/a14f537f16b0756d9470
+    on_success: always
+    on_failure: always
+    on_start: never

Gruntfile.js

@@ -1,168 +1,41 @@
 module.exports = function (grunt) {
 
-  var path = require('path');
-
-  function paths() {
-    return require('./patternlab-config.json').paths;
-  }
-
-  // Project configuration.
+  /******************************
+   * Project configuration.
+   * Should only be needed if you are developing against core, running tests, linting and want to run tests or increment package numbers
+   *****************************/
   grunt.initConfig({
     pkg: grunt.file.readJSON('package.json'),
     concat: {
       options: {
         stripBanners: true,
-        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',
+        banner: '/* \n * <%= pkg.name %> - v<%= pkg.version %> - <%= grunt.template.today("yyyy") %> \n * \n * <%= pkg.author.name %>, <%= pkg.contributors[0].name %>, 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: './core/lib/patternlab.js',
         dest: './core/lib/patternlab.js'
-      },
-      object_factory: {
-        src: './core/lib/object_factory.js',
-        dest: './core/lib/object_factory.js'
-      },
-      lineage: {
-        src: './core/lib/lineage_hunter.js',
-        dest: './core/lib/lineage_hunter.js'
-      },
-      media_hunter: {
-        src: './core/lib/media_hunter.js',
-        dest: './core/lib/media_hunter.js'
-      },
-      patternlab_grunt: {
-        src: './core/lib/patternlab_grunt.js',
-        dest: './core/lib/patternlab_grunt.js'
-      },
-      patternlab_gulp: {
-        src: './core/lib/patternlab_gulp.js',
-        dest: './core/lib/patternlab_gulp.js'
-      },
-      parameter_hunter: {
-        src: './core/lib/parameter_hunter.js',
-        dest: './core/lib/parameter_hunter.js'
-      },
-      pattern_exporter: {
-        src: './core/lib/pattern_exporter.js',
-        dest: './core/lib/pattern_exporter.js'
-      },
-      pattern_assembler: {
-        src: './core/lib/pattern_assembler.js',
-        dest: './core/lib/pattern_assembler.js'
-      },
-      pseudopattern_hunter: {
-        src: './core/lib/pseudopattern_hunter.js',
-        dest: './core/lib/pseudopattern_hunter.js'
-      },
-      list_item_hunter: {
-        src: './core/lib/list_item_hunter.js',
-        dest: './core/lib/list_item_hunter.js'
-      },
-      style_modifier_hunter: {
-        src: './core/lib/style_modifier_hunter.js',
-        dest: './core/lib/style_modifier_hunter.js'
-      }
-    },
-    copy: {
-      main: {
-        files: [
-          { expand: true, cwd: path.resolve(paths().source.js), src: '*.js', dest: path.resolve(paths().public.js) },
-          { expand: true, cwd: path.resolve(paths().source.css), src: '*.css', dest: path.resolve(paths().public.css) },
-          { expand: true, cwd: path.resolve(paths().source.images), src: ['**/*.png', '**/*.jpg', '**/*.gif', '**/*.jpeg'], dest: path.resolve(paths().public.images) },
-          { expand: true, cwd: path.resolve(paths().source.fonts), src: '*', dest: path.resolve(paths().public.fonts) },
-          { expand: true, cwd: path.resolve(paths().source.data), src: 'annotations.js', dest: path.resolve(paths().public.data) }
-        ]
-      },
-      styleguide: {
-        files: [
-          { expand: true, cwd: path.resolve(paths().source.styleguide), src: ['*.*', '**/*.*'], dest: path.resolve(paths().public.styleguide) }
-        ]
-      }
-    },
-    watch: {
-      all: {
-        files: [
-          path.resolve(paths().source.css + '**/*.css'),
-          path.resolve(paths().source.styleguide + 'css/*.css'),
-          path.resolve(paths().source.patterns + '**/*.mustache'),
-          path.resolve(paths().source.patterns + '**/*.json'),
-          path.resolve(paths().source.fonts + '/*'),
-          path.resolve(paths().source.images + '/*'),
-          path.resolve(paths().source.data + '*.json'),
-          path.resolve(paths().source.js + '/*.js')
-        ],
-        tasks: ['default', 'bsReload:css']
       }
     },
     nodeunit: {
       all: ['test/*_tests.js']
     },
-    browserSync: {
-      dev: {
-        options: {
-          server:  path.resolve(paths().public.root),
-          watchTask: true,
-          watchOptions: {
-            ignoreInitial: true,
-            ignored: '*.html'
-          },
-          snippetOptions: {
-            // Ignore all HTML files within the templates folder
-            blacklist: ['/index.html', '/', '/?*']
-          },
-          plugins: [
-            {
-              module: 'bs-html-injector',
-              options: {
-                files: [path.resolve(paths().public.root + '/index.html'), path.resolve(paths().public.styleguide + '/styleguide.html')]
-              }
-            }
-          ],
-          notify: {
-            styles: [
-              'display: none',
-              'padding: 15px',
-              'font-family: sans-serif',
-              'position: fixed',
-              'font-size: 1em',
-              'z-index: 9999',
-              'bottom: 0px',
-              'right: 0px',
-              'border-top-left-radius: 5px',
-              'background-color: #1B2032',
-              'opacity: 0.4',
-              'margin: 0',
-              'color: white',
-              'text-align: center'
-            ]
-          }
-        }
-      }
-    },
     eslint: {
       options: {
         configFile: './.eslintrc'
       },
       target: ['./core/lib/*']
-    },
-    bsReload: {
-      css: path.resolve(paths().public.root + '**/*.css')
     }
   });
 
   // load all grunt tasks
-  require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);
-
-  //load the patternlab task
-  grunt.task.loadTasks('./core/lib/');
-
-  grunt.registerTask('default', ['patternlab', 'copy:main', 'copy:styleguide']);
+  grunt.loadNpmTasks('grunt-contrib-concat');
+  grunt.loadNpmTasks('grunt-eslint');
+  grunt.loadNpmTasks('grunt-contrib-nodeunit');
 
   //travis CI task
-  grunt.registerTask('travis', ['nodeunit', 'eslint', 'patternlab']);
-
-  grunt.registerTask('serve', ['patternlab', 'copy:main', 'copy:styleguide', 'browserSync', 'watch:all']);
+  grunt.registerTask('travis', ['nodeunit', 'eslint']);
 
+  //to be run prior to releasing a version
   grunt.registerTask('build', ['nodeunit', 'eslint', 'concat']);
 
 };

core/lib/annotation_exporter.js

@@ -0,0 +1,113 @@
+"use strict";
+
+var annotations_exporter = function (pl) {
+  var path = require('path'),
+    fs = require('fs-extra'),
+    JSON5 = require('json5'),
+    _ = require('lodash'),
+    md = require('markdown-it')(),
+    paths = pl.config.paths;
+
+  /*
+  Returns the array of comments that used to be wrapped in raw JS.
+   */
+  function parseAnnotationsJS() {
+    //attempt to read the file
+    try {
+      var oldAnnotations = fs.readFileSync(path.resolve(paths.source.annotations, 'annotations.js'), 'utf8');
+    } catch (ex) {
+      console.log('annotations.js file missing from ' + paths.source.annotations + '. This may be expected.');
+      return [];
+    }
+
+    //parse as JSON by removing the old wrapping js syntax. comments and the trailing semi-colon
+    oldAnnotations = oldAnnotations.replace('var comments = ', '');
+    try {
+      var oldAnnotationsJSON = JSON5.parse(oldAnnotations.trim().slice(0, -1));
+    } catch (ex) {
+      console.log('There was an error parsing JSON for ' + paths.source.annotations + 'annotations.js');
+      console.log(ex);
+      return [];
+    }
+    return oldAnnotationsJSON.comments;
+  }
+
+  /*
+   Converts the annotations.md file yaml list into an array of annotations
+   */
+  function parseAnnotationsMD() {
+    var annotations = [];
+
+    //attempt to read the file
+    var annotationsMD = '';
+    try {
+      annotationsMD = fs.readFileSync(path.resolve(paths.source.annotations, 'annotations.md'), 'utf8');
+    } catch (ex) {
+      console.log('annotations.md file missing from ' + paths.source.annotations + '. This may be expected.');
+      return [];
+    }
+
+    //take the annotation snippets and split them on our custom delimiter
+    var annotationsYAML = annotationsMD.split('~*~');
+    for (var i = 0; i < annotationsYAML.length; i++) {
+      var annotation = {};
+
+      //for each annotation process the yaml frontmatter and markdown
+      var annotationSnippet = annotationsYAML[i];
+      var annotationsRE = /---\r?\n{1}([\s\S]*)---\r?\n{1}([\s\S]*)+/gm;
+      var chunks = annotationsRE.exec(annotationSnippet);
+      if (chunks && chunks[1] && chunks[2]) {
+
+        //convert each yaml frontmatter key into an object key
+        var frontmatter = chunks[1];
+        var frontmatterLines = frontmatter.split(/\n/gm);
+        for (var j = 0; j < frontmatterLines.length; j++) {
+          var frontmatterLine = frontmatterLines[j];
+          if (frontmatterLine.length > 0) {
+            var frontmatterLineChunks = frontmatterLine.split(':'); //test this
+            var frontmatterKey = frontmatterLineChunks[0].toLowerCase().trim();
+            var frontmatterValueString = frontmatterLineChunks[1].trim();
+            var frontmatterValue = frontmatterValueString.substring(1, frontmatterValueString.length - 1);
+            if (frontmatterKey === 'el' || frontmatterKey === 'selector') {
+              annotation.el = frontmatterValue;
+            }
+            if (frontmatterKey === 'title') {
+              annotation.title = frontmatterValue;
+            }
+          }
+        }
+
+        //set the comment to the parsed markdown
+        var annotationMarkdown = chunks[2];
+        annotation.comment = md.render(annotationMarkdown);
+
+        annotations.push(annotation);
+      } else {
+        console.log('annotations.md file not formatted as expected. Error parsing frontmatter and markdown out of ' + annotationSnippet);
+      }
+    }
+    return annotations;
+  }
+
+  function gatherAnnotations() {
+    var annotationsJS = parseAnnotationsJS();
+    var annotationsMD = parseAnnotationsMD();
+    var mergedAnnotations = _.unionBy(annotationsJS, annotationsMD, 'el');
+    return mergedAnnotations;
+  }
+
+  return {
+    gather: function () {
+      return gatherAnnotations();
+    },
+    gatherJS: function () {
+      return parseAnnotationsJS();
+    },
+    gatherMD: function () {
+      return parseAnnotationsMD();
+    }
+  };
+
+};
+
+module.exports = annotations_exporter;