shred and watch build tooling - v2 ( dgeni, gulp, jade)

jtraband · naomiblack · commit d9089f215c24 · 2015-08-07T14:49:35.000-07:00
diff --git a/gulpfile.js b/gulpfile.js
@@ -13,6 +13,15 @@ var shredOptions =  {
   destDir:  "_fragments"
 };
 
+/*
+Within this repo generated files are checked in so that we can avoid running the
+shredder over the entire _examples dir each time someone refreshes the repo
+( the ‘shred-full’ gulp task). The gulp ‘serve-and-watch’ shredder is only
+a ‘partial’ shredder. It only shred’s files in directories changed during
+the current session.
+*/
+
+
 gulp.task('shred-full', ['shred-clean'], function() {
   docShredder.shred( shredOptions);
 });
@@ -73,4 +82,4 @@ function execCommands(cmds, options, cb) {
 
 
 
-gulp.task('default', ['shred']);
+gulp.task('default', ['shred-full']);
diff --git a/public/_includes/_util-fns.jade b/public/_includes/_util-fns.jade
@@ -17,7 +17,10 @@
 
 // HACK: to avoid having to include a path in makeTabs calls
 - var currentPath = current.path;
-// need to back up to 'docs'
+
+// simple way to only take as many '../' sections as we need to back up to the 'docs' dir
+// from the current document
+// we will almost certainly never go 10 or 11 deep but ...
 - var pathToFrags = "../../../../../../../../../../../".substr(0, (currentPath.length-2)*3) + "_fragments/";
 
 mixin makeTabs(path, fileNames, tabNames)
diff --git a/public/doc-shredder/regionExtractor.js b/public/doc-shredder/regionExtractor.js
@@ -13,7 +13,7 @@ module.exports = function regionExtractor() {
     var docStack = [];
     var doc = null;
     var nullLine = '###';
-    var rx = new RegExp(nullLine + '\n', 'g');
+
     lines.forEach(function(line, ix) {
       if (isCommentLine(line, commentPrefixes)) {
         if (hasRegionTag(line)) {
@@ -37,6 +37,7 @@ module.exports = function regionExtractor() {
         content = lines.slice(doc.startIx + 1).join('\n');
       }
       // eliminate all #docregion lines
+      var rx = new RegExp(nullLine + '\n', 'g');
       doc.content = content.replace(rx, '');
 
     });
diff --git a/public/doc-shredder/test/LICENSE b/public/doc-shredder/test/LICENSE
diff --git a/public/doc-shredder/test/README.md b/public/doc-shredder/test/README.md
@@ -0,0 +1,2 @@
+Files in the `test_source` dir may not pass current coding conventions (such as missing EOF new lines).  This is deliberate so that we can test 
+the doc-shredder with edge conditions.  
diff --git a/public/doc-shredder/test/package.json b/public/doc-shredder/test/package.json
diff --git a/public/docs/README.md b/public/docs/README.md
@@ -0,0 +1,6 @@
+# Why the _fragments dir is checked in
+ 
+Within this repo files generated as a result of shredding the `_examples` dir ( the contents of the `_fragments` dir) are checked in so that we can avoid running the
+shredder over the entire `_examples` dir each time someone refreshes the repo ( the `shred-full` gulp task). 
+The gulp `serve-and-watch` shredder is only a �partial� shredder. It only shred�s files in directories changed during
+the current session. 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+Files in the `test_source` dir may not pass current coding conventions (such as missing EOF new lines). This is deliberate so that we can test
	`2`	`+the doc-shredder with edge conditions.`