cli-components-build

cli-components / build

Small set of tools for Makefiles/Gulpfiles/etc.

installing

$ npm install cli-components-build --save

using

In lieu of a README, here's the .d.ts file, verbatim:

declare module 'cli-components-build' {
    export = CliComponentsBuildModule;
}

declare module CliComponentsBuildModule
{
    export interface ExecOutputReturnValue {
        code: number;
        output: string;
    }
    export interface TSConfigDictionary {
        [name: string]: any;
    }
    export interface GroupFiletypesResult {
        grouped: {
            [name: string]: string[];
        };
        rest: string[];
    }
    /**
        Returns the last-modified timestamp for the given file.
     */
    export function mtime(filepath: string): number;
    /**
        Applies some simple, default ANSI formatting to the output of a call to
        `exec` based on the success or failure indicated by its return code.
     */
    export function prettyExecResult(result: ExecOutputReturnValue): string;
    /**
        Parses the `tsconfig.json` at the specified path, assigns the keys/values in `assign` to the unserialized config
        object, and returns the result.
     */
    export var tsconfig: (assign?: {}, filepath?: string) => TSConfigDictionary;
    /**
        Groups the given files by the given extensions.  Any files with other extensions are added to the `rest` array
        on the return value.
     */
    export function groupFiletypes(files: string[], extensions: string[]): GroupFiletypesResult;
    /**
        Returns `false` for ".min.js" files.  Returns `true` if `file` has the extension ".js" but not the extension ".min.js".
     */
    export function isUnminifiedJS(file: string): boolean;
    /**
        Error object returned by the `tsify` (Typescript compiler) plugin for Browserify.
     */
    export interface TSifyCompileError {
        /** For example, 'src/user/index.ts(39,33): Error TS2304: Cannot find name \'PopupController\'.' */
        message: string;
        fileName: string;
        line: number;
        column: number;
        /** For example, 'TypeScript error'. */
        name: string;
    }
    /**
        Makes a halfhearted attempt to pretty print Typescript compile error objects generated by Browserify's `tsify` plugin.
     */
    export function prettyTSifyCompileError(err: TSifyCompileError): string;
    /**
        Colorizes and formats a simple "header" kind of thing.  You can surround text in asterisks to apply a highlight.  For example: "Installing *someprogram* version *1.0*"
     */
    export function header(text: any): string;
}

authors/contributors

• Bryn Austin Bellomy ([e-mail])