gulp-protobuf/src/index.ts

Gulp task for the protobufjs pbjs and pbts tools

/*
* gulp-protobuf
* Copyright (c) 2018 Rob Moran
*
* The MIT License (MIT)
*
* 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.
*/

import { main as pbjsCli } from "protobufjs/cli/pbjs";
import { main as pbtsCli } from "protobufjs/cli/pbts";
import { basename, join, dirname, extname } from "path";
import { obj as through } from "through2";
import * as PluginError from "plugin-error";
import { Transform } from "stream";

const PLUGIN_NAME = "gulp-protobuf";

export interface PbjsOptions {
    /**
     * Specifies the target format. Also accepts a path to require a custom target
     * json          JSON representation (default)
     * json-module   JSON representation as a module
     * proto2        Protocol Buffers, Version 2
     * proto3        Protocol Buffers, Version 3
     * static        Static code without reflection (non-functional on its own)
     * static-module Static code without reflection as a module
     */
    target?: string;
    /**
     * Adds a directory to the include path
     */
    path?: string;
    /**
     * Specifies the wrapper to use. Also accepts a path to require a custom wrapper
     * default   Default wrapper supporting both CommonJS and AMD
     * commonjs  CommonJS wrapper
     * amd       AMD wrapper
     * es6       ES6 wrapper (implies --es6)
     * closure   A closure adding to protobuf.roots where protobuf is a global
     */
    wrap?: string;
    /**
     * Specifies an alternative protobuf.roots name
     */
    root?: string;
    /**
     * Linter configuration. Defaults to protobuf.js-compatible rules:
     * eslint-disable block-scoped-var, no-redeclare, no-control-regex, no-prototype-builtins
     */
    lint?: string;
    /**
     * Enables ES6 syntax (const/let instead of var) (default false)
     */
    es6?: boolean;
    /**
     * Keeps field casing instead of converting to camel case (default false)
     */
    "keep-case"?: boolean;
    /**
     * Does not generate create functions used for reflection compatibility (default false)
     */
    "no-create"?: boolean;
    /**
     * Does not generate encode functions (default false)
     */
    "no-encode"?: boolean;
    /**
     * Does not generate decode functions (default false)
     */
    "no-decode"?: boolean;
    /**
     * Does not generate verify functions (default false)
     */
    "no-verify"?: boolean;
    /**
     * Does not generate convert functions like from/toObject (default false)
     */
    "no-convert"?: boolean;
    /**
     * Does not generate delimited encode/decode functions (default false)
     */
    "no-delimited"?: boolean;
    /**
     * Does not beautify generated code (default false)
     */
    "no-beautify"?: boolean;
    /**
     * Does not output any JSDoc comments (default false)
     */
    "no-comments"?: boolean;
    /**
     * Enfores the use of 'Long' for s-/u-/int64 and s-/fixed64 fields (default false)
     */
    "force-long"?: boolean;
    /**
     * Enfores the use of 'number' for s-/u-/int64 and s-/fixed64 fields (default false)
     */
    "force-number"?: boolean;
    /**
     * Enfores the use of enum strings (default false)
     */
    "force-enum-string"?: boolean;
    /**
     * Enfores the use of message instances instead of plain objects (default false)
     */
    "force-message"?: boolean;
}

export interface PbtsOptions {
    /**
     * Name of the global object in browser environments, if any
     */
    global?: string;
    /**
     * Does not output any JSDoc comments (default false)
     */
    "no-comments"?: boolean;
    /**
     * Wraps everything in a module of the specified name
     */
    name?: string;
    /**
     * Whether building the main library without any imports (default false)
     */
    main?: boolean;
}

function task(fn: (args: Array<string>, callback: (err: Error|null, output?: string) => {}) => void, options: {} = {}, ext: string): Transform {

    const args = Object.keys(options).reduce((sequence, key) => {
        sequence.push(`--${key}`);

        const value = options[key];
        if (value !== true) {
            sequence.push(value);
        }

        return sequence;
    }, []);

    return through((file, _enc, callback) => {

        if (file.isNull()) {
            // return empty file
            callback(null, file);
        }

        if (file.isBuffer()) {
            fn(args.concat([ file.path ]), (err, output) => {

                if (err) throw new PluginError(PLUGIN_NAME, err);

                file.contents = new Buffer(output);
                const fileName = `${basename(file.path, extname(file.path))}${ext}`;
                file.path = join(dirname(file.path), fileName);

                callback(null, file);
                return {};
            });
        } else {
            callback(null, file);
        }
    });
}

export function pbjs(options: PbjsOptions): Transform {
    return task(pbjsCli, options, ".js");
}

export function pbts(options: PbtsOptions): Transform {
    return task(pbtsCli, options, ".d.ts");
}