@mobilabs/es6lib 1.0.14 → 1.1.0

package/tasks/build.skeleton.prod.js

@@ -0,0 +1,183 @@
+#!/usr/bin/env node
+/* *****************************************************************************
+ *
+ * Creates the production folder.
+ *
+ * build:skeleton:prod.js script creates the productiion folder and copies the
+ * files defined in config.js.
+ *
+ * Private Functions:
+ *  . _help                       displays the help message,
+ *  . _clean                      removes the previous production folder,
+ *  . _doskeleton                 creates the production folder and copies files,
+ *
+ *
+ * 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')
+    , path  = require('path')
+    , 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)
+    , { dist }     = config
+    , { webfiles } = config
+    ;
+
+
+// -- 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 production folder and copies the files defined in config.js',
+    '',
+    'Options:',
+    '',
+    '-h, --help           output usage information',
+    '-v, --version        output the version number',
+    '',
+  ].join('\n');
+
+  process.stdout.write(`${message}\n`);
+  process.exit(0);
+}
+
+/**
+ * Removes the previous production folder,
+ *
+ * @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(dist, { force: true, 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 production folder and copies files.
+ *
+ * @function (arg1)
+ * @private
+ * @param {Function}      the function to call at the completion,
+ * @returns {}            -,
+ * @since 0.0.0
+ */
+function _doskeleton(done) {
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mdoskeleton\x1b[89m\x1b[0m\'...\n');
+
+  let filename;
+  for (let i = 0; i < webfiles.length; i++) {
+    filename = path.basename(webfiles[i]);
+    fs.cp(webfiles[i], `${dist}/${filename}`, (err) => {
+      if (err) throw new Error(err);
+
+      const d2 = new Date() - d1;
+      process.stdout.write(`Finished '\x1b[36mdoskeleton\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+      done();
+    });
+  }
+}
+
+
+// -- Main ---------------------------------------------------------------------
+
+/**
+ * Executes the script.
+ *
+ * @function ()
+ * @puublic
+ * @param {}              -,
+ * @returns {}            -,
+ * @since 0.0.0
+ */
+function run() {
+  const PENDING = 1;
+
+  if (parsed.help) {
+    _help();
+  }
+
+  if (parsed.version) {
+    process.stdout.write(`version: ${parsed.version}\n`);
+    return;
+  }
+
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mbuild:skeleton:prod\x1b[89m\x1b[0m\'...\n');
+
+  let pending = PENDING;
+  /**
+   * Executes done until completion.
+   */
+  function done() {
+    pending -= 1;
+    if (!pending) {
+      const d2 = new Date() - d1;
+      process.stdout.write(`Finished '\x1b[36mbuild:skeleton:prod\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+    }
+  }
+
+  _clean();
+  _doskeleton(done);
+}
+
+
+// Start script.
+run();
+
+
+// -- oOo --

package/tasks/config.js

@@ -58,6 +58,12 @@ module.exports = {
   ],
   /* eslint-enable no-multi-spaces */
 
+  webfiles: [
+    // These are the files to copy to the root path of the web app,
+    './README.md',
+    './LICENSE.md',
+  ],
+
   get license() {
     return ['/*! ****************************************************************************',
       ` * ${libname} v${pack.version}`,

package/tasks/dep.private.js

@@ -0,0 +1,99 @@
+/* eslint one-var: 0, import/no-extraneous-dependencies: 0, semi-style: 0 */
+
+'use strict';
+
+// -- Vendor Modules
+const fs   = require('fs')
+    , path = require('path')
+    ;
+
+
+// -- Local Modules
+const config = require('./config')
+    ;
+
+
+// -- Local Constants
+const tmppriv      = './private_repo/tmp'
+    , { name }     = config
+    , { index }    = config
+    , { distlink } = config
+    ;
+
+
+// -- Local Variables
+
+
+// -- Private Tasks
+
+/**
+ * Removes the previous version.
+ */
+function clear() {
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mclear\x1b[89m\x1b[0m\'...\n');
+
+
+  fs.rmSync(tmppriv, { force: true, recursive: true });
+  fs.mkdirSync(tmppriv, { recursive: true });
+
+  const d2 = new Date() - d1;
+  process.stdout.write(`Finished '\x1b[36mclear\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+}
+
+
+/**
+ * Copies the modified index.
+ */
+function copyindex() {
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mcopyindex\x1b[89m\x1b[0m\'...\n');
+
+  let f = fs.readFileSync(index, 'utf-8');
+  f = f.replace(`./lib/${name}`, distlink);
+
+  const filename = path.basename(index);
+  fs.writeFileSync(`${tmppriv}/${filename}`, f);
+  const d2 = new Date() - d1;
+  process.stdout.write(`Finished '\x1b[36mcopyindex\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+}
+
+
+/**
+ * Copies the modified package.json
+ */
+function copypackagejson() {
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mcopypackagejson\x1b[89m\x1b[0m\'...\n');
+
+  const json = fs.readFileSync('./package.json', 'utf8');
+  const obj = JSON.parse(json);
+
+  obj.main = distlink;
+  obj.bin = {};
+  obj.scripts = {};
+  obj.dependencies = {};
+  obj.devDependencies = {};
+  obj.private = true;
+  obj.husky = {};
+
+  fs.writeFileSync(`${tmppriv}/package.json`, JSON.stringify(obj, null, 2), 'utf8');
+
+  const d2 = new Date() - d1;
+  process.stdout.write(`Finished '\x1b[36mcopypackagejson\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+}
+
+
+// -- Public Task(s)
+const d1 = new Date();
+process.stdout.write('Starting \'\x1b[36mdep:private\x1b[89m\x1b[0m\'...\n');
+
+clear();
+copyindex();
+copypackagejson();
+
+const d2 = new Date() - d1;
+process.stdout.write(`Finished '\x1b[36mdep:private\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+
+
+// -- oOo --

package/test/index.html

@@ -0,0 +1,59 @@
+<!-- x -->
+<!doctype html>
+<html class="no-js" lang="">
+  <head>
+    <meta charset="utf-8">
+    <title>View ES6lib</title>
+    <meta name="description" content="{{app:description}}">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    <link rel="stylesheet" href="">
+    <meta name="theme-color" content="#2196f3">
+    <style>
+      /* - */
+    </style>
+
+    <!-- <script src='./lib/view.js'></script> -->
+    <script>
+      document.addEventListener('DOMContentLoaded', () => {
+        /* global Pixi */
+        'use strict';
+        //
+      });
+    </script>
+  </head>
+
+  <body>
+    <!--[if IE]>
+      <p class="browserupgrade">You are using an <strong>outdated and unsupported</strong> browser. Please <a href="https://browsehappy.com/">upgrade your browser</a> to benefit of all the features of this web App.</p>
+    <![endif]-->
+
+    <!-- Warning message if Javascript isn't enabled -->
+    <noscript>
+      <p style="text-align:center;padding-top:3em;">
+        We are sorry, but this website doesn't work properly without JavaScript enabled!
+      </p>
+    </noscript>
+
+    <!-- Add your site or application content here -->
+    <div id="app"></div>
+
+    <!-- Add your scripts here -->
+    <script type="module">
+      import ES6lib from '../lib/es6lib.mjs';
+
+      console.log(ES6lib.VERSION);
+      console.log(Object.keys(ES6lib));
+
+      const lib = ES6lib();
+      console.log(lib.getString());
+      console.log(lib.getArray());
+
+      const el = document.getElementById('app');
+      el.append(`Es6lib $v${ES6lib.VERSION}`);
+      el.append(`   ... ${lib.getString()}`);
+      el.append(`   ... ${lib.getArray()}`);
+
+    </script>
+  </body>
+</html>

package/gulpfile.js

@@ -1,67 +0,0 @@
-/* eslint one-var: 0, semi-style: 0 */
-
-'use strict';
-
-// -- Vendor Modules
-const { watch, series } = require('gulp')
-    , connect = require('gulp-connect')
-    , open    = require('open')
-    ;
-
-
-// -- Local Modules
-
-
-// -- Local Constants
-const filesToWatch = ['src/**/*.js', 'src/_header', 'src/_footer']
-    ;
-
-
-// -- Local Variables
-
-
-// -- Gulp Private Tasks
-const build       = require('./tasks/makejs')
-    , makedist    = require('./tasks/makedist')
-    , makeprivate = require('./tasks/makeprivatepackage')
-    ;
-
-
-// -- Gulp watch
-function fwatch() {
-  watch(filesToWatch, series(build));
-}
-
-// -- Gulp connect dev
-function devserver(done) {
-  connect.server({
-    host: '0.0.0.0', // (allows remote access)
-    root: './',
-    port: 8888,
-    livereload: true,
-  });
-  open('http://localhost:8888/');
-  done();
-}
-
-// -- Gulp connect prod
-function appserver(done) {
-  connect.server({
-    host: '0.0.0.0', // (allows remote access)
-    root: './_dist',
-    port: 8889,
-    livereload: true,
-  });
-  open('http://localhost:8889/');
-  done();
-}
-
-
-// Gulp Public Tasks:
-exports.build = build;
-exports.watch = fwatch;
-exports.rundev = devserver;
-exports.makedist = makedist;
-exports.runapp = appserver;
-exports.makeprivate = makeprivate;
-exports.default = series(build, makedist, makeprivate);

package/tasks/makedist.js

@@ -1,91 +0,0 @@
-/* eslint one-var: 0, import/no-extraneous-dependencies: 0, semi-style: 0,
-  object-curly-newline: 0 */
-
-'use strict';
-
-// -- Vendor Modules
-const { src, dest, series, parallel } = require('gulp')
-    , del     = require('del')
-    , concat  = require('gulp-concat')
-    , header  = require('gulp-header')
-    , replace = require('gulp-replace')
-    , uglify  = require('gulp-uglify-es').default
-    ;
-
-
-// -- Local Modules
-const config = require('./config')
-    ;
-
-
-// -- Local Constants
-const { dist }    = config
-    , { libdir }  = config
-    , { name }    = config
-    , { license } = config
-    ;
-
-
-// -- Local Variables
-
-
-// -- Gulp Private Tasks
-
-// Removes the previous dist.
-function deldist(done) {
-  del.sync(dist);
-  done();
-}
-
-// Copies README and LICENSE.
-function doskeleton() {
-  return src(['README.md', 'LICENSE.md'])
-    .pipe(dest(dist))
-  ;
-}
-
-// Copies the development version.
-function copydev() {
-  return src(`${libdir}/${name}.js`)
-    .pipe(header(license))
-    .pipe(dest(`${dist}/lib`))
-  ;
-}
-
-// Copies the module development version.
-function copydevm() {
-  return src(`${libdir}/${name}.mjs`)
-    .pipe(header(license))
-    .pipe(dest(`${dist}/lib`))
-  ;
-}
-
-// Creates the minified version.
-function makeminified() {
-  return src(`${libdir}/${name}.js`)
-    .pipe(replace('/*! ***', '/** ***'))
-    .pipe(uglify())
-    .pipe(header(license))
-    .pipe(concat(`${name}.min.js`))
-    .pipe(dest(`${dist}/lib`))
-  ;
-}
-
-// Creates the module minified version.
-function makeminifiedm() {
-  return src(`${libdir}/${name}.mjs`)
-    .pipe(replace('/*! ***', '/** ***'))
-    .pipe(uglify())
-    .pipe(header(license))
-    .pipe(concat(`${name}.min.mjs`))
-    .pipe(dest(`${dist}/lib`))
-  ;
-}
-
-
-// -- Gulp Public Task(s):
-
-module.exports = series(
-  deldist,
-  parallel(doskeleton, copydev, copydevm, makeminified, makeminifiedm),
-);

package/tasks/makejs.js

@@ -1,103 +0,0 @@
-/* eslint one-var: 0, import/no-extraneous-dependencies: 0, semi-style: 0,
-  object-curly-newline: 0 */
-
-'use strict';
-
-// -- Vendor Modules
-const { src, dest, series, parallel } = require('gulp')
-    , del     = require('del')
-    , concat  = require('gulp-concat')
-    , replace = require('gulp-replace')
-    ;
-
-
-// -- Local Modules
-const pack   = require('../package.json')
-    , config = require('./config')
-    ;
-
-
-// -- Local Constants
-const 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
-
-
-// -- Gulp Private Tasks
-
-// Removes the previous version.
-function clean(done) {
-  del.sync(destination);
-  done();
-}
-
-// Creates the content.
-function docore() {
-  return src(core)
-    .pipe(replace('{{lib:name}}', libname))
-    .pipe(replace('{{lib:version}}', version))
-    // remove the extra global and 'use strict':
-    .pipe(replace(/\/\* global[\w$_\s,]+\*\//g, '/* - */'))
-    .pipe(replace(/\n'use strict';\n/, ''))
-    // indent the first line with 2 spaces:
-    .pipe(replace(/^/g, '  '))
-    // indent each other lines with 2 spaces:
-    .pipe(replace(/\n/g, '\n  '))
-    .pipe(concat('core.js'))
-    .pipe(dest(destination))
-  ;
-}
-
-// Create the UMD Module.
-function doumdlib() {
-  return src([head, `${destination}/core.js`, foot])
-    .pipe(replace('{{lib:es6:define}}\n', ''))
-    .pipe(replace('{{lib:es6:link}}', 'this'))
-    .pipe(replace('{{lib:es6:export}}\n', ''))
-    .pipe(concat(`${name}.js`))
-    // fix the blanck lines we indented too:
-    .pipe(replace(/\s{2}\n/g, '\n'))
-    .pipe(dest(destination))
-  ;
-}
-
-// Creates the ES6 module.
-function domodule() {
-  let exportM = '\n// -- Export\n';
-  exportM += `export default ${ES6GLOB}.${libname};`;
-
-  return src([head, `${destination}/core.js`, foot])
-    .pipe(replace('{{lib:es6:define}}', `const ${ES6GLOB} = {};`))
-    .pipe(replace('{{lib:es6:link}}', ES6GLOB))
-    .pipe(replace('{{lib:es6:export}}', exportM))
-    .pipe(concat(`${name}.mjs`))
-    // fix the blanck lines we indented too:
-    .pipe(replace(/\s{2}\n/g, '\n'))
-    .pipe(dest(destination))
-  ;
-}
-
-// Removes the temp file(s).
-function delcore(done) {
-  del.sync(`${destination}/core.js`);
-  done();
-}
-
-
-// -- Gulp Public Task(s)
-module.exports = series(
-  clean,
-  docore,
-  parallel(doumdlib, domodule),
-  delcore,
-);

package/tasks/makeprivatepackage.js

@@ -1,71 +0,0 @@
-/* eslint one-var: 0, import/no-extraneous-dependencies: 0, semi-style: 0 */
-
-'use strict';
-
-// -- Vendor Modules
-const { src, dest, series } = require('gulp')
-    , fs      = require('fs')
-    , del     = require('del')
-    , replace = require('gulp-replace')
-    ;
-
-
-// -- Local Modules
-const config = require('./config')
-    ;
-
-
-// -- Local Constants
-const tmppriv      = './private_repo/tmp'
-    , { name }     = config
-    , { index }    = config
-    , { distlink } = config
-    ;
-
-
-// -- Local Variables
-
-
-// -- Gulp Private Tasks
-
-// Removes the previous version.
-function clear(done) {
-  del.sync(tmppriv);
-  done();
-}
-
-// Copies the modified index.
-function copyindex() {
-  return src(index)
-    .pipe(replace(`./lib/${name}`, distlink))
-    .pipe(dest(tmppriv))
-  ;
-}
-
-// Copies the modified package.json
-function copypackagejson(done) {
-  fs.readFile('./package.json', 'utf8', (error, data) => {
-    if (error) { throw error; }
-    const obj = JSON.parse(data);
-    obj.main = distlink;
-    obj.bin = {};
-    obj.scripts = {};
-    obj.dependencies = {};
-    obj.devDependencies = {};
-    obj.private = true;
-    obj.husky = {};
-
-    // Write the updated package.json:
-    fs.writeFile(`${tmppriv}/package.json`, JSON.stringify(obj, null, 2), 'utf8', (err) => {
-      if (err) {
-        throw err;
-      }
-      done();
-    });
-  });
-}
-
-
-// -- Gulp Public Task(s)
-
-module.exports = series(clear, copyindex, copypackagejson);