#540 JSLint and documentation, enable ES6 in .eslintrc

Author: Tobias Brennecke

.eslintrc

@@ -1,7 +1,8 @@
 {
   "env": {
     "node": true,
-    "builtin": true
+    "builtin": true,
+    "es6": true
   },
   "parserOptions": {
     "ecmaVersion": 6,

core/lib/changes_hunter.js

@@ -2,15 +2,29 @@
 const fs = require("fs-extra"),
   CompileState = require('./object_factory').CompileState;
 
-
-
-let changesHunter = function() {
+/**
+ * For detecting changed patterns.
+ * @constructor
+ */
+let ChangesHunter = function () {
 };
 
-changesHunter.prototype = {
+ChangesHunter.prototype = {
+
+  /**
+   * Checks the build state of a pattern by comparing the modification date of the rendered output
+   * file with the {@link Pattern.lastModified}. If the pattern was modified after the last
+   * time it has been rendered, it is flagged for rebuilding via {@link CompileState.NEEDS_REBUILD}.
+   *
+   * @param {Pattern} pattern
+   * @param patternlab
+   *
+   * @see {@link CompileState}
+   */
   checkBuildState: function (pattern, patternlab) {
+
     //write the compiled template to the public patterns directory
-    var renderedTemplatePath =
+    let renderedTemplatePath =
       patternlab.config.paths.public.patterns + pattern.getPatternLink(patternlab, 'rendered');
 
     if (!pattern.compileState) {
@@ -20,7 +34,7 @@ changesHunter.prototype = {
     try {
       // Prevent error message if file does not exist
       fs.accessSync(renderedTemplatePath, fs.F_OK);
-      var outputLastModified = fs.statSync(renderedTemplatePath).mtime.getTime();
+      let outputLastModified = fs.statSync(renderedTemplatePath).mtime.getTime();
 
       if (pattern.lastModified && outputLastModified > pattern.lastModified) {
         pattern.compileState = CompileState.CLEAN;
@@ -45,13 +59,15 @@ changesHunter.prototype = {
   /**
    * Updates {Pattern#lastModified} to the files modification date if the file was modified
    * after {Pattern#lastModified}.
+   *
    * @param {Pattern} currentPattern
    * @param {string} file
    */
   checkLastModified: function (currentPattern, file) {
     if (file) {
       try {
         let stat = fs.statSync(file);
+
         // Needs recompile whenever one of the patterns files (template, json, pseudopatterns) changed
         currentPattern.lastModified =
           Math.max(stat.mtime.getTime(), currentPattern.lastModified || 0);
@@ -62,4 +78,4 @@ changesHunter.prototype = {
   }
 };
 
-module.exports = changesHunter;
+module.exports = ChangesHunter;

core/lib/lineage_hunter.js

@@ -33,6 +33,7 @@ var lineage_hunter = function () {
           }
 
           patternlab.graph.add(ancestorPattern);
+
           // Confusing: pattern includes "ancestorPattern", not the other way round
           patternlab.graph.link(pattern, ancestorPattern);
 
@@ -70,10 +71,11 @@ var lineage_hunter = function () {
   function setPatternState(direction, pattern, targetPattern, graph) {
     var index = null;
     if (direction === 'fromPast') {
-      index  = graph.lineage(pattern);
+      index = graph.lineage(pattern);
     } else {
       index = graph.lineageR(pattern);
     }
+
     // if the request came from the past, apply target pattern state to current pattern lineage
     for (var i = 0; i < index.length; i++) {
       if (index[i].patternPartial === targetPattern.patternPartial) {

core/lib/object_factory.js

@@ -73,9 +73,19 @@ var Pattern = function (relPath, data, patternlab) {
   this.isPseudoPattern = false;
   this.order = Number.MAX_SAFE_INTEGER;
   this.engine = patternEngines.getEngineForPattern(this);
-  // For completeness
+
+  /**
+   * Determines if this pattern needs to be recompiled.
+   *
+   * @ee {@link CompileState}*/
   this.compileState = null;
-  // The unix timestamp when the pattern was last modified
+
+  /**
+   * Timestamp in milliseconds when the pattern template or auxilary file (e.g. json) were modified.
+   * If multiple files are affected, this is the timestamp of the most recent change.
+   *
+   * @see {@link pattern}
+   */
   this.lastModified = null;
 
 };

core/lib/pattern_assembler.js

@@ -369,7 +369,7 @@ var pattern_assembler = function () {
     currentPattern.parameteredPartials = currentPattern.findPartialsWithPatternParameters();
 
     [templatePath, jsonFilename, listJsonFileName].forEach(file => {
-      changes_hunter.checkLastModified(currentPattern, file)
+      changes_hunter.checkLastModified(currentPattern, file);
     });
 
     changes_hunter.checkBuildState(currentPattern, patternlab);
@@ -405,7 +405,7 @@ var pattern_assembler = function () {
   }
 
   function findModifiedPatterns(lastModified, patternlab) {
-    return patternlab.patterns.filter( p => {
+    return patternlab.patterns.filter(p => {
       if (p.compileState !== CompileState.CLEAN || ! p.lastModified) {
         return true;
       }
@@ -527,7 +527,7 @@ var pattern_assembler = function () {
 
   return {
     find_modified_patterns: function (lastModified, patternlab) {
-      return findModifiedPatterns(lastModified, patternlab)
+      return findModifiedPatterns(lastModified, patternlab);
     },
     find_pattern_partials: function (pattern) {
       return pattern.findPartials();