Gulp-elementsjs-interpreter NPM

Installing the elementsJS Interpreter

Using gulp.js

If you don't know how to use gulp, you can find a nice tutorial here. First, you will need to install the gulp-elementsJS-interpreter package (Along with gulp and any other plug-ins you'll be using). It is available on npm's registry:

$ npm i --save-dev gulp-elementsJS-interpreter

In case you are new to npm, the --save-dev simply lists the package as one of your devDependencies in your application's package.json file. To use the interpreter, see below:

//import the necessary modules
var elemsJS = require('gulp-elementsJS-interpreter'),
     uglify = require('gulp-uglify'),
      babel = require('gulp-babel'),
       gulp = require('gulp');

//define task, source file and destination
 gulp.task('default', ()=> {
   var srcJS = './index.js',
       dest  = './dist/';
//stream file through elemsJS-interpreter, babel and uglify
   return gulp.src(srcJS)
  	  .pipe(elemsJS()) //<<-ALWAYS PUT AT BEGINNING OF STREAM.
      .pipe(babel())
      .pipe(uglify())
      .pipe(gulp.dest(dest));
   });

Note - Always put the elementsJS-interpreter first in your stream, otherwise you will run into many errors.

The imports() function

-- The imports() function is a convenience function that allows the quick importing of many modules and/or module functions all at once. It is not necessary to use this function in order to use the library, it just makes it quicker/easier to import all of its' functions separately.

Note- Use of this function requires compilation by the elementsJS-interpreter.

In order to use the imports function, it must first be imported from the module as such:

var imports = require('elementsJS').imports;

or,

import { imports } from 'elementsJS';

`imports( {module: funcs/moduleAlias} )`

Arguments

{module: funcs or moduleAlias} (object) - An object, the key of which is the name of a module (string) ex. 'lodash', and the value is either a list of functions (array) ex. ['make', 'go'], or the variable name given to the module being imported (string) ex. '_', for lodash.

Returns: nuffin.

Usage

The imports function can be used to conveniently import individual functions from modules, or entire modules. If functions will be imported from the module individually, usage is as below:

imports({
	'elementsJS': ['make', 'go', 'dom', 'on'],
   '../js/utils': ['buildMenu'], // << see Note below *
	    'lodash': '_'
});
//functions are used like so:

make('#foo', 'button');

buildMenu();

Note that if only 1 function is being imported, an array still needs to be used, otherwise, the entire module will be imported. See below.

Entire modules can be imported like so:

imports({
	'elementsJS': 'elemsJS',
   '../js/utils': 'utils',
	    'lodash': '_',
});
//functions are used like so:

elemsJS.make('#foo', 'button');

utils.buildMenu();