gulp-cmdcompile

By Shawn Li <[email protected]>

gulp-cmdcompile is a gulp plugin designed to bring flexible file compilation with command line tools to gulp build ecosystem.

Installation

NPM

$ npm install --save-dev gulp-cmdcompile

Yarn

$ yarn add --dev gulp-cmdcompile

Example

const path = require('path');
const gulp = require('gulp');
const changed = require('gulp-changed');
const cmdcompile = require('gulp-cmdcompile');

gulp.task('build-file', function () {
    return gulp.src('*.cc', {read:false})
        .pipe(changed('build', {
            transformPath: p => path.join(path.dirname(p), path.basename(p, '.cc'))
        }))
        .pipe(cmdcompile('g++', ['-std=c++11'], ['-lpthread'], {
            print_build: true, 
            filename_transform: 'stripext'
        }))
        .pipe(gulp.dest('build'));
});

Mind that you should add {read: false} option to to forbid file content loading in gulp.src(). While it's not totally contradict with underlying mechanism of gulp-cmdcompile, it's a good practice to be explicit in your program and this plugin force your to do that.

Documentation

cmdcompile(program [, pre_arglist] [, post_arglist] [, options])

Calling cmdcompile will return a stream object suitable to feed in pipe line of gulp construct. It accept at most three arguments, while only the first one(program) is required.

program

Type: String
the program name this plugin should invoke to process source files. In most cases, command line compiler program should fit, like g++ and clang or even tc(Typescript compiler) if you mean it.

pre_arglist (optional)

Type: Array of String
List of arguments that would passed to compiler through command line before source file. You can specify any optimization and compiling macros here.

post_arglist (optional)

List of arguments that would passed to compiler through command line after source file. You can specify linked libraries here.

options (optional)

Type: Object
Currently two options are supported.
print_debug : true|false
whether output compiler tool's stdout and stderr

filename_transform : none|stripext|<function>
Default to none(no transformation). Providing stripext will strip output file's extension, commonly used in C/C++ program. You can also customize transformation rule by providing a function that accept single argument as source file name and return target file name in any way you wish.

MIT License

Copyright (c) 2017 Shawn Li <[email protected]>

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.