turbo-gulp/project.d.ts

Gulp tasks to boost high-quality projects.

import { TslintOptions } from "./options/tslint";
import { TypescriptOptions } from "./options/typescript";
import { AbsPosixPath, PosixPath, RelPosixPath, SysPath } from "./types";
/**
 * Project-wide options.
 * These affect all the targets.
 * It defines the main structure of the project.
 */
export interface Project {
    /**
     * The root directory of the project.
     * This corresponds usually to the root of the repository.
     *
     * **This should be the only absolute path in the configuration.**
     */
    readonly root: SysPath;
    /**
     * Path to the `package.json` file, relative to `root`.
     */
    readonly packageJson: RelPosixPath;
    /**
     * Path to the build directory relative to `root`. This is the directory where all of the builds
     * will be placed.
     */
    readonly buildDir: RelPosixPath;
    /**
     * Path to the dist directory relative to `root`.
     * This is the directory where files ready for distribution are placed.
     */
    readonly distDir: RelPosixPath;
    /**
     * Path the source directory relative to `root`.
     * This is the directory where all of the source files and assets are located.
     */
    readonly srcDir: RelPosixPath;
    /**
     * Tslint options.
     *
     * @default `{tslintJson: "tslint.json"}`
     */
    readonly tslint?: TslintOptions;
    /**
     * Typescript options, targets inherit these options.
     * See the merge rules to see how the target options are merged with the project options.
     *
     * @default [[DEFAULT_PROJECT_TS_OPTIONS]]
     */
    readonly typescript?: TypescriptOptions;
}
/**
 * Project with fully resolved paths.
 */
export interface ResolvedProject extends Project {
    /**
     * Absolute POSIX path for the root directory.
     */
    readonly absRoot: AbsPosixPath;
    /**
     * Absolute path to the `package.json` file.
     */
    readonly absPackageJson: AbsPosixPath;
    /**
     * Absolute path to the `build` dir, for development builds.
     */
    readonly absBuildDir: AbsPosixPath;
    /**
     * Absolute path to the directory containing distribution-ready files.
     */
    readonly absDistDir: AbsPosixPath;
    /**
     * Absolute path to the sources dir.
     */
    readonly absSrcDir: AbsPosixPath;
}
/**
 * Preconfigured project configuration.
 * It uses process.cwd() as the root and assumes a standard project structure.
 */
export declare const DEFAULT_PROJECT: Project;
/**
 * Normalizes a system-dependent path to a POSIX path.
 *
 * @param path System-dependent path.
 * @return Normalized POSIX path.
 */
export declare function toPosix(sysPath: SysPath): PosixPath;
/**
 * Resolve absolute paths for project locations.
 * This creates a shallow copy of the project configuration.
 * If the project was already resolved, it will compute the resolved values again anyway so you it
 * guarantees that the result is coherent.
 *
 * @param project Project configuration.
 * @return Project configuration with resolved paths.
 */
export declare function resolveProject(project: Project): ResolvedProject;
export declare function registerProjectTasks(): void;