Fixing replaceConfigPaths bug. Adding export and replace_config_paths tests

Author: raphaelokon

bin/generator.js

@@ -92,8 +92,6 @@ function replaceConfigPaths(config, projectDir, sourceDir, publicDir, exportDir)
 	const conf = _.assign({}, config);
 	_.map(conf.paths.source, (value, key) => { conf.paths.source[key] = value.replace(/^\.\/source/g, path.join(projectDir, sourceDir)) });
 	_.map(conf.paths.public, (value, key) => { conf.paths.public[key] = value.replace(/^\.\/public/g, path.join(projectDir, publicDir)) });
-	conf.styleguide = 'node_modules/styleguidekit-assets-default/dist/';
-	conf.patternlabFiles = 'node_modules/styleguidekit-mustache-default/views/';
 	conf.patternExportDirectory = path.join(projectDir, exportDir);
 	return conf;
 }

test/build.test.js

@@ -6,9 +6,13 @@ const patternLabMock = require('./mocks/patternlab.mock');
 // Require build and mock patternlab.build() so that we only test the build module behavior
 const build = proxyquire('../bin/build', {'patternlab-node': patternLabMock});
 const opts = {patternsOnly: true};
-tap.throws(() => { build() }, {}, 'build throws when config is empty');
-tap.throws(() => { build(123) }, {}, 'build throws when config is not of type object');
-tap.throws(() => { build(undefined, opts) }, {}, 'build --patterns-only throws when config is empty');
-tap.throws(() => { build(undefined, opts) }, {}, 'build --patterns-only throws when config is not of type object');
-tap.type(build(config), 'boolean', 'build returns a bool');
-tap.type(build(config, opts), 'boolean', 'build --patterns-only returns a bool');
+
+tap.test('Build ->', t => {
+	t.throws(() => { build() }, {}, 'throws when config is empty');
+	t.throws(() => { build(123) }, {}, 'throws when config is not of type object');
+	t.throws(() => { build(undefined, opts) }, {}, '--patterns-only throws when config is empty');
+	t.throws(() => { build(undefined, opts) }, {}, '--patterns-only throws when config is not of type object');
+	t.type(build(config), 'boolean', 'returns a bool');
+	t.type(build(config, opts), 'boolean', '--patterns-only returns a bool');
+	t.end();
+});

test/export.test.js

@@ -0,0 +1,16 @@
+const proxyquire = require('proxyquire');
+const tap = require('tap');
+const config = require('../bin/generator').defaultPatternlabConfig;
+const patternLabMock = require('./mocks/patternlab.mock');
+
+// Require build and mock patternlab.build() so that we only test the build module behavior
+const exportPatterns = proxyquire('../bin/export', {'patternlab-node': patternLabMock});
+const opts = {patternsOnly: true};
+
+tap.test('Export ->', t => {
+	t.throws(() => { exportPatterns() }, {}, 'throws when config is empty');
+	t.throws(() => { exportPatterns(123) }, {}, 'throws when config is not of type object');
+	t.throws(() => { exportPatterns(undefined, opts) }, {}, '--patterns-only throws when config is empty');
+	t.throws(() => { exportPatterns(undefined, opts) }, {}, '--patterns-only throws when config is not of type object');
+	t.end();
+});

test/fixtures/patternlab-config.json

@@ -1,39 +1,45 @@
 {
-  "paths" : {
-    "source" : {
+  "paths": {
+    "source": {
       "root": "./source/",
-      "patterns" : "./source/_patterns/",
-      "data" : "./source/_data/",
+      "patterns": "./source/_patterns/",
+      "data": "./source/_data/",
       "meta": "./source/_meta/",
-      "annotations" : "./source/_annotations/",
-      "styleguide" : "node_modules/styleguidekit-assets-default/dist/",
-      "patternlabFiles" : "node_modules/styleguidekit-mustache-default/views/",
-      "js" : "./source/js",
-      "images" : "./source/images",
-      "fonts" : "./source/fonts",
-      "css" : "./source/css/"
+      "annotations": "./source/_annotations/",
+      "styleguide": "node_modules/styleguidekit-assets-default/dist/",
+      "patternlabFiles": "node_modules/styleguidekit-mustache-default/views/",
+      "js": "./source/js",
+      "images": "./source/images",
+      "fonts": "./source/fonts",
+      "css": "./source/css/"
     },
-    "public" : {
-      "root" : "./public/",
-      "patterns" : "./public/patterns/",
-      "data" : "./public/styleguide/data/",
-      "annotations" : "./public/annotations/",
-      "styleguide" : "./public/styleguide/",
-      "js" : "./public/js",
-      "images" : "./public/images",
-      "fonts" : "./public/fonts",
-      "css" : "./public/css"
+    "public": {
+      "root": "./public/",
+      "patterns": "./public/patterns/",
+      "data": "./public/styleguide/data/",
+      "annotations": "./public/annotations/",
+      "styleguide": "./public/styleguide/",
+      "js": "./public/js",
+      "images": "./public/images",
+      "fonts": "./public/fonts",
+      "css": "./public/css"
     }
   },
   "styleGuideExcludes": [
     "templates",
     "pages"
   ],
   "defaultPattern": "all",
-  "cleanPublic" : false,
+  "cleanPublic": false,
   "patternExtension": "mustache",
-  "ignored-extensions" : ["scss", "DS_Store", "less"],
-  "ignored-directories" : ["scss"],
+  "ignored-extensions": [
+    "scss",
+    "DS_Store",
+    "less"
+  ],
+  "ignored-directories": [
+    "scss"
+  ],
   "debug": false,
   "ishControlsHide": {
     "s": false,
@@ -54,15 +60,19 @@
   },
   "ishMinimum": "240",
   "ishMaximum": "2600",
-  "patternStateCascade": ["inprogress", "inreview", "complete"],
+  "patternStateCascade": [
+    "inprogress",
+    "inreview",
+    "complete"
+  ],
   "patternStates": {
-    "molecules-single-comment" : "complete",
-    "organisms-sticky-comment" : "inreview",
-    "templates-article" : "complete"
+    "molecules-single-comment": "complete",
+    "organisms-sticky-comment": "inreview",
+    "templates-article": "complete"
   },
   "patternExportPatternPartials": [],
-  "patternExportDirectory": "./pattern_exports/",
-  "baseurl" : "",
+  "patternExportDirectory": "./pattern_exports",
+  "baseurl": "",
   "cacheBust": true,
   "starterkitSubDir": "dist",
   "outputFileSuffixes": {

test/replace_config_paths.test.js

@@ -0,0 +1,15 @@
+const tap = require('tap');
+const replaceConfigPaths = require('../bin/generator').replaceConfigPaths;
+const config = require('./fixtures/patternlab-config.json');
+
+tap.test('replaceConfigPaths ->', t => {
+	const newConfig = replaceConfigPaths(config, 'projectDir', 'sourceDir', 'publicDir', 'exportDir');
+	for (const k of Object.keys(newConfig.paths.source)) {
+		t.ok(/^projectDir\/sourceDir\/|^node_modules/.test(newConfig.paths.source[k]), `should be ok for newConfig.paths.source.${k}`);
+	}
+	for (const k of Object.keys(newConfig.paths.public)) {
+		t.ok(/^projectDir\/publicDir\//.test(newConfig.paths.public[k]), `should be ok for newConfig.paths.public.${k}`);
+	}
+	t.ok(/^projectDir\/exportDir\//.test(newConfig.paths.patternExportDirectory), `should be ok for newConfig.paths.patternExportDirectory`);
+	t.end();
+});