Gulp-minify.js NPM

</> minify.js

Recursively minify all JavaScript files.

💡 About

minify.js is a Gulp plug-in to recursively minify JavaScript files.

For a quick start on using Gulp: https://gulpjs.com/docs/en/getting-started/quick-start/

⚡ Installation

As a dev dependency, from your project root:

$ npm install -D gulp-minify.js

As a runtime dependency, from your project root:

$ npm install gulp-minify.js

💻 Usage

Use minify() w/ input/output args in your gulpfile.js:

const gulp = require('gulp'),
      minify = require('gulp-minify.js');

gulp.task('minify', cb => {
    minify('src', 'dist');
    cb();
});

Use minify() w/ no args, as part of a stream's transformations in your gulpfile.js:

const gulp = require('gulp'),
      minify = require('gulp-minify.js'),
      rename = require('gulp-rename');

gulp.task('minify', () => {    
    return gulp.src('src/**/*.js')
        .pipe(minify()) // use minify() arglessly as a stream transformation
        .pipe(rename({ suffix: '.min' })) // change suffix of minified file
        .pipe(gulp.dest('dist')); // save minified files to the 'dist' directory
});

Options are passed as object properties. For example:

// Minifies all unminified JS directly in 'src' including dotfiles to 'dist'
minify('src', 'dist', { dotFiles: true, recursive: false })

Available options are:

Name	Type	Desciption	Default value
`recursive`	Boolean	Recursively search for nested files if dir path passed.	`true`
`verbose`	Boolean	Show logging in console/terminal.	`true`
`dotFolders`	Boolean	Include dotfolders in file search.	`false`
`dotFiles`	Boolean	Include dotfiles in file search.	`false`
`mangle`	Boolean	Shorten variable names (typically to one character).	`true`
`comment`	String	Header comment to prepend to minified code.	`''`

🏛️ MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.