@plotdb/srcbuild 0.0.49 → 0.0.51

package/README.md

@@ -13,10 +13,10 @@ setup a lsp ( livescript + stylus + pug ) watcher:
 where
 
  - `base`: root dir for `src` and `static` folders. default `.`
- - `i18n`: i18n object. 
+ - `i18n`: i18n object.
  - `ignored`: files to be ignored. in [anymatch](https://github.com/micromatch/anymatch)-compatible definition.
    - by default ['.git']
- - `logger`: optional. for logging output. use `console.log` by default. 
+ - `logger`: optional. for logging output. use `console.log` by default.
    - sample logger with `pino`:
 
      require! <[@plotdb/srcbuild pino]>
@@ -52,7 +52,7 @@ Extend base builder for a customized builder:
 with following user-defined functions:
 
  - `is-supported(file)`: return true if `file` is supported by this builder, otherwise return false.
-   - `file`: file name for file to be verified. Relative to cwd. 
+   - `file`: file name for file to be verified. Relative to cwd.
  - `get-dependencies(file)`: return a list of files that this file depends on.
    - `file`: same as `is-supported`
  - `build(files)`: should compile / generate target files of given file list `files`.
@@ -71,7 +71,7 @@ and the common options for `init` are as following:
  - `desdir`: directory for built files. should be relative to `base`. default `static` if omitted.
  - `logger`: logger for log output. use `console` if omitted.
 
-check `src/ext/lsc.ls` or `src/ext/pug.ls` for example. 
+check `src/ext/lsc.ls` or `src/ext/pug.ls` for example.
 
 
 ## Options for custom builder
@@ -93,6 +93,7 @@ Except common options, each builder may support different options:
              span:i18n translate this text
    - `noView`: default false. when true, js view files ( generated to `viewdir` ) won't be built.
    - `viewdir`: default `.view`. a directory for storing prebuilt pug files ( in .js format )
+   - `bundler`: default null. Auto packing will be possible only if this is provided.
  - `lsc`:
    - `useGlslify`: default false. set to true if you need glslify of lsc files.
      - *NOTE* this is an experiment feature and may be removed ( move to standalone builder ) in the future.
@@ -116,7 +117,7 @@ Except common options, each builder may support different options:
 
 These options are constructor options for corresponding builder, e.g., for pug builder:
 
-    new pugbuild({ i18n: ... }) 
+    new pugbuild({ i18n: ... })
 
 When using shorthands like `srcbuild.lsp(...)`, you can also specify corresponding option in scope, such as:
 
@@ -146,7 +147,7 @@ By default, watcher watches the current working directory. Change watcher behavi
 
 ## ODB / On demand build
 
-use `watch.demand(target-file)` to force rebuild by request. e.g., 
+use `watch.demand(target-file)` to force rebuild by request. e.g.,
 
     require! <[srcbuild]>
     watch = srcbuild.lsp!
@@ -238,6 +239,31 @@ Additionally, you can also use a list of modules:
       {name: "omit-everything"},
     ])
 
+Use the second option object to specify additional parameters, including:
+
+ - `pack`: *experimental* default false. Enable auto packing or not.
+   - if true, enable auto packing which trigger bundling automatically to a filename from md5 of all script urls.
+   - require `bundler` option in pugbuild constructor.
+   - doesn't work with external urls.
+   - there are still issues about rebuilding and build from view.
+
+#### Auto Packing Issue (TODO)
+
+Auto packing works fine with static built files. However, there are two issues:
+
+ - it's kinda tricky to trigger a pack file rebuild if the pack file is mssing - since there is no clue from the hashed file name to the urls used.
+ - may slow down dynamic generated views since each rendering checks if the bundled file should be rebuilt against its source files.
+ - doesn't work for external urls.
+
+For the above issues, we can:
+
+ - add additional information ( such as source pug name base64 string ) in the hashed file name for reversed resolving all source files
+ - completely ignore auto packing with dynamic view rendering, instead we support ODB of bundle files
+ - extend bundler to support remote file fetching
+
+These solutions will be left in TODOs.
+
+
 
 ### Filters
 

package/dist/ext/bundle.js

@@ -83,9 +83,12 @@ bundlebuild.prototype = import$(Object.create(base.prototype), {
     }
     return (this.config[ret[1]][ret[2]] || [])[0];
   },
-  build: function(files, force){
-    var dirty, i$, len$, file, ret, key$, ps, type, name, desdir, des, this$ = this;
-    force == null && (force = false);
+  build: function(files, opt){
+    var force, dirty, key$, nfs, ofs, ref$, i$, len$, file, ret, ps, type, name, desdir, des, this$ = this;
+    force = typeof opt === 'boolean' ? opt : false;
+    if (opt == null) {
+      opt = {};
+    }
     if (files.filter(function(it){
       return it.file === this$.configFile;
     }).length) {
@@ -98,13 +101,36 @@ bundlebuild.prototype = import$(Object.create(base.prototype), {
       files.splice(files.indexOf(this.configFile), 1);
       return this.build(files, true);
     }
-    dirty = {};
-    for (i$ = 0, len$ = files.length; i$ < len$; ++i$) {
-      file = files[i$];
-      if (!(ret = this.fileMap[file.file])) {
-        continue;
+    if (opt.odb) {
+      dirty = {};
+      (dirty[key$ = opt.type] || (dirty[key$] = {}))[opt.name] = true;
+      nfs = files.map(function(f){
+        return path.join(this$._relativePath, f);
+      });
+      ofs = ((ref$ = this.config)[key$ = opt.type] || (ref$[key$] = {}))[opt.name] || [];
+      if (nfs.length !== ofs.length || nfs.filter(function(it){
+        return !in$(it, ofs);
+      }).length) {
+        force = true;
+      }
+      ((ref$ = this.config)[key$ = opt.type] || (ref$[key$] = {}))[opt.name] = nfs;
+      for (i$ = 0, len$ = (ref$ = this.config[opt.type][opt.name]).length; i$ < len$; ++i$) {
+        file = ref$[i$];
+        this.fileMap[file] = {
+          type: opt.type,
+          name: opt.name
+        };
+        this.fileList.add(file);
+      }
+    } else {
+      dirty = {};
+      for (i$ = 0, len$ = files.length; i$ < len$; ++i$) {
+        file = files[i$];
+        if (!(ret = this.fileMap[file.file])) {
+          continue;
+        }
+        (dirty[key$ = ret.type] || (dirty[key$] = {}))[ret.name] = true;
       }
-      (dirty[key$ = ret.type] || (dirty[key$] = {}))[ret.name] = true;
     }
     ps = [];
     for (type in dirty) {
@@ -234,4 +260,9 @@ function import$(obj, src){
   var own = {}.hasOwnProperty;
   for (var key in src) if (own.call(src, key)) obj[key] = src[key];
   return obj;
+}
+function in$(x, xs){
+  var i = -1, l = xs.length >>> 0;
+  while (++i < l) if (x === xs[i]) return true;
+  return false;
 }

package/dist/ext/pug.js

@@ -1,5 +1,5 @@
 // Generated by LiveScript 1.6.0
-var fs, path, fsExtra, pug, livescript, uglifyJs, uglifycss, stylus, jsYaml, marked, colors, base, aux, cwd, pugbuild;
+var fs, path, fsExtra, pug, livescript, uglifyJs, uglifycss, stylus, jsYaml, marked, crypto, colors, base, aux, cwd, pugbuild;
 fs = require('fs');
 path = require('path');
 fsExtra = require('fs-extra');
@@ -10,6 +10,7 @@ uglifycss = require('uglifycss');
 stylus = require('stylus');
 jsYaml = require('js-yaml');
 marked = require('marked');
+crypto = require('crypto');
 colors = require('@plotdb/colors');
 base = require('./base');
 aux = require('../aux');
@@ -20,6 +21,7 @@ pugbuild = function(opt){
   this.intlbase = opt.intlbase || 'intl';
   this.filters = opt.filters || {};
   this.extapi = this.getExtapi();
+  this.bundler = opt.bundler;
   this.init(import$({
     srcdir: 'src/pug',
     desdir: 'static'
@@ -138,6 +140,24 @@ pugbuild.prototype = import$(Object.create(base.prototype), {
           }
         });
         return ret;
+      },
+      md5: function(str){
+        return crypto.createHash('md5').update(str).digest('hex');
+      },
+      hashfile: function(arg$){
+        var type, name, files;
+        type = arg$.type, name = arg$.name, files = arg$.files;
+        if (!this$.bundler) {
+          return;
+        }
+        files = files.map(function(file){
+          return path.relative(this$.base, path.join(this$.desdir, file));
+        });
+        return this$.bundler.build(files, {
+          type: type,
+          name: name,
+          odb: true
+        });
       }
     };
     if (this.i18n) {

package/dist/lib.pug

@@ -14,6 +14,7 @@
 
 mixin script(os,cfg)
   -
+    var str = '', urls = [];
     if(!Array.isArray(os)) { os = [os]; }
   each o in os
     -
@@ -26,11 +27,22 @@ mixin script(os,cfg)
       - defer = (typeof(c.defer) == "undefined" ? true : !!c.defer);
       if /^https?:\/\/./.exec(url)
         script(type="text/javascript",src=url, defer=defer, async=!!c.async)
+      else if cfg && cfg.pack
+        -
+          str = str + ';' + url;
+          urls.push(url);
       else
         script(type="text/javascript",src=url + libLoader._v, defer=defer, async=!!c.async)
+  if cfg && cfg.pack
+    -
+      var name = md5(str);
+      var filename = "/js/pack/" + name + ".js";
+      hashfile({type: "js", name: name, files: urls});
+    script(type="text/javascript",src=filename + libLoader._v)
 
 mixin css(os,cfg)
   -
+    var str = '', urls = [];
     if(!Array.isArray(os)) { os = [os]; }
   each o in os
     -
@@ -40,4 +52,17 @@ mixin css(os,cfg)
       else { url = libLoader._r + "/" + o.name + "/" + (o.version || 'main') + "/" + (o.path || "index.min.css"); }
     if !libLoader.css.url[url]
       - libLoader.css.url[url] = true;
-      link(rel="stylesheet",type="text/css",href=url + libLoader._v)
+      if /^https?:\/\/./.exec(url)
+        link(rel="stylesheet",type="text/css",href=url)
+      else if cfg && cfg.pack
+        -
+          str = str + ';' + url;
+          urls.push(url);
+      else
+        link(rel="stylesheet",type="text/css",href=url + libLoader._v)
+  if cfg && cfg.pack
+    -
+      var name = md5(str);
+      var filename = "/css/pack/" + name + ".css";
+      hashfile({type: "css", name: name, files: urls});
+    link(rel="stylesheet",type="text/css",href=filename + libLoader._v)

package/dist/main.js

@@ -12,25 +12,28 @@ module.exports = {
   base: base,
   i18n: i18n,
   lsp: function(opt){
-    var base, i$, len$, b, adapters, ref$, watcher;
+    var base, adapters, i$, len$, b, bundler, ref$, watcher;
     opt == null && (opt = {});
     base = opt.base || 'web';
     base = Array.isArray(base)
       ? base
       : [base];
+    adapters = [];
     for (i$ = 0, len$ = base.length; i$ < len$; ++i$) {
       b = base[i$];
-      adapters = [
+      bundler = new bundle(import$((ref$ = {
+        base: b
+      }, ref$.logger = opt.logger, ref$.i18n = opt.i18n, ref$.ignored = opt.ignored, ref$), opt.bundle || {}));
+      adapters = adapters.concat([
         new lsc(import$((ref$ = {
           base: b
         }, ref$.logger = opt.logger, ref$.i18n = opt.i18n, ref$.ignored = opt.ignored, ref$), opt.lsc || {})), new stylus(import$((ref$ = {
           base: b
         }, ref$.logger = opt.logger, ref$.i18n = opt.i18n, ref$.ignored = opt.ignored, ref$), opt.stylus || {})), new pug(import$((ref$ = {
-          base: b
-        }, ref$.logger = opt.logger, ref$.i18n = opt.i18n, ref$.ignored = opt.ignored, ref$), opt.pug || {})), new bundle(import$((ref$ = {
-          base: b
-        }, ref$.logger = opt.logger, ref$.i18n = opt.i18n, ref$.ignored = opt.ignored, ref$), opt.bundle || {}))
-      ].map(fn$);
+          base: b,
+          bundler: bundler
+        }, ref$.logger = opt.logger, ref$.i18n = opt.i18n, ref$.ignored = opt.ignored, ref$), opt.pug || {}))
+      ].map(fn$));
     }
     return watcher = new watch((ref$ = {
       adapters: adapters

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "zbryikt",
   "name": "@plotdb/srcbuild",
-  "version": "0.0.49",
+  "version": "0.0.51",
   "description": "",
   "main": "./dist/main.js",
   "files": [
@@ -27,10 +27,10 @@
   },
   "dependencies": {
     "@loadingio/debounce.js": "^1.0.1",
+    "@plotdb/colors": "^0.0.1",
     "anymatch": "^3.1.2",
     "browserify": "^17.0.0",
     "chokidar": "^3.5.1",
-    "@plotdb/colors": "^0.0.1",
     "fs-extra": "^9.1.0",
     "glslify": "^7.1.1",
     "i18next": "^19.9.2",
@@ -47,7 +47,21 @@
     "yargs": "^17.2.1"
   },
   "devDependencies": {
-    "ldview": "^0.0.2",
+    "fedep": "^1.1.7",
+    "ldcolor": "^1.0.0",
+    "ldcover": "^3.2.1",
+    "ldloader": "^3.0.1",
+    "ldview": "^1.3.0",
     "shaderlib": "github:zbryikt/shaderlib"
+  },
+  "frontendDependencies": {
+    "root": "web/static/assets/lib",
+    "modules": [
+      "@loadingio/debounce.js",
+      "ldcover",
+      "ldloader",
+      "ldcolor",
+      "ldview"
+    ]
   }
 }