Gulp-PHP-Minify

Gulp.js plug-in minifying PHP source code by removing comments and whitespace.

Getting started

If you haven't used Gulp.js before, be sure to check out the related documentation, as it explains how to create a gulpfile.js as well as install and use plug-ins. Once you're familiar with that process, you may install this plug-in with this command:

$ npm install --save-dev @cedx/gulp-php-minify

Once the plug-in has been installed, it may be enabled inside your gulpfile.js.

Usage

The plug-in takes a list of PHP scripts as input, and removes the comments and whitespace in these files by applying the php_strip_whitespace() function on their contents:

const gulp = require('gulp');
const {phpMinify} = require('@cedx/gulp-php-minify');

gulp.task('minify:php', () => gulp.src('path/to/lib/**/*.php', {read: false})
  .pipe(phpMinify())
  .pipe(gulp.dest('path/to/out'))
);

The plug-in only needs the file paths, so you should specify the read option to false when providing the file list, and you should not have any other plug-in before it.

Options

binary

The plug-in relies on the availability of the PHP executable on the target system. By default, the plug-in will use the php binary found on the system path.

If the plug-in cannot find the default php binary, or if you want to use a different one, you can provide the path to the php executable by using the binary option:

return gulp.src('path/to/lib/**/*.php', {read: false})
  .pipe(phpMinify({binary: 'C:\\Program Files\\PHP\\php.exe'}))
  .pipe(gulp.dest('path/to/out'));

mode

The plug-in can work in two manners, which can be selected using the mode option:

• the safe mode: as its name implies, this mode is very reliable. But it is also very slow as it spawns a new PHP process for every file to be processed. This is the default mode.
• the fast mode: as its name implies, this mode is very fast, but it is not very reliable. It spawns a PHP web server that processes the input files, but on some systems this fails. This mode requires a PHP runtime version 7.0 or later.

return gulp.src('path/to/lib/**/*.php', {read: false})
  .pipe(phpMinify({mode: 'fast'}))
  .pipe(gulp.dest('path/to/out'));

silent

By default, the plug-in prints to the standard output the paths of the minified scripts. You can disable this output by setting the silent option to true.

return gulp.src('path/to/lib/**/*.php', {read: false})
  .pipe(phpMinify({silent: true}))
  .pipe(gulp.dest('path/to/out'));

See also

• API reference
• Code coverage
• Continuous integration

License

Gulp-PHP-Minify is distributed under the Apache License, version 2.0.