nwixtoolset/lib/shine.d.ts

Node module wrapper around the WIX Toolset executables.

import { RunResult, RunOptions } from "./run";
/**
 * WIX Toolset Scanner.
 *
 * @param src           The file(s) to scan (path|*.wixproj|*.wixpdb|...).
 * @param [options]     Options for the scanner.
 */
export declare function shine(src: string | string[], options?: ShineOptions): Promise<RunResult>;
/** Options for the Shine executable. */
export interface ShineOptions extends RunOptions {
    /** Save scan as DGML file. */
    dgml?: string;
    /** A valid DGML file populated with data from scan. */
    dgmlTemplate?: string;
    /** Filter scan to include only specified symbol(s). */
    includeSymbol?: string | string[];
    /** Remove symbol and symbols it references from scan. */
    excludeSymbol?: string | string[];
    /** Displays only the specified items in the scan. (default: all) */
    show?: ShineShowItems | ShineShowItems[];
}
export declare type ShineShowItems = 
/** Project files. */
"proj" | 
/** Source files. */
"file" | 
/** Symbols. */
"sym" | 
/** Symbol references. */
"ref" | 
/** All of the above [default]. */
"all";