@mobilabs/es6lib 2.1.0 → 2.1.2

package/scripts/build.skeleton.prod.js

@@ -0,0 +1,198 @@
+#!/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`);
+}
+
+/**
+ * Removes the previous production folder,
+ *
+ * @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(dist, { force: true, recursive: true }, (err) => {
+      if (err) throw new Error(err);
+
+      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 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');
+
+  /**
+   * Wait all processes completed;
+   */
+  let pending = webfiles.length;
+  function _next() {
+    pending -= 1;
+    if (!pending) {
+      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();
+    }
+  }
+
+  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);
+      _next();
+    });
+  }
+}
+
+
+// -- Main ---------------------------------------------------------------------
+
+/**
+ * Executes the script.
+ *
+ * @function ()
+ * @public
+ * @param {}                -,
+ * @returns {}              -,
+ * @since 0.0.0
+ */
+async function run() {
+  const PENDING = 1;
+
+  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: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`);
+    }
+  }
+
+  await _clean();
+  _doskeleton(done);
+}
+
+
+// Start script.
+run();
+
+
+// -- oOo --

package/scripts/compress.sh

@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+
+NAME=$1
+name=$(echo $1 | tr '[:upper:]' '[:lower:]')
+VERSION=$2
+NAMESPACE=$3
+NPM='private_repo'
+TMP='tmp'
+DIST='_dist'
+
+# Check if it is a package with a namespace. For instance @mobilabs/libname
+if [[ ! -z ${NAMESPACE} ]]
+then
+  # Remove the namespace:
+  NAMESPACE=${NAMESPACE}/
+  name=${name/${NAMESPACE}}
+  echo ${name}
+fi
+
+if [[ -z ${name} ]]
+then
+  echo 'You have to provide a name for the NPM package! Aborting ...'
+  exit 1
+fi
+
+if [[ -z ${VERSION} ]]
+then
+  echo 'You have to provide a version for the NPM package! Aborting ...'
+  exit 1
+fi
+
+mkdir -p ${NPM}/${name}/${VERSION}/${name}
+cp ${NPM}/${TMP}/index.js ${NPM}/${name}/${VERSION}/${name}/.
+cp ${NPM}/${TMP}/package.json ${NPM}/${name}/${VERSION}/${name}/.
+rm -rf ${NPM}/${TMP}
+
+cp -r ${DIST} ${NPM}/${name}/${VERSION}/${name}/_dist
+cd ${NPM}/${name}/${VERSION}
+tar zcvf ${name}.tgz ${name}/
+rm -rf ${name}
+echo 'Done!'

package/scripts/config.js

@@ -0,0 +1,80 @@
+/* eslint one-var: 0, semi-style: 0 */
+
+'use strict';
+
+// -- Vendor Modules
+
+
+// -- Local Modules
+const pack = require('../package.json');
+
+
+// -- Local Constants
+const libname = 'ES6lib'
+    , name    = libname.replace(/\s+/g, '').toLowerCase()
+    ;
+
+
+// -- Local Variables
+
+
+// -- Main
+
+module.exports = {
+  ES6GLOB: '$__ES6GLOB',
+  dist: './_dist',
+  libdir: './lib',
+  libname,
+  name,
+  index: './index.js',
+  distlink: `./_dist/lib/${name}.js`,
+
+  // These are the Javascript files required to build the library. Choose one
+  // pattern among these ones. The library can include only the header file,
+  // a core file and the footer file. The files 'basic.js', 'functional.js',
+  // 'functional-shared.js', 'prototypal.js', 'pseudoclassical.js' and
+  // 'pseudoclassical-auto.js' are mutually exclusives.
+  /* eslint-disable no-multi-spaces */
+  src: [
+    // These three files (_header, _head.js and extend.js) must be declared
+    // in this order as they create the umd module, define the global
+    // constants/variables, the object tree and the function to fill
+    // the tree!
+    './src/_header',
+    './src/_head.js',
+    './src/lib/extend.js',
+
+    './src/util/util.js',
+    // './src/basic.js',
+    // './src/basicplus.js',
+    // './src/functional.js',
+    // './src/functional-shared.js',
+    './src/prototypal.js',
+    // './src/pseudoclassical.js',
+    // './src/pseudoclassical-auto.js',
+
+    // This file must always be the last one as it closes the umd module.
+    './src/_footer',
+  ],
+  /* 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}`,
+      ' *',
+      ` * ${pack.description}.`,
+      ' * (you can download it from npm or github repositories)',
+      ` * Copyright (c) ${(new Date()).getFullYear()} ${pack.author.name} <${pack.author.email}> (${pack.author.url}).`,
+      ' * Released under the MIT license. You may obtain a copy of the License',
+      ' * at: http://www.opensource.org/licenses/mit-license.php).',
+      ' * Built from {{boiler:name}} v{{boiler:name:version}}.',
+      ' * ************************************************************************** */',
+      ''].join('\n');
+  },
+};

package/scripts/dep.npm.private.sh

@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+
+NAME=$1
+name=$(echo $1 | tr '[:upper:]' '[:lower:]')
+VERSION=$2
+NAMESPACE=$3
+NPM='npm_private_repo'
+
+# Check if it is a package with a namespace. For instance @mobilabs/libname
+if [[ ! -z ${NAMESPACE} ]]
+then
+  PREFIX=${NAMESPACE/@}
+  # remove the namespace:
+  NAMESPACE=${NAMESPACE}/
+  name=${name/${NAMESPACE}}
+  echo ${name}
+fi
+
+if [[ -z ${name} ]]
+then
+  echo 'You have to provide a name for the NPM package! Aborting ...'
+  exit 1
+fi
+
+if [[ -z ${VERSION} ]]
+then
+  echo 'You have to provide a version for the NPM package! Aborting ...'
+  exit 1
+fi
+
+mkdir -p ${NPM}/${name}
+if [[ ! -z ${NAMESPACE} ]]
+then
+  mv ${PREFIX}-${name}-${VERSION}.tgz ./${NPM}/${name}/.
+else
+  mv ${name}-${VERSION}.tgz ./${NPM}/${name}/.
+fi
+
+echo 'done!'
+
+
+# -- oOo --

package/scripts/dep.private.js

@@ -0,0 +1,232 @@
+#!/usr/bin/env node
+/* *****************************************************************************
+ *
+ * Creates a private npm package.
+ *
+ * dep:private script creates a npm package not to be published but used
+ * locally.
+ *
+ * Private Functions:
+ *  . _help                       displays the help message,
+ *  . _clean                      removes the previous build,
+ *  . _copyindex                  copies the modified index,
+ *  . _copypackagejson            copies the modified package.json,
+ *
+ *
+ * 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)
+    , tmppriv      = './private_repo/tmp'
+    , { name }     = config
+    , { index }    = config
+    , { distlink } = 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 a private npm package to be used locally',
+    '',
+    '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(tmppriv, { force: true, recursive: true }, (err1) => {
+      if (err1) throw new Error(err1);
+
+      fs.mkdir(tmppriv, { 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();
+      });
+    });
+  });
+}
+
+/**
+ * Copies the modified index.
+ *
+ * @function (arg1)
+ * @private
+ * @param {Function}        the function to call at the completion,
+ * @returns {}              -,
+ * @since 0.0.0
+ */
+function _copyindex(done) {
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mcopyindex\x1b[89m\x1b[0m\'...\n');
+
+  fs.readFile(index, 'utf8', (err1, data) => {
+    if (err1) throw new Error(err1);
+
+    const content = data.replace(`./lib/${name}`, distlink);
+    fs.writeFile(`${tmppriv}/${path.basename(index)}`, content, { encoding: 'utf8' }, (err2) => {
+      if (err2) throw new Error(err2);
+
+      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`);
+      done();
+    });
+  });
+}
+
+/**
+ * Copies the modified package.json.
+ *
+ * @function (arg1)
+ * @private
+ * @param {Function}        the function to call at the completion,
+ * @returns {}              -,
+ * @since 0.0.0
+ */
+function _copypackagejson(done) {
+  const d1 = new Date();
+  process.stdout.write('Starting \'\x1b[36mcopypackagejson\x1b[89m\x1b[0m\'...\n');
+
+  fs.readFile('./package.json', 'utf8', (err1, data) => {
+    if (err1) throw new Error(err1);
+
+    const obj = JSON.parse(data);
+    obj.main = distlink;
+    obj.bin = {};
+    obj.scripts = {};
+    obj.dependencies = {};
+    obj.devDependencies = {};
+    obj.private = true;
+    obj.husky = {};
+
+    fs.writeFile(`${tmppriv}/package.json`, JSON.stringify(obj, null, 2), { encooding: 'utf8' }, (err2) => {
+      if (err2) throw new Error(err2);
+
+      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`);
+      done();
+    });
+  });
+}
+
+
+// -- 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[36mdep:private\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[36mdep:private\x1b[89m\x1b[0m' after \x1b[35m${d2} ms\x1b[89m\x1b[0m\n`);
+    }
+  }
+
+  await _clean();
+  _copyindex(done);
+  _copypackagejson(done);
+}
+
+
+// Start script.
+run();
+
+
+// -- oOo --

package/test/index.html

@@ -50,7 +50,7 @@
       console.log(lib.getArray());
 
       const el = document.getElementById('app');
-      el.append(`Es6lib $v${ES6lib.VERSION}`);
+      el.append(`Es6lib v${ES6lib.VERSION}`);
       el.append(`   ... ${lib.getString()}`);
       el.append(`   ... ${lib.getArray()}`);