@moonrepo/types 1.33.2 → 2.0.0

package/src/tasks-config.ts

@@ -3,6 +3,7 @@
 /* eslint-disable */
 
 import type { ExtendsFrom, Id } from './common';
+import type { LanguageType, LayerType, StackType } from './project-config';
 
 /** The task-to-task relationship of the dependency. */
 export type TaskDependencyType = 'cleanup' | 'required' | 'optional';
@@ -81,15 +82,16 @@ export interface ProjectInput {
 
 export type Input = string | FileInput | FileGroupInput | GlobInput | ProjectInput;
 
-export type TaskArgs = null | string | string[];
-
 /** Expanded information about a task dependency. */
 export interface TaskDependencyConfig {
 	/** Additional arguments to pass to this dependency when it's ran. */
-	args: TaskArgs;
-	/** A mapping of environment variables specific to this dependency. */
-	env: Record<string, string>;
-	/** Marks the dependency is optional when being inherited from the top-level. */
+	args: string[];
+	/** A map of environment variables specific to this dependency. */
+	env: Record<string, string | null>;
+	/**
+	 * Marks the dependency as optional when being inherited from the top-level.
+	 * @since 1.20.0
+	 */
 	optional: boolean | null;
 	/** The target of the depended on task. */
 	target: string;
@@ -97,6 +99,95 @@ export interface TaskDependencyConfig {
 
 export type TaskDependency = string | TaskDependencyConfig;
 
+/**
+ * A condition that utilizes a combination of logical operators
+ * to match against. When matching, all clauses must be satisfied.
+ */
+export interface InheritedClauseConfig {
+	/** Require all values to match, using an AND operator. */
+	and: Id | Id[] | null;
+	/** Require no values to match, using a NOT operator. */
+	not: Id | Id[] | null;
+	/** Require any values to match, using an OR operator. */
+	or: Id | Id[] | null;
+}
+
+export type InheritedConditionConfig = Id | Id[] | InheritedClauseConfig;
+
+/**
+ * Configures conditions that must match against a project for tasks
+ * to be inherited. If multiple conditions are defined, then all must match
+ * for inheritance to occur. If no conditions are defined, then tasks will
+ * be inherited by all projects.
+ */
+export interface InheritedByConfig {
+	/**
+	 * Condition that matches against literal files within a project.
+	 * If multiple values are provided, at least 1 file needs to exist.
+	 */
+	file?: string | string[] | null;
+	/**
+	 * Condition that matches against literal files within a project.
+	 * If multiple values are provided, at least 1 file needs to exist.
+	 */
+	files: string | string[] | null;
+	/**
+	 * Condition that matches against a project's `language`.
+	 * If multiple values are provided, it matches using an OR operator.
+	 *
+	 * @default 'unknown'
+	 */
+	language?: LanguageType | LanguageType[] | null;
+	/**
+	 * Condition that matches against a project's `language`.
+	 * If multiple values are provided, it matches using an OR operator.
+	 *
+	 * @default 'unknown'
+	 */
+	languages: LanguageType | LanguageType[] | null;
+	/**
+	 * Condition that matches against a project's `layer`.
+	 * If multiple values are provided, it matches using an OR operator.
+	 *
+	 * @default 'unknown'
+	 */
+	layer?: LayerType | LayerType[] | null;
+	/**
+	 * Condition that matches against a project's `layer`.
+	 * If multiple values are provided, it matches using an OR operator.
+	 *
+	 * @default 'unknown'
+	 */
+	layers: LayerType | LayerType[] | null;
+	/**
+	 * The order in which this configuration is inherited by a project.
+	 * Lower is inherited first, while higher is last.
+	 */
+	order: number | null;
+	/**
+	 * Condition that matches against a project's `stack`.
+	 * If multiple values are provided, it matches using an OR operator.
+	 *
+	 * @default 'unknown'
+	 */
+	stack?: StackType | StackType[] | null;
+	/**
+	 * Condition that matches against a project's `stack`.
+	 * If multiple values are provided, it matches using an OR operator.
+	 *
+	 * @default 'unknown'
+	 */
+	stacks: StackType | StackType[] | null;
+	/** Condition that matches against a tag within the project. */
+	tag?: InheritedConditionConfig | null;
+	/** Condition that matches against a tag within the project. */
+	tags: InheritedConditionConfig | null;
+	/** Condition that matches against a toolchain detected for a project. */
+	toolchain?: InheritedConditionConfig | null;
+	/** Condition that matches against a toolchain detected for a project. */
+	toolchains: InheritedConditionConfig | null;
+}
+
 export type TaskOptionEnvFile = boolean | string | string[];
 
 /** The strategy in which to merge a specific task option. */
@@ -108,7 +199,10 @@ export type TaskOperatingSystem = 'linux' | 'macos' | 'windows';
 /** The style in which task output will be printed to the console. */
 export type TaskOutputStyle = 'buffer' | 'buffer-only-failure' | 'hash' | 'none' | 'stream';
 
-/** The priority levels a task can be bucketed into. */
+/**
+ * The priority levels a task can be bucketed into when running
+ * in the action pipeline.
+ */
 export type TaskPriority = 'critical' | 'high' | 'normal' | 'low';
 
 /** A list of available shells on Unix. */
@@ -126,20 +220,23 @@ export type TaskUnixShell =
 /** A list of available shells on Windows. */
 export type TaskWindowsShell = 'bash' | 'elvish' | 'fish' | 'murex' | 'nu' | 'pwsh' | 'xonsh';
 
-/** Options to control task inheritance and execution. */
+/** Options to control task inheritance, execution, and more. */
 export interface TaskOptionsConfig {
 	/** The pattern in which affected files will be passed to the task. */
 	affectedFiles: boolean | 'args' | 'env' | null;
 	/**
-	 * When affected and no files are matching, pass the task inputs
+	 * When affected and no files are matching, pass the task's inputs
 	 * as arguments to the command, instead of `.`.
 	 */
 	affectedPassInputs: boolean | null;
-	/** Allows the task to fail without failing the entire pipeline. */
+	/**
+	 * Allow the task to fail without failing the entire action pipeline.
+	 * @since 1.13.0
+	 */
 	allowFailure: boolean | null;
 	/**
-	 * Caches the `outputs` of the task. Defaults to `true` if outputs
-	 * are configured for the task.
+	 * Cache the `outputs` of the task for incremental builds.
+	 * Defaults to `true` if outputs are configured for the task.
 	 */
 	cache: boolean | 'local' | 'remote' | null;
 	/**
@@ -150,26 +247,30 @@ export interface TaskOptionsConfig {
 	/**
 	 * Lifetime to cache the task itself, in the format of "1h", "30m", etc.
 	 * If not defined, caches live forever, or until inputs change.
+	 * @since 1.29.0
 	 */
 	cacheLifetime: string | null;
 	/**
-	 * Loads and sets environment variables from the `.env` file when
+	 * Loads and sets environment variables from the `.env` file(s) when
 	 * running the task.
 	 */
 	envFile: TaskOptionEnvFile | null;
 	/**
 	 * Automatically infer inputs from file groups or environment variables
 	 * that were utilized within `command`, `script`, `args`, and `env`.
+	 * @since 1.31.0
 	 */
 	inferInputs: boolean | null;
 	/**
 	 * Marks the task as interactive, so that it will run in isolation,
 	 * and have direct access to stdin.
+	 * @since 1.12.0
 	 */
 	interactive: boolean | null;
 	/**
-	 * Marks the task as internal, which disables it from begin ran
-	 * from the command line, but can be depended on.
+	 * Marks the task as internal, which disables it from being ran
+	 * from the command line, but can still be depended on by other tasks.
+	 * @since 1.23.0
 	 */
 	internal: boolean | null;
 	/**
@@ -210,9 +311,17 @@ export interface TaskOptionsConfig {
 	 * @default 'append'
 	 */
 	mergeOutputs: TaskMergeStrategy | null;
+	/**
+	 * The strategy to use when merging `toolchains` with an inherited task.
+	 * @since 2.0.0
+	 *
+	 * @default 'append'
+	 */
+	mergeToolchains: TaskMergeStrategy | null;
 	/**
 	 * Creates an exclusive lock on a virtual resource, preventing other
 	 * tasks using the same resource from running concurrently.
+	 * @since 1.24.0
 	 */
 	mutex: string | null;
 	/** The operating system in which to only run this task on. */
@@ -221,17 +330,18 @@ export interface TaskOptionsConfig {
 	 * The style in which task output will be printed to the console.
 	 *
 	 * @default 'buffer'
-	 * @envvar MOON_OUTPUT_STYLE
+	 * @env MOON_OUTPUT_STYLE
 	 */
 	outputStyle: TaskOutputStyle | null;
 	/**
 	 * Marks the task as persistent (continuously running). This is ideal
 	 * for watchers, servers, or never-ending processes.
+	 * @since 1.6.0
 	 */
 	persistent: boolean | null;
 	/**
 	 * Marks the task with a certain priority, which determines the order
-	 * in which it is ran within the pipeline.
+	 * in which it is ran within the action pipeline.
 	 *
 	 * @default 'normal'
 	 */
@@ -239,7 +349,7 @@ export interface TaskOptionsConfig {
 	/**
 	 * The number of times a failing task will be retried to succeed.
 	 *
-	 * @envvar MOON_RETRY_COUNT
+	 * @env MOON_RETRY_COUNT
 	 */
 	retryCount: number | null;
 	/**
@@ -249,29 +359,36 @@ export interface TaskOptionsConfig {
 	runDepsInParallel: boolean | null;
 	/** Runs the task from the workspace root, instead of the project root. */
 	runFromWorkspaceRoot: boolean | null;
-	/** Whether to run the task in CI or not, when executing `moon ci` or `moon run`. */
+	/**
+	 * Whether to run the task in CI or not, when executing `moon ci`,
+	 * `moon check`, or `moon run`.
+	 */
 	runInCI: boolean | 'always' | 'affected' | 'only' | 'skip' | null;
 	/**
 	 * Runs the task within a shell. When not defined, runs the task
-	 * directly while relying on `PATH` resolution.
+	 * directly while relying on native `PATH` resolution.
 	 */
 	shell: boolean | null;
 	/** The maximum time in seconds that a task can run before being cancelled. */
 	timeout: number | null;
 	/**
 	 * The shell to run the task in when on a Unix-based machine.
+	 * @since 1.21.0
 	 *
 	 * @default 'bash'
 	 */
 	unixShell: TaskUnixShell | null;
 	/**
 	 * The shell to run the task in when on a Windows machine.
+	 * @since 1.21.0
 	 *
 	 * @default 'pwsh'
 	 */
 	windowsShell: TaskWindowsShell | null;
 }
 
+export type TaskArgs = null | string | string[];
+
 /** A file path output. */
 export interface FileOutput {
 	/** The literal file path. */
@@ -296,11 +413,8 @@ export interface GlobOutput {
 
 export type Output = string | FileOutput | GlobOutput;
 
-/** Platforms that each programming language can belong to. */
-export type PlatformType = 'bun' | 'deno' | 'node' | 'python' | 'rust' | 'system' | 'unknown';
-
 /** Preset options to inherit. */
-export type TaskPreset = 'server' | 'watcher';
+export type TaskPreset = 'utility' | 'server';
 
 /** The type of task. */
 export type TaskType = 'build' | 'run' | 'test';
@@ -313,79 +427,75 @@ export interface TaskConfig {
 	 */
 	args: TaskArgs;
 	/**
-	 * The command or command line to execute when the task is ran.
-	 * Supports the command name, with or without arguments. Can be
-	 * defined as a string, or a list of individual arguments.
+	 * The command line to execute when the task is ran.
+	 * Supports the command (executable) with or without arguments.
+	 * Can be defined as a string, or a list of individual arguments.
 	 */
 	command: TaskArgs;
+	/**
+	 * Other tasks that this task depends on, and must run to completion
+	 * before this task is ran. Can depend on sibling tasks, or tasks in
+	 * other projects, using targets.
+	 */
+	dependsOn?: TaskDependency[] | null;
 	/**
 	 * Other tasks that this task depends on, and must run to completion
 	 * before this task is ran. Can depend on sibling tasks, or tasks in
 	 * other projects, using targets.
 	 */
 	deps: TaskDependency[] | null;
-	/** A human-readable description about the task. */
-	description: string | null;
 	/**
-	 * A mapping of environment variables that will be set when the
-	 * task is ran.
+	 * A human-readable description about the task.
+	 * @since 1.22.0
 	 */
-	env: Record<string, string> | null;
-	/** Extends settings from a sibling task by ID. */
-	extends: Id | null;
+	description: string | null;
 	/**
-	 * Inputs and sources that will mark the task as affected when comparing
-	 * against touched files. When not provided, all files within the project
-	 * are considered an input. When an empty list, no files are considered.
-	 * Otherwise, an explicit list of inputs are considered.
+	 * A map of environment variables that will be set in the child
+	 * process when the task is ran.
 	 */
-	inputs: Input[] | null;
+	env: Record<string, string | null> | null;
+	/** Extends settings from a sibling task by identifier. */
+	extends: Id | null;
 	/**
-	 * Marks the task as local only. Local tasks do not run in CI, do not have
-	 * `options.cache` enabled, and are marked as `options.persistent`.
+	 * A list of inputs that will be hashing and compared against changed files
+	 * to determine affected status. If affected, the task will run, otherwise
+	 * it will exit early. An input can be a literal file path, a glob pattern,
+	 * environment variable, and more.
 	 *
-	 * @deprecated Use `preset` instead.
+	 * When not provided, all files within the project are considered inputs.
+	 * When an empty list, no files are considered. Otherwise, an
+	 * explicit list of inputs are considered.
 	 */
-	local: boolean | null;
-	/** Options to control task inheritance and execution. */
+	inputs: Input[] | null;
+	/** Options to control task inheritance, execution, and more. */
 	options: TaskOptionsConfig;
 	/**
-	 * Outputs that will be created when the task has successfully ran.
-	 * When `cache` is enabled, the outputs will be persisted for subsequent runs.
+	 * A list of outputs that will be created when the task has successfully ran.
+	 * An output can be a literal file path, or a glob pattern.
 	 */
 	outputs: Output[] | null;
-	/**
-	 * The platform in which the task will be ran in. The platform determines
-	 * available binaries, lookup paths, and more. When not provided, will
-	 * be automatically detected.
-	 *
-	 * @default 'unknown'
-	 * @type {'bun' | 'deno' | 'node' | 'python' | 'rust' | 'system' | 'unknown'}
-	 */
-	platform: PlatformType;
 	/** The preset to apply for the task. Will inherit default options. */
 	preset: TaskPreset | null;
 	/**
 	 * A script to run within a shell. A script is anything from a single command,
-	 * to multiple commands (&&, etc), or shell specific syntax. Does not support
-	 * arguments, merging, or inheritance.
+	 * to multiple commands, or shell specific syntax. Does not support
+	 * arguments, merging, or inheritance. This overrides `command` and `args`.
+	 * @since 1.27.0
 	 */
 	script: string | null;
 	/**
-	 * List of additional toolchain(s) in which the task will be ran in.
-	 * The toolchain determines available binaries, lookup paths, and more.
-	 * This list will be merged with detected toolchains.
+	 * A toolchain, or list of toolchains, in which the task will inherit
+	 * functionality from.
 	 */
-	toolchains?: Id | Id[];
+	toolchain?: Id | Id[] | null;
 	/**
-	 * List of additional toolchain(s) in which the task will be ran in.
-	 * The toolchain determines available binaries, lookup paths, and more.
-	 * This list will be merged with detected toolchains.
+	 * A toolchain, or list of toolchains, in which the task will inherit
+	 * functionality from.
 	 */
-	toolchain: Id | Id[];
+	toolchains: Id | Id[] | null;
 	/**
 	 * The type of task, primarily used for categorical reasons. When not provided,
-	 * will be automatically determined.
+	 * will be automatically determined based on configured outputs.
 	 *
 	 * @default 'test'
 	 */
@@ -398,43 +508,57 @@ export interface TaskConfig {
  * Docs: https://moonrepo.dev/docs/config/tasks
  */
 export interface InheritedTasksConfig {
-	/** @default 'https://moonrepo.dev/schemas/tasks.json' */
+	/** @default '../cache/schemas/tasks.json' */
 	$schema?: string;
 	/**
-	 * Extends one or many task configuration files. Supports a relative
-	 * file path or a secure URL.
+	 * Extends one or many tasks configuration files.
+	 * Supports a relative file path or a secure URL.
+	 * @since 1.12.0
 	 */
 	extends: ExtendsFrom | null;
 	/**
-	 * A mapping of group IDs to a list of file paths, globs, and
+	 * A map of group identifiers to a list of file paths, globs, and
 	 * environment variables, that can be referenced from tasks.
 	 */
 	fileGroups: Record<Id, Input[]>;
 	/**
-	 * Task dependencies that'll automatically be injected into every
+	 * Task dependencies (`deps`) that will be automatically injected into every
 	 * task that inherits this configuration.
 	 */
 	implicitDeps: TaskDependency[];
 	/**
-	 * Task inputs that'll automatically be injected into every
+	 * Task inputs (`inputs`) that will be automatically injected into every
 	 * task that inherits this configuration.
 	 */
 	implicitInputs: Input[];
-	/** Default task options for all inherited tasks. */
+	/**
+	 * A map of conditions that define which projects will inherit these
+	 * tasks and configuration. If not defined, will be inherited by all projects.
+	 * @since 2.0.0
+	 */
+	inheritedBy: InheritedByConfig | null;
+	/**
+	 * Default task options for all inherited tasks.
+	 * @since 1.20.0
+	 */
 	taskOptions: TaskOptionsConfig | null;
-	/** A mapping of tasks by ID to parameters required for running the task. */
+	/**
+	 * A map of identifiers to task objects. Tasks represent the work-unit
+	 * of a project, and can be ran in the action pipeline.
+	 */
 	tasks: Record<Id, TaskConfig>;
 }
 
-export type PartialTaskArgs = null | string | string[];
-
 /** Expanded information about a task dependency. */
 export interface PartialTaskDependencyConfig {
 	/** Additional arguments to pass to this dependency when it's ran. */
-	args?: PartialTaskArgs | null;
-	/** A mapping of environment variables specific to this dependency. */
-	env?: Record<string, string> | null;
-	/** Marks the dependency is optional when being inherited from the top-level. */
+	args?: string[] | null;
+	/** A map of environment variables specific to this dependency. */
+	env?: Record<string, string | null> | null;
+	/**
+	 * Marks the dependency as optional when being inherited from the top-level.
+	 * @since 1.20.0
+	 */
 	optional?: boolean | null;
 	/** The target of the depended on task. */
 	target?: string | null;
@@ -442,20 +566,112 @@ export interface PartialTaskDependencyConfig {
 
 export type PartialTaskDependency = string | PartialTaskDependencyConfig;
 
-/** Options to control task inheritance and execution. */
+/**
+ * A condition that utilizes a combination of logical operators
+ * to match against. When matching, all clauses must be satisfied.
+ */
+export interface PartialInheritedClauseConfig {
+	/** Require all values to match, using an AND operator. */
+	and?: Id | Id[] | null;
+	/** Require no values to match, using a NOT operator. */
+	not?: Id | Id[] | null;
+	/** Require any values to match, using an OR operator. */
+	or?: Id | Id[] | null;
+}
+
+export type PartialInheritedConditionConfig = Id | Id[] | PartialInheritedClauseConfig;
+
+/**
+ * Configures conditions that must match against a project for tasks
+ * to be inherited. If multiple conditions are defined, then all must match
+ * for inheritance to occur. If no conditions are defined, then tasks will
+ * be inherited by all projects.
+ */
+export interface PartialInheritedByConfig {
+	/**
+	 * Condition that matches against literal files within a project.
+	 * If multiple values are provided, at least 1 file needs to exist.
+	 */
+	file?: string | string[] | null;
+	/**
+	 * Condition that matches against literal files within a project.
+	 * If multiple values are provided, at least 1 file needs to exist.
+	 */
+	files?: string | string[] | null;
+	/**
+	 * Condition that matches against a project's `language`.
+	 * If multiple values are provided, it matches using an OR operator.
+	 *
+	 * @default 'unknown'
+	 */
+	language?: LanguageType | LanguageType[] | null;
+	/**
+	 * Condition that matches against a project's `language`.
+	 * If multiple values are provided, it matches using an OR operator.
+	 *
+	 * @default 'unknown'
+	 */
+	languages?: LanguageType | LanguageType[] | null;
+	/**
+	 * Condition that matches against a project's `layer`.
+	 * If multiple values are provided, it matches using an OR operator.
+	 *
+	 * @default 'unknown'
+	 */
+	layer?: LayerType | LayerType[] | null;
+	/**
+	 * Condition that matches against a project's `layer`.
+	 * If multiple values are provided, it matches using an OR operator.
+	 *
+	 * @default 'unknown'
+	 */
+	layers?: LayerType | LayerType[] | null;
+	/**
+	 * The order in which this configuration is inherited by a project.
+	 * Lower is inherited first, while higher is last.
+	 */
+	order?: number | null;
+	/**
+	 * Condition that matches against a project's `stack`.
+	 * If multiple values are provided, it matches using an OR operator.
+	 *
+	 * @default 'unknown'
+	 */
+	stack?: StackType | StackType[] | null;
+	/**
+	 * Condition that matches against a project's `stack`.
+	 * If multiple values are provided, it matches using an OR operator.
+	 *
+	 * @default 'unknown'
+	 */
+	stacks?: StackType | StackType[] | null;
+	/** Condition that matches against a tag within the project. */
+	tag?: PartialInheritedConditionConfig | null;
+	/** Condition that matches against a tag within the project. */
+	tags?: PartialInheritedConditionConfig | null;
+	/** Condition that matches against a toolchain detected for a project. */
+	toolchain?: PartialInheritedConditionConfig | null;
+	/** Condition that matches against a toolchain detected for a project. */
+	toolchains?: PartialInheritedConditionConfig | null;
+}
+
+/** Options to control task inheritance, execution, and more. */
 export interface PartialTaskOptionsConfig {
 	/** The pattern in which affected files will be passed to the task. */
 	affectedFiles?: boolean | 'args' | 'env' | null;
 	/**
-	 * When affected and no files are matching, pass the task inputs
+	 * When affected and no files are matching, pass the task's inputs
 	 * as arguments to the command, instead of `.`.
 	 */
 	affectedPassInputs?: boolean | null;
-	/** Allows the task to fail without failing the entire pipeline. */
+	/**
+	 * Allow the task to fail without failing the entire action pipeline.
+	 * @since 1.13.0
+	 */
 	allowFailure?: boolean | null;
 	/**
-	 * Caches the `outputs` of the task. Defaults to `true` if outputs
-	 * are configured for the task.
+	 * Cache the `outputs` of the task for incremental builds.
+	 * Defaults to `true` if outputs are configured for the task.
 	 */
 	cache?: boolean | 'local' | 'remote' | null;
 	/**
@@ -466,26 +682,30 @@ export interface PartialTaskOptionsConfig {
 	/**
 	 * Lifetime to cache the task itself, in the format of "1h", "30m", etc.
 	 * If not defined, caches live forever, or until inputs change.
+	 * @since 1.29.0
 	 */
 	cacheLifetime?: string | null;
 	/**
-	 * Loads and sets environment variables from the `.env` file when
+	 * Loads and sets environment variables from the `.env` file(s) when
 	 * running the task.
 	 */
 	envFile?: TaskOptionEnvFile | null;
 	/**
 	 * Automatically infer inputs from file groups or environment variables
 	 * that were utilized within `command`, `script`, `args`, and `env`.
+	 * @since 1.31.0
 	 */
 	inferInputs?: boolean | null;
 	/**
 	 * Marks the task as interactive, so that it will run in isolation,
 	 * and have direct access to stdin.
+	 * @since 1.12.0
 	 */
 	interactive?: boolean | null;
 	/**
-	 * Marks the task as internal, which disables it from begin ran
-	 * from the command line, but can be depended on.
+	 * Marks the task as internal, which disables it from being ran
+	 * from the command line, but can still be depended on by other tasks.
+	 * @since 1.23.0
 	 */
 	internal?: boolean | null;
 	/**
@@ -526,9 +746,17 @@ export interface PartialTaskOptionsConfig {
 	 * @default 'append'
 	 */
 	mergeOutputs?: TaskMergeStrategy | null;
+	/**
+	 * The strategy to use when merging `toolchains` with an inherited task.
+	 * @since 2.0.0
+	 *
+	 * @default 'append'
+	 */
+	mergeToolchains?: TaskMergeStrategy | null;
 	/**
 	 * Creates an exclusive lock on a virtual resource, preventing other
 	 * tasks using the same resource from running concurrently.
+	 * @since 1.24.0
 	 */
 	mutex?: string | null;
 	/** The operating system in which to only run this task on. */
@@ -537,17 +765,18 @@ export interface PartialTaskOptionsConfig {
 	 * The style in which task output will be printed to the console.
 	 *
 	 * @default 'buffer'
-	 * @envvar MOON_OUTPUT_STYLE
+	 * @env MOON_OUTPUT_STYLE
 	 */
 	outputStyle?: TaskOutputStyle | null;
 	/**
 	 * Marks the task as persistent (continuously running). This is ideal
 	 * for watchers, servers, or never-ending processes.
+	 * @since 1.6.0
 	 */
 	persistent?: boolean | null;
 	/**
 	 * Marks the task with a certain priority, which determines the order
-	 * in which it is ran within the pipeline.
+	 * in which it is ran within the action pipeline.
 	 *
 	 * @default 'normal'
 	 */
@@ -555,7 +784,7 @@ export interface PartialTaskOptionsConfig {
 	/**
 	 * The number of times a failing task will be retried to succeed.
 	 *
-	 * @envvar MOON_RETRY_COUNT
+	 * @env MOON_RETRY_COUNT
 	 */
 	retryCount?: number | null;
 	/**
@@ -565,29 +794,36 @@ export interface PartialTaskOptionsConfig {
 	runDepsInParallel?: boolean | null;
 	/** Runs the task from the workspace root, instead of the project root. */
 	runFromWorkspaceRoot?: boolean | null;
-	/** Whether to run the task in CI or not, when executing `moon ci` or `moon run`. */
+	/**
+	 * Whether to run the task in CI or not, when executing `moon ci`,
+	 * `moon check`, or `moon run`.
+	 */
 	runInCI?: boolean | 'always' | 'affected' | 'only' | 'skip' | null;
 	/**
 	 * Runs the task within a shell. When not defined, runs the task
-	 * directly while relying on `PATH` resolution.
+	 * directly while relying on native `PATH` resolution.
 	 */
 	shell?: boolean | null;
 	/** The maximum time in seconds that a task can run before being cancelled. */
 	timeout?: number | null;
 	/**
 	 * The shell to run the task in when on a Unix-based machine.
+	 * @since 1.21.0
 	 *
 	 * @default 'bash'
 	 */
 	unixShell?: TaskUnixShell | null;
 	/**
 	 * The shell to run the task in when on a Windows machine.
+	 * @since 1.21.0
 	 *
 	 * @default 'pwsh'
 	 */
 	windowsShell?: TaskWindowsShell | null;
 }
 
+export type PartialTaskArgs = null | string | string[];
+
 /** Configures a task to be ran within the action pipeline. */
 export interface PartialTaskConfig {
 	/**
@@ -596,78 +832,75 @@ export interface PartialTaskConfig {
 	 */
 	args?: PartialTaskArgs | null;
 	/**
-	 * The command or command line to execute when the task is ran.
-	 * Supports the command name, with or without arguments. Can be
-	 * defined as a string, or a list of individual arguments.
+	 * The command line to execute when the task is ran.
+	 * Supports the command (executable) with or without arguments.
+	 * Can be defined as a string, or a list of individual arguments.
 	 */
 	command?: PartialTaskArgs | null;
+	/**
+	 * Other tasks that this task depends on, and must run to completion
+	 * before this task is ran. Can depend on sibling tasks, or tasks in
+	 * other projects, using targets.
+	 */
+	dependsOn?: PartialTaskDependency[] | null;
 	/**
 	 * Other tasks that this task depends on, and must run to completion
 	 * before this task is ran. Can depend on sibling tasks, or tasks in
 	 * other projects, using targets.
 	 */
 	deps?: PartialTaskDependency[] | null;
-	/** A human-readable description about the task. */
-	description?: string | null;
 	/**
-	 * A mapping of environment variables that will be set when the
-	 * task is ran.
+	 * A human-readable description about the task.
+	 * @since 1.22.0
 	 */
-	env?: Record<string, string> | null;
-	/** Extends settings from a sibling task by ID. */
-	extends?: Id | null;
+	description?: string | null;
 	/**
-	 * Inputs and sources that will mark the task as affected when comparing
-	 * against touched files. When not provided, all files within the project
-	 * are considered an input. When an empty list, no files are considered.
-	 * Otherwise, an explicit list of inputs are considered.
+	 * A map of environment variables that will be set in the child
+	 * process when the task is ran.
 	 */
-	inputs?: Input[] | null;
+	env?: Record<string, string | null> | null;
+	/** Extends settings from a sibling task by identifier. */
+	extends?: Id | null;
 	/**
-	 * Marks the task as local only. Local tasks do not run in CI, do not have
-	 * `options.cache` enabled, and are marked as `options.persistent`.
+	 * A list of inputs that will be hashing and compared against changed files
+	 * to determine affected status. If affected, the task will run, otherwise
+	 * it will exit early. An input can be a literal file path, a glob pattern,
+	 * environment variable, and more.
 	 *
-	 * @deprecated Use `preset` instead.
+	 * When not provided, all files within the project are considered inputs.
+	 * When an empty list, no files are considered. Otherwise, an
+	 * explicit list of inputs are considered.
 	 */
-	local?: boolean | null;
-	/** Options to control task inheritance and execution. */
+	inputs?: Input[] | null;
+	/** Options to control task inheritance, execution, and more. */
 	options?: PartialTaskOptionsConfig | null;
 	/**
-	 * Outputs that will be created when the task has successfully ran.
-	 * When `cache` is enabled, the outputs will be persisted for subsequent runs.
+	 * A list of outputs that will be created when the task has successfully ran.
+	 * An output can be a literal file path, or a glob pattern.
 	 */
 	outputs?: Output[] | null;
-	/**
-	 * The platform in which the task will be ran in. The platform determines
-	 * available binaries, lookup paths, and more. When not provided, will
-	 * be automatically detected.
-	 *
-	 * @default 'unknown'
-	 */
-	platform?: PlatformType | null;
 	/** The preset to apply for the task. Will inherit default options. */
 	preset?: TaskPreset | null;
 	/**
 	 * A script to run within a shell. A script is anything from a single command,
-	 * to multiple commands (&&, etc), or shell specific syntax. Does not support
-	 * arguments, merging, or inheritance.
+	 * to multiple commands, or shell specific syntax. Does not support
+	 * arguments, merging, or inheritance. This overrides `command` and `args`.
+	 * @since 1.27.0
 	 */
 	script?: string | null;
 	/**
-	 * List of additional toolchain(s) in which the task will be ran in.
-	 * The toolchain determines available binaries, lookup paths, and more.
-	 * This list will be merged with detected toolchains.
+	 * A toolchain, or list of toolchains, in which the task will inherit
+	 * functionality from.
 	 */
-	toolchains?: Id | Id[] | null;
+	toolchain?: Id | Id[] | null;
 	/**
-	 * List of additional toolchain(s) in which the task will be ran in.
-	 * The toolchain determines available binaries, lookup paths, and more.
-	 * This list will be merged with detected toolchains.
+	 * A toolchain, or list of toolchains, in which the task will inherit
+	 * functionality from.
 	 */
-	toolchain?: Id | Id[] | null;
+	toolchains?: Id | Id[] | null;
 	/**
 	 * The type of task, primarily used for categorical reasons. When not provided,
-	 * will be automatically determined.
+	 * will be automatically determined based on configured outputs.
 	 *
 	 * @default 'test'
 	 */
@@ -680,30 +913,43 @@ export interface PartialTaskConfig {
  * Docs: https://moonrepo.dev/docs/config/tasks
  */
 export interface PartialInheritedTasksConfig {
-	/** @default 'https://moonrepo.dev/schemas/tasks.json' */
+	/** @default '../cache/schemas/tasks.json' */
 	$schema?: string | null;
 	/**
-	 * Extends one or many task configuration files. Supports a relative
-	 * file path or a secure URL.
+	 * Extends one or many tasks configuration files.
+	 * Supports a relative file path or a secure URL.
+	 * @since 1.12.0
 	 */
 	extends?: ExtendsFrom | null;
 	/**
-	 * A mapping of group IDs to a list of file paths, globs, and
+	 * A map of group identifiers to a list of file paths, globs, and
 	 * environment variables, that can be referenced from tasks.
 	 */
 	fileGroups?: Record<Id, Input[]> | null;
 	/**
-	 * Task dependencies that'll automatically be injected into every
+	 * Task dependencies (`deps`) that will be automatically injected into every
 	 * task that inherits this configuration.
 	 */
 	implicitDeps?: PartialTaskDependency[] | null;
 	/**
-	 * Task inputs that'll automatically be injected into every
+	 * Task inputs (`inputs`) that will be automatically injected into every
 	 * task that inherits this configuration.
 	 */
 	implicitInputs?: Input[] | null;
-	/** Default task options for all inherited tasks. */
+	/**
+	 * A map of conditions that define which projects will inherit these
+	 * tasks and configuration. If not defined, will be inherited by all projects.
+	 * @since 2.0.0
+	 */
+	inheritedBy?: PartialInheritedByConfig | null;
+	/**
+	 * Default task options for all inherited tasks.
+	 * @since 1.20.0
+	 */
 	taskOptions?: PartialTaskOptionsConfig | null;
-	/** A mapping of tasks by ID to parameters required for running the task. */
+	/**
+	 * A map of identifiers to task objects. Tasks represent the work-unit
+	 * of a project, and can be ran in the action pipeline.
+	 */
 	tasks?: Record<Id, PartialTaskConfig> | null;
 }