protoc-gen-grpc/src/lib/Utility.ts

Protocol Buffers Compiler (protoc) plugin for generating grpc interfaces in TypeScript..

import {FileDescriptorProto} from 'google-protobuf/google/protobuf/descriptor_pb';
import {EnumEntry, MessageEntry} from './EntryMap';

const PROTO2_SYNTAX = 'proto2';

export namespace Utility {

    export function filePathToPseudoNamespace(filePath: string): string {
        return filePath.replace('.proto', '').replace(/\//g, '_').replace(/\./g, '_').replace(/\-/g, '_') + '_pb';
    }

    export function snakeToCamel(str: string): string {
        return str.replace(/(\_\w)/g, function (m) {
            return m[1].toUpperCase();
        });
    }

    export function ucFirst(str: string): string {
        return str.charAt(0).toUpperCase() + str.slice(1);
    }

    export function lcFirst(str: string): string {
        return str.charAt(0).toLowerCase() + str.slice(1);
    }

    export function isProto2(fileDescriptor: FileDescriptorProto): boolean {
        // Empty syntax defaults to proto2
        return (fileDescriptor.getSyntax() === '' || fileDescriptor.getSyntax() === PROTO2_SYNTAX);
    }

    export function oneOfName(name: string) {
        return Utility.ucFirst(Utility.snakeToCamel(name));
    }

    export function generateIndent(indentLevel: number): string {
        let indent = '';
        for (let i = 0; i < indentLevel; i++) {
            indent += '  ';
        }
        return indent;
    }

    export function getPathToRoot(fileName: string) {
        const depth = fileName.split('/').length;
        return depth === 1 ? './' : new Array(depth).join('../');
    }

    export function withinNamespaceFromExportEntry(name: string, exportEntry: MessageEntry | EnumEntry) {
        return exportEntry.pkg ? name.substring(exportEntry.pkg.length + 1) : name;
    }

    export function filePathFromProtoWithoutExtension(protoFilePath: string): string {
        return protoFilePath.replace('.proto', '_pb');
    }

    export function svcFilePathFromProtoWithoutExtension(protoFilePath: string): string {
        return protoFilePath.replace('.proto', '_grpc_pb');
    }

    export function withAllStdIn(callback: (buffer: Buffer) => void): void {
        const ret: Buffer[] = [];
        let len = 0;

        const stdin = process.stdin;
        stdin.on('readable', function () {
            let chunk;
            while ((chunk = stdin.read())) {
                if (!(chunk instanceof Buffer)) throw new Error('Did not receive buffer');
                ret.push(chunk);
                len += chunk.length;
            }
        });

        stdin.on('end', function () {
            callback(Buffer.concat(ret, len));
        });
    }

    // normaliseFieldObjectName modifies the field name that appears in the `asObject` representation
    // to match the logic found in `protobuf/compiler/js/js_generator.cc`. See: https://goo.gl/tX1dPQ
    export function normaliseFieldObjectName(name: string): string {
        switch (name) {
            case 'abstract':
            case 'boolean':
            case 'break':
            case 'byte':
            case 'case':
            case 'catch':
            case 'char':
            case 'class':
            case 'const':
            case 'continue':
            case 'debugger':
            case 'default':
            case 'delete':
            case 'do':
            case 'double':
            case 'else':
            case 'enum':
            case 'export':
            case 'extends':
            case 'false':
            case 'final':
            case 'finally':
            case 'float':
            case 'for':
            case 'function':
            case 'goto':
            case 'if':
            case 'implements':
            case 'import':
            case 'in':
            case 'instanceof':
            case 'int':
            case 'interface':
            case 'long':
            case 'native':
            case 'new':
            case 'null':
            case 'package':
            case 'private':
            case 'protected':
            case 'public':
            case 'return':
            case 'short':
            case 'static':
            case 'super':
            case 'switch':
            case 'synchronized':
            case 'this':
            case 'throw':
            case 'throws':
            case 'transient':
            case 'try':
            case 'typeof':
            case 'var':
            case 'void':
            case 'volatile':
            case 'while':
            case 'with':
                return `pb_${name}`;
        }
        return name;
    }
}