jb
v0.0.1
Published
Simple JavaScript builder
Downloads
31
Readme
jb
Simple JavaScript builder
Description
jk is a Node.JS module, providing Command Line Interface (and some library functions) for quick & easy compiling several client JavaScript-files into one.
Features:
- Support
import
andinclude
instructions within modules code. - Code minification.
Installation
npm install -g jb
Example
file1.js:
module.name = 'MyName';
file2.js:
console.log('Hello, world!');
index.js:
var file1 = import('file1.js');
include('file2.js');
After execution command jb index.js
, there will be output.js
file with the following content:
var file1 = (function (module) {
module.name = 'MyName';
return module;
}({}));
console.log('Hello, world!');
Build
You can provide to jb following build options:
root
: Build's root directory (forimport
andinclude
instructions). Default:.
.filename
: Path to the root source file. Default:index.js
.output
: Path to the output JavaScript file. Default:output.js
.min
: Iftrue
, source code will be minified by UnglifyJS. Default:false
.
Command line parameters
Build current directory with default options:
jb
Specify the root source file:
jb index.js
Other parameters:
jb index.js --min --output my.js --root /home/my/project
build.json
You can save chosen parameters in build.json
file in the build directory:
{
"filename": "mySource.js",
"output": "my.js",
"min": "true"
}
jb finds build.json
file in the current directory and loads it's parameters.
Documentation
Class: jk.Builder
new Builder(options)
Constructor. Returns jk.Builder
instance.
options.filename
: Path to the root source file.options.root
: Project's root directory.options.min
: Minification flag (true
/false
).options.output
: Path to the output file.
config([options])
Sets or returns options
object's properties.
options
: Optional argument. If one not specified, the method just returns currentoptions
object withfilename
,root
,min
andoutput
properties. Ifoptions
is a string, the method returns current value of the specified property. Ifoptions
is an object, the method sets specified properties.
build([output])
Compiles source files and writes result to the output file.
output
: Path to the output file (optional).