@mobilabs/es6lib 2.1.0 → 2.1.1

package/.github/workflows/ci.yml

@@ -3,7 +3,7 @@ name: CI pipeline
 
 on:
   push:
-    branches: [ master ]
+    branches: [ master, main ]
 
 jobs:
   build:

package/_dist/lib/es6lib.js

@@ -1,5 +1,5 @@
 /*! ****************************************************************************
- * ES6lib v2.1.0
+ * ES6lib v2.1.1
  *
  * A template for writing pure ES6 Javascript libraries.
  * (you can download it from npm or github repositories)
@@ -313,14 +313,14 @@
       const obj = Object.create(methods);
       obj._library = {
         name: 'ES6lib',
-        version: '2.1.0',
+        version: '2.1.1',
       };
       return obj;
     };
 
     // Attaches constants to ES6lib that provide name and version of the lib.
     ES6lib.NAME = 'ES6lib';
-    ES6lib.VERSION = '2.1.0';
+    ES6lib.VERSION = '2.1.1';
 
 
     // -- Private Static Methods -----------------------------------------------

package/_dist/lib/es6lib.min.js

@@ -1,5 +1,5 @@
 /*! ****************************************************************************
- * ES6lib v2.1.0
+ * ES6lib v2.1.1
  *
  * A template for writing pure ES6 Javascript libraries.
  * (you can download it from npm or github repositories)
@@ -8,4 +8,4 @@
  * at: http://www.opensource.org/licenses/mit-license.php).
  * Built from {{boiler:name}} v{{boiler:name:version}}.
  * ************************************************************************** */
-!function(t,e){"use strict";"function"==typeof define&&define.amd?define([""],e):"object"==typeof exports?module.exports=e(t):t.ES6lib=e(t)}(this,(t=>{"use strict";let e,n;const i={Public:{}};return n=function(t,e){const n=Object.keys(e);for(let i=0;i<n.length;i++)t[n[i]]=e[n[i]]},function(){const t=i.Public;n(t,{getString:()=>"I am a string!",getArray:()=>[1,2,3]})}(),function(){const n=i.Public,r=t.ES6lib;let o;e=function(){const t=Object.create(o);return t._library={name:"ES6lib",version:"2.1.0"},t},e.NAME="ES6lib",e.VERSION="2.1.0",e._setTestMode=function(){return[]},e.noConflict=function(){return t.ES6lib=r,this},o={whoami(){return this._library},getString:()=>n.getString(),getArray:()=>n.getArray()}}(),e}));
+!function(t,e){"use strict";"function"==typeof define&&define.amd?define([""],e):"object"==typeof exports?module.exports=e(t):t.ES6lib=e(t)}(this,(t=>{"use strict";let e,n;const i={Public:{}};return n=function(t,e){const n=Object.keys(e);for(let i=0;i<n.length;i++)t[n[i]]=e[n[i]]},function(){const t=i.Public;n(t,{getString:()=>"I am a string!",getArray:()=>[1,2,3]})}(),function(){const n=i.Public,r=t.ES6lib;let o;e=function(){const t=Object.create(o);return t._library={name:"ES6lib",version:"2.1.1"},t},e.NAME="ES6lib",e.VERSION="2.1.1",e._setTestMode=function(){return[]},e.noConflict=function(){return t.ES6lib=r,this},o={whoami(){return this._library},getString:()=>n.getString(),getArray:()=>n.getArray()}}(),e}));

package/_dist/lib/es6lib.min.mjs

@@ -1,5 +1,5 @@
 /*! ****************************************************************************
- * ES6lib v2.1.0
+ * ES6lib v2.1.1
  *
  * A template for writing pure ES6 Javascript libraries.
  * (you can download it from npm or github repositories)
@@ -8,4 +8,4 @@
  * at: http://www.opensource.org/licenses/mit-license.php).
  * Built from {{boiler:name}} v{{boiler:name:version}}.
  * ************************************************************************** */
-const $__ES6GLOB={};!function(t,e){"use strict";"function"==typeof define&&define.amd?define([""],e):"object"==typeof exports?module.exports=e(t):t.ES6lib=e(t)}($__ES6GLOB,(t=>{"use strict";let e,n;const i={Public:{}};return n=function(t,e){const n=Object.keys(e);for(let i=0;i<n.length;i++)t[n[i]]=e[n[i]]},function(){const t=i.Public;n(t,{getString:()=>"I am a string!",getArray:()=>[1,2,3]})}(),function(){const n=i.Public,r=t.ES6lib;let o;e=function(){const t=Object.create(o);return t._library={name:"ES6lib",version:"2.1.0"},t},e.NAME="ES6lib",e.VERSION="2.1.0",e._setTestMode=function(){return[]},e.noConflict=function(){return t.ES6lib=r,this},o={whoami(){return this._library},getString:()=>n.getString(),getArray:()=>n.getArray()}}(),e}));export default $__ES6GLOB.ES6lib;
+const $__ES6GLOB={};!function(t,e){"use strict";"function"==typeof define&&define.amd?define([""],e):"object"==typeof exports?module.exports=e(t):t.ES6lib=e(t)}($__ES6GLOB,(t=>{"use strict";let e,n;const i={Public:{}};return n=function(t,e){const n=Object.keys(e);for(let i=0;i<n.length;i++)t[n[i]]=e[n[i]]},function(){const t=i.Public;n(t,{getString:()=>"I am a string!",getArray:()=>[1,2,3]})}(),function(){const n=i.Public,r=t.ES6lib;let o;e=function(){const t=Object.create(o);return t._library={name:"ES6lib",version:"2.1.1"},t},e.NAME="ES6lib",e.VERSION="2.1.1",e._setTestMode=function(){return[]},e.noConflict=function(){return t.ES6lib=r,this},o={whoami(){return this._library},getString:()=>n.getString(),getArray:()=>n.getArray()}}(),e}));export default $__ES6GLOB.ES6lib;

package/_dist/lib/es6lib.mjs

@@ -1,5 +1,5 @@
 /*! ****************************************************************************
- * ES6lib v2.1.0
+ * ES6lib v2.1.1
  *
  * A template for writing pure ES6 Javascript libraries.
  * (you can download it from npm or github repositories)
@@ -314,14 +314,14 @@ const $__ES6GLOB = {};
       const obj = Object.create(methods);
       obj._library = {
         name: 'ES6lib',
-        version: '2.1.0',
+        version: '2.1.1',
       };
       return obj;
     };
 
     // Attaches constants to ES6lib that provide name and version of the lib.
     ES6lib.NAME = 'ES6lib';
-    ES6lib.VERSION = '2.1.0';
+    ES6lib.VERSION = '2.1.1';
 
 
     // -- Private Static Methods -----------------------------------------------

package/bin/es6lib.js

@@ -49,7 +49,7 @@ const defBoilerLib  = 'ES6lib'
     , { version } = require('../package.json')
     , src         = 'src'
     , test        = 'test'
-    , tasks       = 'tasks'
+    , scripts     = 'scripts'
     , husky       = '.husky'
     , docs        = 'docs'
     // Command line Options
@@ -376,7 +376,7 @@ function _addSrc(source, dest, folder, app, boilerlib) {
 }
 
 /**
- * Adds the task files.
+ * Adds the script files.
  *
  * @function (arg1, arg2, arg3, arg4, arg5)
  * @private
@@ -387,7 +387,7 @@ function _addSrc(source, dest, folder, app, boilerlib) {
  * @param {String}          the name of the boilerplate,
  * @returns {}              -,
  */
-function _addTasks(source, dest, folder, app, boilerlib) {
+function _addScripts(source, dest, folder, app, boilerlib) {
   const exclude = []
       , boiler  = '{{boiler:name}}'
       , ver     = '{{boiler:name:version}}'
@@ -529,8 +529,8 @@ function _populate(options) {
   // Copy the src files:
   _addSrc(baseboiler, baseapp, src, app, boilerlib);
 
-  // Add tasks:
-  _addTasks(baseboiler, baseapp, tasks, app, boilerlib);
+  // Add scripts:
+  _addScripts(baseboiler, baseapp, scripts, app, boilerlib);
 
   // Copy Test Files:
   _addTest(baseboiler, baseapp, test, app, boilerlib);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mobilabs/es6lib",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "A template for writing pure ES6 Javascript libraries",
   "main": "index.js",
   "minified": "_dist/lib/es6lib.min.js",

package/scripts/_build.template.js

@@ -0,0 +1,247 @@
+#!/usr/bin/env node
+/* *****************************************************************************
+ *
+ * Does ...
+ *
+ * build:template script is a framework to build npm build scripts;
+ *
+ * Private Functions:
+ *  . _help                       displays the help message,
+ *  . _clean                      removes the previous build,
+ *  . _dosomething                creates something,
+ *
+ *
+ * Public Static Methods:
+ *  . run                         executes the script,
+ *
+ *
+ * @namespace    -
+ * @dependencies none
+ * @exports      -
+ * @author       -
+ * @since        0.0.0
+ * @version      -
+ * ************************************************************************** */
+/* eslint one-var: 0, semi-style: 0, no-underscore-dangle: 0,
+  import/no-extraneous-dependencies: 0 */
+
+'use strict';
+
+// -- Vendor Modules
+const fs   = require('fs')
+    , nopt = require('nopt')
+    ;
+
+
+// -- Local Modules
+const config = require('./config')
+    ;
+
+
+// -- Local Constants
+const VERSION     = '0.0.0-alpha.0'
+    , opts        = {
+      help: [Boolean, false],
+      version: [String, null],
+    }
+    , shortOpts   = {
+      h: ['--help'],
+      v: ['--version', VERSION],
+    }
+    , parsed      = nopt(opts, shortOpts, process.argv, 2)
+    , destination = config.libdir
+    ;
+
+
+// -- Local Variables
+
+
+// -- Private Functions --------------------------------------------------------
+
+/**
+ * Dispays the help message.
+ *
+ * @function ()
+ * @private
+ * @param {}                -,
+ * @returns {}              -,
+ * @since 0.0.0
+ */
+function _help() {
+  const message = ['',
+    'Usage: command [options]',
+    '',
+    '                       creates something from something',
+    '',
+    'Options:',
+    '',
+    '-h, --help             output usage information',
+    '-v, --version          output the version number',
+    '',
+  ].join('\n');
+
+  process.stdout.write(`${message}\n`);
+}
+
+/**
+ * Removes the previous build.
+ *
+ * @function ()
+ * @private
+ * @param {}                -,
+ * @returns {Object}        returns a promise,
+ * @since 0.0.0
+ */
+function _clean() {
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mclean\x1b[89m\x1b[0m\'...\n');
+
+  return new Promise((resolve) => {
+    fs.rm(destination, { force: true, recursive: true }, (err1) => {
+      if (err1) throw new Error(err1);
+
+      fs.mkdir(destination, { recursive: true }, (err2) => {
+        if (err2) throw new Error(err2);
+
+        const d2 = new Date() - d1;
+        process.stdout.write(`Finished '\x1b[36mclean\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+        resolve();
+      });
+    });
+  });
+}
+
+/**
+ * Creates something else.
+ *
+ * @function (arg1)
+ * @private
+ * @param {Function}        the function to call at the completion,
+ * @returns {}              -,
+ * @since 0.0.0
+ */
+function _doparallel1(done) {
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mdoparallel1\x1b[89m\x1b[0m\'...\n');
+
+  fs.writeFile(`${destination}/generic1.js`, 'bla bla', { encoding: 'utf8' }, (err) => {
+    if (err) throw new Error(err);
+
+    const d2 = new Date() - d1;
+    process.stdout.write(`Finished '\x1b[36mdodoparallel1\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+    done();
+  });
+}
+
+/**
+ * Creates something else.
+ *
+ * @function (arg1)
+ * @private
+ * @param {Function}        the function to call at the completion,
+ * @returns {}              -,
+ * @since 0.0.0
+ */
+function _doparallel2(done) {
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mdoparallel2\x1b[89m\x1b[0m\'...\n');
+
+  fs.writeFile(`${destination}/generic2.js`, 'bla bla', { encoding: 'utf8' }, (err) => {
+    if (err) throw new Error(err);
+
+    const d2 = new Date() - d1;
+    process.stdout.write(`Finished '\x1b[36mdodoparallel2\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+    done();
+  });
+}
+
+/**
+ * Removes the temp file(s).
+ *
+ * @function (arg1)
+ * @private
+ * @param {Function}        the function to call at the completion,
+ * @returns {}              -,
+ * @since 0.0.0
+ */
+function _delgeneric(done) {
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mdelgeneric\x1b[89m\x1b[0m\'...\n');
+
+  /**
+   * Wait all the processes are completed.
+   */
+  let pending = 2;
+  function _next() {
+    pending -= 1;
+    if (!pending) {
+      const d2 = new Date() - d1;
+      process.stdout.write(`Finished '\x1b[36mdelgeneric\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+      done();
+    }
+  }
+
+  fs.unlink(`${destination}/generic1.js`, (err) => {
+    if (err) throw new Error(err);
+    _next();
+  });
+
+  fs.unlink(`${destination}/generic2.js`, (err) => {
+    if (err) throw new Error(err);
+    _next();
+  });
+}
+
+
+// -- Main ---------------------------------------------------------------------
+
+/**
+ * Executes the script.
+ *
+ * @function ()
+ * @public
+ * @param {}                -,
+ * @returns {}              -,
+ * @since 0.0.0
+ */
+async function run() {
+  const PENDING = 2;
+
+  if (parsed.help) {
+    _help();
+    return;
+  }
+
+  if (parsed.version) {
+    process.stdout.write(`version: ${parsed.version}\n`);
+    return;
+  }
+
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mbuild:xxx:yyy\x1b[89m\x1b[0m\'...\n');
+
+  let pending = PENDING;
+  /**
+   * Executes done until completion.
+   */
+  function done() {
+    pending -= 1;
+    if (!pending) {
+      _delgeneric(() => {
+        const d2 = new Date() - d1;
+        process.stdout.write(`Finished '\x1b[36mbuild:xxx:yyy\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+      });
+    }
+  }
+
+  await _clean();
+  _doparallel1(done);
+  _doparallel2(done);
+}
+
+
+// Start script.
+run();
+
+
+// -- oOo --

package/scripts/build.js.dev.js

@@ -0,0 +1,284 @@
+#!/usr/bin/env node
+/* *****************************************************************************
+ *
+ * Creates the JS bundle.
+ *
+ * build:js.dev script creates the JS bundle from ./public/src/main.js by importing
+ * all the linked src files;
+ *
+ * Private Functions:
+ *  . _help                       displays the help message,
+ *  . _clean                      removes the previous build,
+ *  . _docore                     creates the content of the library,
+ *  . _doumdlib                   creates the UMD Module,
+ *  . _domodule                   creates the ES6 module,
+ *  . _delcore                    removes the temp file(s),
+ *
+ *
+ * Public Static Methods:
+ *  . run                         executes the script,
+ *
+ *
+ * @namespace    -
+ * @dependencies none
+ * @exports      -
+ * @author       -
+ * @since        0.0.0
+ * @version      -
+ * ************************************************************************** */
+/* eslint one-var: 0, semi-style: 0, no-underscore-dangle: 0 */
+
+'use strict';
+
+// -- Vendor Modules
+const fs   = require('fs')
+    , nopt = require('nopt')
+    ;
+
+
+// -- Local Modules
+const pack   = require('../package.json')
+    , config = require('./config')
+    ;
+
+
+// -- Local Constants
+const VERSION     = '0.0.0-alpha.0'
+    , opts        = {
+      help: [Boolean, false],
+      version: [String, null],
+    }
+    , shortOpts   = {
+      h: ['--help'],
+      v: ['--version', VERSION],
+    }
+    , parsed      = nopt(opts, shortOpts, process.argv, 2)
+    , destination = config.libdir
+    , { ES6GLOB } = config
+    , source      = config.src
+    , { libname } = config
+    , { name }    = config
+    , head        = source[0]
+    , core        = source.slice(1, -1)
+    , foot        = source[source.length - 1]
+    , { version } = pack
+    ;
+
+
+// -- Local Variables
+
+
+// -- Private Functions --------------------------------------------------------
+
+/**
+ * Dispays the help message.
+ *
+ * @function ()
+ * @private
+ * @param {}                -,
+ * @returns {}              -,
+ * @since 0.0.0
+ */
+function _help() {
+  const message = ['',
+    'Usage: command [options]',
+    '',
+    '                       creates the js bundle from ./public/src/main.js',
+    '',
+    'Options:',
+    '',
+    '-h, --help             output usage information',
+    '-v, --version          output the version number',
+    '',
+  ].join('\n');
+
+  process.stdout.write(`${message}\n`);
+}
+
+/**
+ * Removes the previous build.
+ *
+ * @function ()
+ * @private
+ * @param {}                -,
+ * @returns {}              -,
+ * @since 0.0.0
+ */
+function _clean() {
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mclean\x1b[89m\x1b[0m\'...\n');
+
+  fs.rmSync(destination, { force: true, recursive: true });
+  fs.mkdirSync(destination, { recursive: true });
+
+  const d2 = new Date() - d1;
+  process.stdout.write(`Finished '\x1b[36mclean\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+}
+
+/**
+ * Creates the content of the library.
+ *
+ * @function ()
+ * @private
+ * @param {}                -,
+ * @returns {}              -,
+ * @since 0.0.0
+ */
+function _docore() {
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mdocore\x1b[89m\x1b[0m\'...\n');
+
+  let src = '';
+  for (let i = 0; i < core.length; i++) {
+    src += fs.readFileSync(core[i]);
+    if (i < core.length - 1) {
+      src += '\n';
+    }
+  }
+
+  src = src
+    .replace(/{{lib:name}}/g, libname)
+    .replace(/{{lib:version}}/g, version)
+    // remove the extra global and 'use strict':
+    .replace(/\/\* global[\w$_\s,]+\*\//g, '/* - */')
+    .replace(/\n'use strict';\n/g, '')
+    // indent the first line with 2 spaces:
+    .replace(/^/g, '  ')
+    // indent each other lines with 2 spaces:
+    .replace(/\n/g, '\n  ')
+  ;
+
+  fs.writeFileSync(`${destination}/core.js`, src);
+  const d2 = new Date() - d1;
+  process.stdout.write(`Finished '\x1b[36mdocore\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+}
+
+/**
+ * Creates the UMD Module.
+ *
+ * @function ()
+ * @private
+ * @param {}                -,
+ * @returns {}              -,
+ * @since 0.0.0
+ */
+function _doumdlib() {
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mdoumdlib\x1b[89m\x1b[0m\'...\n');
+
+  let src = '';
+  src = fs.readFileSync(head);
+  src += '\n';
+  src += fs.readFileSync(`${destination}/core.js`);
+  src += '\n';
+  src += fs.readFileSync(foot);
+
+  src = src
+    .replace('{{lib:es6:define}}\n', '')
+    .replace('{{lib:es6:link}}', 'this')
+    .replace('{{lib:es6:export}}\n', '')
+    // fix the blanck lines we indented too:
+    .replace(/\s{2}\n/g, '\n')
+  ;
+
+  fs.writeFileSync(`${destination}/${name}.js`, src);
+  const d2 = new Date() - d1;
+  process.stdout.write(`Finished '\x1b[36mdoumdlib\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+}
+
+/**
+ * Creates the ES6 module.
+ *
+ * @function ()
+ * @private
+ * @param {}                -,
+ * @returns {}              -,
+ * @since 0.0.0
+ */
+function _domodule() {
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mdomodule\x1b[89m\x1b[0m\'...\n');
+
+  let exportM = '\n// -- Export\n';
+  exportM += `export default ${ES6GLOB}.${libname};`;
+
+  let src = '';
+  src = fs.readFileSync(head);
+  src += '\n';
+  src += fs.readFileSync(`${destination}/core.js`);
+  src += '\n';
+  src += fs.readFileSync(foot);
+
+  src = src
+    .replace('{{lib:es6:define}}', `const ${ES6GLOB} = {};`)
+    .replace('{{lib:es6:link}}', ES6GLOB)
+    .replace('{{lib:es6:export}}', exportM)
+    // fix the blanck lines we indented too:
+    .replace(/\s{2}\n/g, '\n')
+  ;
+
+  fs.writeFileSync(`${destination}/${name}.mjs`, src);
+  const d2 = new Date() - d1;
+  process.stdout.write(`Finished '\x1b[36mdomodule\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+}
+
+/**
+ * Removes the temp file(s).
+ *
+ * @function ()
+ * @private
+ * @param {}                -,
+ * @returns {}              -,
+ * @since 0.0.0
+ */
+function _delcore() {
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mdelcore\x1b[89m\x1b[0m\'...\n');
+  fs.unlinkSync(`${destination}/core.js`);
+
+  const d2 = new Date() - d1;
+  process.stdout.write(`Finished '\x1b[36mdelcore\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+}
+
+
+// -- Main ---------------------------------------------------------------------
+
+/**
+ * Executes the script.
+ *
+ * @function ()
+ * @public
+ * @param {}                -,
+ * @returns {}              -,
+ * @since 0.0.0
+ */
+function run() {
+  if (parsed.help) {
+    _help();
+    return;
+  }
+
+  if (parsed.version) {
+    process.stdout.write(`version: ${parsed.version}\n`);
+    return;
+  }
+
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mbuild:js:dev\x1b[89m\x1b[0m\'...\n');
+
+  _clean();
+  _docore();
+  _doumdlib();
+  _domodule();
+  _delcore();
+
+  const d2 = new Date() - d1;
+  process.stdout.write(`Finished '\x1b[36mbuild:js:dev\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+}
+
+
+// Start script.
+run();
+
+
+// -- oOo --