zuke.tools.tsc_alias

← Python API reference

@zuke/tsc-alias 1.1.0: @zuke/tsc-alias — typed tsc-alias task wrappers for Zuke builds.

Symbols

#

TscAliasRunSettings

class
class TscAliasRunSettings(ToolSettings)

Settings for a tsc-alias run.

  • project(path: str) -> Self

    Path to the tsconfig.json to read aliases from (-p/--project).

  • watch() -> Self

    Re-run on file changes (--watch).

  • out_dir(path: str) -> Self

    Output directory of the compiled files to rewrite (--outDir).

  • declaration_dir(path: str) -> Self

    Output directory of the emitted declaration files (--declarationDir).

  • resolve_full_paths() -> Self

    Attempt to fully resolve alias paths, including extensions (--resolveFullPaths).

  • resolve_full_extension(ext: str) -> Self

    Extension to append when resolving full paths, e.g. .js (--resolveFullExtension).

  • replacers(*files: str) -> Self

    Additional replacer module file(s); repeatable (-f/--replacers).

  • dir(path: str) -> Self

    Base directory to resolve relative paths against (--dir).

  • file_extensions(list: str) -> Self

    Comma-separated list of file extensions to process (--fileExtensions).

  • verbose() -> Self

    Print verbose output (--verbose).

  • debug() -> Self

    Print debug output (--debug).

  • silent() -> Self

    Suppress all output (--silent).

#

TscAliasTasks

class
class TscAliasTasks

Typed task functions for the tsc-alias path-alias rewriter.

  • static async run(ctx: ServiceContext, configure: Callable[[TscAliasRunSettings], TscAliasRunSettings] | None=None) -> ExecResult

    Rewrite TypeScript path aliases in compiled output with tsc-alias.