@codedrifters/configulator 0.0.85 → 0.0.87

package/lib/turbo/turbo-repo.d.ts

@@ -1,375 +0,0 @@
-import { Component, Project, Task } from "projen/lib";
-import { BuildWorkflowOptions } from "projen/lib/build";
-import { NodeProject } from "projen/lib/javascript";
-import { TurboRepoTask } from "./turbo-repo-task";
-/*******************************************************************************
- *
- * Turbo Repo Config
- *
- ******************************************************************************/
-export declare const ROOT_TURBO_TASK_NAME = "turbo:build";
-export declare const ROOT_CI_TASK_NAME = "build:all";
-export interface RemoteCacheOptions {
-    /**
-     * Local profile name to use when fetching the cache endpoint and token.
-     */
-    readonly profileName: string;
-    /**
-     * OIDC role to assume when fetching the cache endpoint and token.
-     */
-    readonly oidcRole: string;
-    /**
-     * Name for the params used to store the cache endpoint.
-     */
-    readonly endpointParamName: string;
-    /**
-     * Name for the params used to store the cache's API token.
-     */
-    readonly tokenParamName: string;
-    /**
-     * team name used in remote cache commands
-     */
-    readonly teamName: string;
-}
-export interface TurboRepoOptions {
-    /**
-     * Version of turborepo to use.
-     *
-     * @default: specified in versions file
-     */
-    readonly turboVersion?: string;
-    /**
-     * Extend from the root turbo.json to create specific configuration for a package using Package Configurations.
-     *
-     * The only valid value for extends is ["//"] to inherit configuration from the root turbo.json.
-     * If extends is used in the root turbo.json, it will be ignored.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#extends
-     */
-    readonly extends?: Array<string>;
-    /**
-     * A list of globs that you want to include in all task hashes. If any file matching these globs changes, all tasks will miss cache. Globs are relative to the location of turbo.json.
-     *
-     * By default, all files in source control in the Workspace root are included in the global hash.
-     *
-     * Globs must be in the repository's source control root. Globs outside of the repository aren't supported.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#globaldependencies
-     */
-    readonly globalDependencies?: Array<string>;
-    /**
-     * A list of environment variables that you want to impact the hash of all tasks. Any change to these environment variables will cause all tasks to miss cache.
-     *
-     * For more on wildcard and negation syntax, see the env section.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#globalenv
-     */
-    readonly globalEnv?: Array<string>;
-    /**
-     * A list of environment variables that you want to make available to tasks.
-     * Using this key opts all tasks into Strict
-     * Environment Variable Mode.
-     *
-     * Additionally, Turborepo has a built-in set of global passthrough variables
-     * for common cases, like operating system environment variables. This
-     * includes variables like HOME, PATH, APPDATA, SHELL, PWD, and more. The full
-     * list can be found in the source code.
-     *
-     * Passthrough values do not contribute to hashes for caching
-     *
-     * If you want changes in these variables to cause cache misses, you will need
-     * to include them in env or globalEnv.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#globalpassthroughenv
-     */
-    readonly globalPassThroughEnv?: Array<string>;
-    /**
-     * @default: "stream"
-     *
-     * Select a terminal UI for the repository.
-     *
-     * "tui" allows for viewing each log at once and interacting with the task.
-     * "stream" outputs logs as they come in and is not interactive.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#ui
-     */
-    readonly ui?: "tui" | "stream";
-    /**
-     * @default: false
-     *
-     * Turborepo uses your repository's lockfile to determine caching behavior,
-     * Package Graphs, and more. Because of this, we use the packageManager field
-     * to help you stabilize your Turborepo.
-     *
-     * To help with incremental migration or in situations where you can't use
-     * the packageManager field, you may use
-     * --dangerously-disable-package-manager-check to opt out of this check and
-     * assume the risks of unstable lockfiles producing unpredictable behavior.
-     * When disabled, Turborepo will attempt a best-effort discovery of the
-     * intended package manager meant for the repository.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#dangerouslydisablepackagemanagercheck
-     */
-    readonly dangerouslyDisablePackageManagerCheck?: boolean;
-    /**
-     * @default: ".turbo/cache"
-     *
-     * Specify the filesystem cache directory.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#cachedir
-     */
-    readonly cacheDir?: string;
-    /**
-     * @default: true
-     *
-     * Turborepo runs a background process to pre-calculate some expensive
-     * operations. This standalone process (daemon) is a performance optimization,
-     * and not required for proper functioning of turbo.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#daemon
-     */
-    readonly daemon?: boolean;
-    /**
-     * @default: "strict"
-     *
-     * Turborepo's Environment Modes allow you to control which environment
-     * variables are available to a task at runtime:
-     *
-     *"strict": Filter environment variables to only those that are specified
-     * in the env and globalEnv keys in turbo.json.
-     *
-     * "loose": Allow all environment variables for the process to be available.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#envmode
-     */
-    readonly envMode?: string;
-    /*****************************************************************************
-     *
-     * Cache Settings
-     *
-     ****************************************************************************/
-    /**
-     * Cache settings, if using remote cache.
-     */
-    readonly remoteCacheOptions?: RemoteCacheOptions;
-    /**
-     * Env Args that will bre added to turbo's build:all task
-     *
-     * @default: {}
-     */
-    readonly buildAllTaskEnvVars?: Record<string, string>;
-    /*****************************************************************************
-     *
-     * Tasks - Optionally define a different projen task for one of the lifecycle
-     * steps.
-     *
-     ****************************************************************************/
-    /**
-     * Pre compile task
-     *
-     * @default: "pre-compile"
-     */
-    readonly preCompileTask?: Task;
-    /**
-     * Compile task
-     *
-     * @default: "compile"
-     */
-    readonly compileTask?: Task;
-    /**
-     * Post compile task
-     *
-     * @default: "post-compile"
-     */
-    readonly postCompileTask?: Task;
-    /**
-     * Test task
-     *
-     * @default: "test"
-     */
-    readonly testTask?: Task;
-    /**
-     * Package task
-     *
-     * @default: "package"
-     */
-    readonly packageTask?: Task;
-}
-export declare class TurboRepo extends Component {
-    readonly project: NodeProject;
-    /**
-     * Static method to discovert turbo in a project.
-     */
-    static of(project: Project): TurboRepo | undefined;
-    static buildWorkflowOptions: (remoteCacheOptions: RemoteCacheOptions) => Partial<BuildWorkflowOptions>;
-    /**
-     * Version of turborepo to use.
-     */
-    readonly turboVersion: string;
-    /**
-     * Extend from the root turbo.json to create specific configuration for a package using Package Configurations.
-     *
-     * The only valid value for extends is ["//"] to inherit configuration from the root turbo.json.
-     * If extends is used in the root turbo.json, it will be ignored.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#extends
-     */
-    readonly extends: Array<string>;
-    /**
-     * A list of globs that you want to include in all task hashes. If any file matching these globs changes, all tasks will miss cache. Globs are relative to the location of turbo.json.
-     *
-     * By default, all files in source control in the Workspace root are included in the global hash.
-     *
-     * Globs must be in the repository's source control root. Globs outside of the repository aren't supported.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#globaldependencies
-     */
-    readonly globalDependencies: Array<string>;
-    /**
-     * A list of environment variables that you want to impact the hash of all tasks. Any change to these environment variables will cause all tasks to miss cache.
-     *
-     * For more on wildcard and negation syntax, see the env section.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#globalenv
-     */
-    readonly globalEnv: Array<string>;
-    /**
-     * A list of environment variables that you want to make available to tasks.
-     * Using this key opts all tasks into Strict
-     * Environment Variable Mode.
-     *
-     * Additionally, Turborepo has a built-in set of global passthrough variables
-     * for common cases, like operating system environment variables. This
-     * includes variables like HOME, PATH, APPDATA, SHELL, PWD, and more. The full
-     * list can be found in the source code.
-     *
-     * Passthrough values do not contribute to hashes for caching
-     *
-     * If you want changes in these variables to cause cache misses, you will need
-     * to include them in env or globalEnv.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#globalpassthroughenv
-     */
-    readonly globalPassThroughEnv: Array<string>;
-    /**
-     * @default: "stream"
-     *
-     * Select a terminal UI for the repository.
-     *
-     * "tui" allows for viewing each log at once and interacting with the task.
-     * "stream" outputs logs as they come in and is not interactive.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#ui
-     */
-    readonly ui: "tui" | "stream";
-    /**
-     * @default: false
-     *
-     * Turborepo uses your repository's lockfile to determine caching behavior,
-     * Package Graphs, and more. Because of this, we use the packageManager field
-     * to help you stabilize your Turborepo.
-     *
-     * To help with incremental migration or in situations where you can't use
-     * the packageManager field, you may use
-     * --dangerously-disable-package-manager-check to opt out of this check and
-     * assume the risks of unstable lockfiles producing unpredictable behavior.
-     * When disabled, Turborepo will attempt a best-effort discovery of the
-     * intended package manager meant for the repository.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#dangerouslydisablepackagemanagercheck
-     */
-    readonly dangerouslyDisablePackageManagerCheck: boolean;
-    /**
-     * @default: ".turbo/cache"
-     *
-     * Specify the filesystem cache directory.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#cachedir
-     */
-    readonly cacheDir: string;
-    /**
-     * @default: true
-     *
-     * Turborepo runs a background process to pre-calculate some expensive
-     * operations. This standalone process (daemon) is a performance optimization,
-     * and not required for proper functioning of turbo.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#daemon
-     */
-    readonly daemon: boolean;
-    /**
-     * @default: "strict"
-     *
-     * Turborepo's Environment Modes allow you to control which environment
-     * variables are available to a task at runtime:
-     *
-     *"strict": Filter environment variables to only those that are specified
-     * in the env and globalEnv keys in turbo.json.
-     *
-     * "loose": Allow all environment variables for the process to be available.
-     *
-     * https://turbo.build/repo/docs/reference/configuration#envmode
-     */
-    readonly envMode: string;
-    /*****************************************************************************
-     *
-     * Cache Settings
-     *
-     ****************************************************************************/
-    /**
-     * Cache settings, if using remote cache.
-     */
-    readonly remoteCacheOptions?: RemoteCacheOptions;
-    /**
-     * is this the root project?
-     */
-    readonly isRootProject: boolean;
-    /**
-     * Turbo's build:all task at the root of the monorepo.
-     *
-     * This is a normal projen task that runs the root turbo task.
-     */
-    readonly buildAllTask?: Task;
-    /**
-     * Main turbo:build task
-     *
-     * This is a special Turbo task
-     */
-    readonly buildTask: TurboRepoTask;
-    /**
-     * pre compile task
-     */
-    readonly preCompileTask?: TurboRepoTask;
-    /**
-     * compile task
-     */
-    readonly compileTask?: TurboRepoTask;
-    /**
-     * post compile task
-     */
-    readonly postCompileTask?: TurboRepoTask;
-    /**
-     * Test task
-     */
-    readonly testTask?: TurboRepoTask;
-    /**
-     * Package task
-     */
-    readonly packageTask?: TurboRepoTask;
-    /**
-     * Sub-Tasks to run
-     */
-    readonly tasks: Array<TurboRepoTask>;
-    /**
-     * Env Args that will bre added to turbo's build:all task
-     */
-    readonly buildAllTaskEnvVars: Record<string, string>;
-    constructor(project: NodeProject, options?: TurboRepoOptions);
-    /**
-     * Add an env var to the global env vars for all tasks.
-     * This will also become an input for the build:all task cache at the root.
-     */
-    addGlobalEnvVar(name: string, value: string): void;
-    activateBranchNameEnvVar(): void;
-    preSynthesize(): void;
-}