@borderless/ts-scripts/dist/index.d.ts

Simple, mostly opinionated, scripts to build TypeScript modules

/**
 * Test configuration object.
 */
export interface Test {
    dir: string | undefined;
    config: string | undefined;
}
/**
 * Configuration object.
 */
export interface Config {
    debug: boolean;
    dir: string;
    src: string[];
    ignore: string[];
    dist: string[];
    project: string[];
    checkProject: string[];
    test: Test[];
}
/**
 * Build the project using `tsc`.
 */
export declare function build(argv: string[], config: Config): Promise<void>;
/**
 * Run the pre-commit hook on every `git commit`.
 */
export declare function preCommit(argv: string[], config: Config): Promise<void>;
/**
 * Run checks intended for CI, basically formatting without auto-fixing.
 */
export declare function check(argv: string[], config: Config): Promise<void>;
/**
 * Run specs using `jest`.
 */
export declare function specs(argv: string[], config: Config): Promise<void>;
/**
 * Run full test suite without automatic fixes.
 */
export declare function test(argv: string[], config: Config): Promise<void>;
/**
 * Format code using `prettier`.
 */
export declare function format(argv: string[], config: Config): Promise<void>;
/**
 * Install any configuration needed for `ts-scripts` to work.
 */
export declare function install(argv: string[], config: Config): Promise<void>;
/**
 * Prints the generated configuration for debugging.
 */
export declare function config(argv: string[], config: Config): Promise<void>;
/**
 * Load `ts-scripts` configuration.
 */
export declare function getConfig(cwd: string): Promise<Config>;
/**
 * Main configuration options.
 */
export interface Options {
    cwd: string;
}
/**
 * Main script runtime.
 */
export declare function main(args: string[], options: Options): Promise<void>;