@terrazzo/cli/dist/index.d.ts

CLI for managing design tokens using the Design Tokens Community Group (DTCG) standard and generating code for any platform via plugins.

import { BuildRunnerResult, Config, ConfigInit, Logger } from "@terrazzo/parser";
import * as url0 from "url";

//#region src/shared.d.ts
declare const cwd: url0.URL;
declare const DEFAULT_CONFIG_PATH: url0.URL;
declare const DEFAULT_TOKENS_PATH: url0.URL;
type Command = 'build' | 'check' | 'help' | 'init' | 'version';
declare const GREEN_CHECK: string;
interface Flags {
  /** --config, -c */
  config?: string;
  /** --out, -o */
  out?: string;
  /** --help */
  help?: boolean;
  /** --watch, -w */
  watch?: boolean;
  /** --version */
  version?: boolean;
}
interface LoadConfigOptions {
  cmd: Command;
  flags: Flags;
  logger: Logger;
}
/** Load config */
declare function loadConfig({
  cmd,
  flags,
  logger
}: LoadConfigOptions): Promise<{
  config: ConfigInit;
  configPath: string;
}>;
/** load tokens */
declare function loadTokens(tokenPaths: URL[], {
  logger
}: {
  logger: Logger;
}): Promise<{
  filename: URL;
  src: string;
}[] | undefined>;
/** Print error */
declare function printError(message: string): void;
/** Print success */
declare function printSuccess(message: string, startTime?: number): void;
/** Resolve config */
declare function resolveConfig(filename?: string): string | undefined;
/** Resolve tokens.json path (for lint command) */
declare function resolveTokenPath(filename: string, {
  logger
}: {
  logger: Logger;
}): url0.URL;
/** Print time elapsed */
declare function time(start: number): string;
//# sourceMappingURL=shared.d.ts.map
//#endregion
//#region src/build.d.ts
interface BuildOptions {
  flags: Flags;
  config: ConfigInit;
  configPath: string;
  logger: Logger;
}
/** tz build */
declare function buildCmd({
  config,
  configPath,
  flags,
  logger
}: BuildOptions): Promise<void>;
/** Write files */
declare function writeFiles(result: BuildRunnerResult, {
  config,
  logger
}: {
  config: ConfigInit;
  logger: Logger;
}): void;
//# sourceMappingURL=build.d.ts.map
//#endregion
//#region src/check.d.ts
interface CheckOptions {
  /** positional CLI args */
  positionals: string[];
  config: ConfigInit;
  logger: Logger;
}
/** tz check */
declare function checkCmd({
  config,
  logger,
  positionals
}: CheckOptions): Promise<void>;
//# sourceMappingURL=check.d.ts.map
//#endregion
//#region src/help.d.ts
/** Show help */
declare function helpCmd(): void;
//# sourceMappingURL=help.d.ts.map
//#endregion
//#region src/init.d.ts
interface InitOptions {
  logger: Logger;
}
declare function initCmd({
  logger
}: InitOptions): Promise<void>;
//# sourceMappingURL=init.d.ts.map
//#endregion
//#region src/lab.d.ts
interface LabBuildOptions {
  flags: Flags;
  config: ConfigInit;
  configPath: string;
  logger: Logger;
}
declare function labCmd({
  config,
  logger
}: LabBuildOptions): Promise<void>;
//# sourceMappingURL=lab.d.ts.map
//#endregion
//#region src/normalize.d.ts
interface NormalizeOptions {
  logger: Logger;
  output: URL;
}
declare function normalizeCmd(filename: string, {
  logger,
  output
}: NormalizeOptions): Promise<void>;
//# sourceMappingURL=normalize.d.ts.map
//#endregion
//#region src/version.d.ts
declare function versionCmd(): void;
//# sourceMappingURL=version.d.ts.map

//#endregion
//#region src/index.d.ts
declare function defineConfig(config: Config): ConfigInit;
//# sourceMappingURL=index.d.ts.map

//#endregion
export { BuildOptions, CheckOptions, Command, DEFAULT_CONFIG_PATH, DEFAULT_TOKENS_PATH, Flags, GREEN_CHECK, InitOptions, LabBuildOptions, LoadConfigOptions, NormalizeOptions, buildCmd, checkCmd, cwd, defineConfig, helpCmd, initCmd, labCmd, loadConfig, loadTokens, normalizeCmd, printError, printSuccess, resolveConfig, resolveTokenPath, time, versionCmd, writeFiles };
//# sourceMappingURL=index.d.ts.map