Merge branch 'develop'

dwightjack · dwightjack · commit 850540bc76c3 · 2018-03-27T23:04:14.000+09:00
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ WOK is a loosely opinionated boilerplate for web development built with flexibil
 ## Supported browsers (via [browserslist](https://github.com/browserslist/browserslist))
 
 * last 1 major version
-* >= 1%
+* \>= 1%
 * Chrome >= 45
 * Firefox >= 38
 * Edge >= 12
diff --git a/application/views/index.njk b/application/views/index.njk
@@ -1,4 +1,4 @@
-{% extends 'templates/_default.nunj.html' %}
+{% extends 'templates/_default.njk' %}
 
 
 {% block main %}
diff --git a/application/views/templates/_default.njk b/application/views/templates/_default.njk
diff --git a/build/gulp-config/properties.js b/build/gulp-config/properties.js
@@ -8,5 +8,5 @@ module.exports = {
 
     buildOnly: false, //set to `true` when paired with Phing
 
-    viewmatch: '*.{html,njk}' //for php projects use: '*.{html,php,phtml}'
+    viewsExt: ['html', 'njk'] //for php projects use: '*.{html,php,phtml}'
 };
diff --git a/build/gulp-tasks/lib/plugins.js b/build/gulp-tasks/lib/plugins.js
@@ -3,7 +3,7 @@
  */
 
 const through = require('through2');
-const gutils = require('gulp-util');
+const PluginError = require('plugin-error');
 
 module.exports.map = function map(fn) {
 
@@ -18,14 +18,14 @@ module.exports.map = function map(fn) {
         if (file.isStream()) {
             this.emit(
                 'error',
-                new gutils.PluginError('gulp-boilerplate', 'Streaming not supported')
+                new PluginError('wok-map', 'Streaming not supported')
             );
         }
 
         try {
-            file.contents = new Buffer(mapFn(file.contents.toString(), file.path, file)); //eslint-disable-line no-param-reassign
+            file.contents = Buffer.from(mapFn(file.contents.toString(), file.path, file)); //eslint-disable-line no-param-reassign
         } catch (err) {
-            this.emit('error', new gutils.PluginError('gulp-boilerplate', err.toString()));
+            this.emit('error', new PluginError('wok-map', err.toString()));
         }
 
         this.push(file);
diff --git a/build/gulp-tasks/lib/renderers/index.js b/build/gulp-tasks/lib/renderers/index.js
@@ -0,0 +1,13 @@
+const nunjucks = require('./nunjucks');
+
+module.exports = (...args) => {
+    const entries = [nunjucks].map(({ createRenderer }) => createRenderer(...args));
+
+    return {
+        entries,
+        match(filepath) {
+            return entries.find(({ match }) => match(filepath));
+        }
+    };
+
+};
diff --git a/build/gulp-tasks/lib/renderers/nunjucks.js b/build/gulp-tasks/lib/renderers/nunjucks.js
@@ -2,15 +2,17 @@
  * View Compilation Helpers
  */
 
-const _ = require('lodash');
 const random = require('lodash/random');
 const defaults = require('lodash/defaults');
-const nunjucks = require('nunjucks');
-const marked = require('marked');
-const Markdown = require('nunjucks-markdown/lib/markdown_tag');
 const loremIpsum = require('lorem-ipsum');
 
 const nunjucksEnv = (viewPath) => {
+
+    const nunjucks = require('nunjucks');
+    const marked = require('marked');
+    const Markdown = require('nunjucks-markdown/lib/markdown_tag');
+
+
     const env = nunjucks.configure(viewPath, {
         noCache: true
     });
@@ -44,9 +46,13 @@ const nunjucksEnv = (viewPath) => {
 
 };
 
-const defaultHelpers = (/*options*/) => {
 
-    return {
+
+module.exports.createRenderer = (viewPaths, options, helpers) => {
+
+    const matchRegExp = /\.(njk|html)$/;
+
+    const defaultHelpers = {
         lorem(min, max, config) {
             const count = max ? random(min, max) : min;
             const loremDefaults = {
@@ -59,20 +65,22 @@ const defaultHelpers = (/*options*/) => {
         }
     };
 
-};
-
-const noopHelper = () => ({});
-
-module.exports.createRenderer = (viewPaths, options, helpers = noopHelper) => {
-
-    const env = nunjucksEnv(viewPaths, options);
-
-    env.addGlobal('helpers', Object.assign(helpers(options), defaultHelpers(options)));
-    env.addGlobal('_', _);
+    let env;
 
     return {
-        env,
+        get env() {
+            return env;
+        },
+        name: 'nunjucks',
+        extensions: ['njk', 'html'],
+        match: (filepath) => matchRegExp.test(filepath),
         render(string, locals) {
+            //lazy load renderer
+            if (!env) {
+                env = nunjucksEnv(viewPaths, options);
+                env.addGlobal('helpers', Object.assign({}, defaultHelpers, helpers && helpers(options)));
+                env.addGlobal('_', require('lodash'));
+            }
             return env.renderString(string, locals);
         }
     };
diff --git a/build/gulp-tasks/views.js b/build/gulp-tasks/views.js
@@ -13,23 +13,21 @@ module.exports = (gulp, $, options) => {
     const glob = require('globby');
     const through = require('through2');
     const { map } = require('./lib/plugins');
-    const { createRenderer } = require('./lib/view-helpers');
+    const rendererCreator = require('./lib/renderers');
 
     const baseData = {};
     const paths = require('../gulp-config/paths');
     const viewPath = paths.toAbsPath('src.views');
     const fixturesPath = paths.toAbsPath('src.fixtures');
-    const { production, viewmatch, banners } = options;
+    const { production, banners, viewmatch } = options;
 
     let useRef = () => through.obj();
 
 
     baseData.PRODUCTION = production;
     baseData.page = {};
 
-    const helpers = () => ({});
-
-    const renderer = createRenderer([viewPath, paths.toPath('src.documents')], options, helpers);
+    const renderer = rendererCreator([viewPath, paths.toPath('src.documents')], options);
 
     if (production) {
 
@@ -83,11 +81,16 @@ module.exports = (gulp, $, options) => {
             .pipe($.plumber({
                 errorHandler: $.notify.onError('Error: <%= error.message %>')
             }))
-            .pipe(map((code) => renderer.render(code, Object.assign({}, baseData, data || {}))))
+            .pipe(map((code, filepath) => {
+                const engine = renderer.match(filepath);
+                if (engine) {
+                    return engine.render(code, Object.assign({}, baseData, data || {}));
+                }
+                return code;
+            }))
             .pipe(useRef())
-            .pipe($.rename((filepath) => {
-                filepath.basename = filepath.basename.replace('.nunj', ''); //eslint-disable-line no-param-reassign
-                filepath.extname = '.html'; //eslint-disable-line no-param-reassign
+            .pipe($.rename({
+                extname: '.html'
             }))
             .pipe(htmlFilter)
             .pipe(gulp.dest(paths.toPath('dist.views')))
diff --git a/build/gulp-tasks/watch.js b/build/gulp-tasks/watch.js
@@ -105,7 +105,8 @@ module.exports = (gulp, $, options) => {
                 match: `src.views/{,*/}${viewmatch}`,
                 resolve(filepath) {
                     let src = path.relative(paths.toPath('src.views'), filepath);
-                    src = src.replace(/\.(nunj\.html|njk)$/, '.html');
+                    const ext = path.extname(filepath);
+                    src = src.replace(ext, '.html');
                     return path.resolve(paths.toPath('dist.views'), src);
                 }
             }
diff --git a/gulpfile.js b/gulpfile.js
@@ -11,7 +11,7 @@ const gulp = require('gulp');
 const glob = require('globby');
 const _ = require('lodash');
 const log = require('fancy-log');
-const { red } = require('ansi-colors');
+const { red, yellow } = require('ansi-colors');
 const $ = require('gulp-load-plugins')();
 const { argv = {} } = require('yargs');
 const pkg = require('./package.json');
@@ -24,7 +24,8 @@ const banners = {
     vendors: `/*! ${pkg.description} v${pkg.version} - ${pkg.author.name} - Vendor package */\n`
 };
 
-const logError = (...args) => log(red(...args));
+const logError = _.flow(red, log);
+const warn = _.flow(yellow, log.warn);
 
 
 pkg.year = new Date().getFullYear();
@@ -60,7 +61,7 @@ if (fs.existsSync(path.join(optionsPath, 'paths.local.js'))) {
 }
 
 if (_.has(argv, 'remotehost')) {
-    logError('WARNING: param `--remotehost` is deprecated use `--target` instead');
+    warn('WARNING: param `--remotehost` is deprecated use `--target` instead');
     argv.target = argv.remotehost;
 }
 
@@ -73,6 +74,12 @@ _.forOwn({
     options[key] = _.get(argv, key, value);
 });
 
+if (options.viewmatch) {
+    logError('`viewmatch` property has been removed. Use `viewsExt: [...]`');
+    process.exit();
+}
+options.viewmatch = `*.{${options.viewsExt.join(',')}}`;
+
 //force production env
 if (options.production) {
     process.env.NODE_ENV = 'production';
diff --git a/package.json b/package.json
@@ -100,6 +100,7 @@
     "node-sass": "4.8.3",
     "nunjucks": "3.1.2",
     "nunjucks-markdown": "2.0.1",
+    "plugin-error": "^1.0.1",
     "prompts": "^0.1.8",
     "rsyncwrapper": "2.0.1",
     "semver": "5.5.0",

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-{% extends 'templates/_default.nunj.html' %}`
	`1`	`+{% extends 'templates/_default.njk' %}`
`2`	`2`
`3`	`3`
`4`	`4`	`{% block main %}`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,8 @@ module.exports = (gulp, $, options) => {`
`105`	`105`	match: `src.views/{,*/}${viewmatch}`,
`106`	`106`	`resolve(filepath) {`
`107`	`107`	`let src = path.relative(paths.toPath('src.views'), filepath);`
`108`		`- src = src.replace(/\.(nunj\.html\|njk)$/, '.html');`
	`108`	`+ const ext = path.extname(filepath);`
	`109`	`+ src = src.replace(ext, '.html');`
`109`	`110`	`return path.resolve(paths.toPath('dist.views'), src);`
`110`	`111`	`}`
`111`	`112`	`}`