merger-js

MergerJS

Yet another lightweight and simple cross-platform build tool for JavaScript files, with CLI tooling, file imports, auto build capabilities and native OS notifications.

Because merger uses uglify-es for minification, you don't need to use any kind of transpilers in conjunction with this tool. You can use ES6+.

This tool is intended for small projects.

MergerJS does not support circular dependencies

NPM: LINK
GitHub: LINK
License: MIT
Dependencies:
├── uglify-es
├── neo-async
├── chokidar
├── commander
├── inquirer
├── node-notifier
├── chalk

---

Features

• CLI tooling
• Merge multiple JS files into one
• Use @import comments on a source file to specify the build order
• Minification, supporting ES6+ (optional)
• Auto builds on files changes (optional)
• Native OS build notifications (optional)
• Support for multiple source/build files

 

Getting Started

For the latest version of the README, always refer to the MergerJS GitHub repository's master branch:
https://github.com/joao-neves95/merger-js/blob/master/README.md

1) Node.js

You will need Node.js installed to run merger.

2) Install merger with NPM

Install globally -g with NPM:

npm i merger-js -g

or

npm install merger-js -g

 

Use:

1. Choose a source file (the first file to be merged) and, on the top of that file, add comments importing the files in the order you want them to be built, from the first to the last.
   Just like in a browser.

   Example:

   // @import 'helpers'
   // @import 'requests'
   // @import 'handlers'
   // @import 'listeners'
   // @import 'feature'
   

   • Instead of // @import 'fileName', you can just // @'fileName';
   • The extension names .js are optional;
   • The import of the source file is optional;
   • You can import files from different directories relative to the same source file.
     Example: // @import '../otherFolder/someFile'

 

1. Run merger init on the root of your project:
   This will set up the configuration model as well as some global configurations (minification, auto builds on file changes, native OS notifications).
   You can alter them later through the CLI with the "merger set" command (learn more in "Commands").

 

1. Run merger add to add a new source file to your merger configuration file (learn more in "Commands").

2. Run merger or merger build to start building (learn more in "Commands").

 

Commands

• merger init: Configure merger. It creates a merger-config.json file on your working directory.

• merger log: Print the configuration file contents.

• merger add: Add a new source file to the merger config file.
  You should run this command on the directory where the source file you want to add is located.
  MergerJS will give you the directory path, you input the source file name (the extension names are optional), or a relative path to that directory, and MergerJS will locate the configuration file and update it.

• merger rm: Remove a source file from the merger-config file.
  You can run this command anywhere within your project (after the configuration file). MergerJS will give you all your files within your configuration file and you remove one just by selecting it.

• merger or merger build: Execute the build with the configuration you gave it on the merger-config.json file.
  You can run it anywhere within your project's folder.

  • merger auto, merger build -a or merger build --auto: Execute an automatic build session. You can do this, for example, when you have auto builds turned off and you don't want to change that.

• merger set <configuration> <value>: Edit a configuration key on the merger-config file.
  You can run it anywhere within your project's folder.
  At the moment you can pass:

  • The <configuration> mnfy, minify or uglify and the <value> -t / --true or -f / --false to set minification to true or false (on/off);
  • The <configuration> auto or autobuild and the <value> -t / --true or -f / --false to set auto builds to true or false (on/off);
  • The <configuration> ntfs, notifs, notify, or notifications and the <value> -t / --true or -f / --false to set the native OS notifications to true or false (on/off);

  Examples: merger set minify -f, merger set autobuild --true, merger set notifs -t

• merger update: Update MergerJS. Same as npm install merger-js -g

 

Versioning

Merger uses SemVer for versioning. You can read the changelog here.

 

Code Style

JavaScript Standard Style, with semicolons.

I only do not use semicolons on browser JS.

 

Motivation

When I started doing academic web projects, I felt the need for a build tool to merge all my JS files into one, cleaning the HTML pages and optimizing my workflow.
I wanted something simple and fast, so I built MergerJS to use in my small web-app projects.

Changelog

v3.1.0 - 04/06/2018

• Added the "merger rm" command to remove source files from the configurtion file;
• Added the "merger log" command to print the configuration file;
• Refactoring of the editConfigFile module to have less code repetition;
• Fixed some typos.