@moonrepo/types 1.33.2 → 2.0.0

package/src/project-config.ts

@@ -3,14 +3,16 @@
 /* eslint-disable */
 
 import type { Id } from './common';
-import type { Input, PartialTaskConfig, PlatformType, TaskConfig } from './tasks-config';
+import type { Input, PartialTaskConfig, TaskConfig } from './tasks-config';
+import type { PartialToolchainPluginConfig, ToolchainPluginConfig } from './toolchains-config';
 import type {
-	PartialToolchainPluginConfig,
-	ToolchainPluginConfig,
-	UnresolvedVersionSpec,
-} from './toolchain-config';
+	DockerFileConfig,
+	DockerScaffoldConfig,
+	PartialDockerFileConfig,
+	PartialDockerScaffoldConfig,
+} from './workspace-config';
 
-/** The scope and or relationship of the dependency. */
+/** The relationship scope of a dependency. */
 export type DependencyScope = 'build' | 'development' | 'peer' | 'production' | 'root';
 
 /**
@@ -21,7 +23,7 @@ export type DependencySource = 'explicit' | 'implicit';
 
 /** Expanded information about a project dependency. */
 export interface ProjectDependencyConfig {
-	/** ID of the depended on project. */
+	/** Identifier of the depended on project. */
 	id: Id;
 	/**
 	 * Scope of the dependency relationship.
@@ -43,48 +45,44 @@ export interface ProjectDependencyConfig {
 
 export type ProjectDependsOn = Id | ProjectDependencyConfig;
 
-/** Configures `Dockerfile` generation. */
-export interface ProjectDockerFileConfig {
-	/** A task within the current project for building the project. */
-	buildTask: Id | null;
-	/** The base Docker image. */
-	image: string | null;
-	/** A task within the current project for starting the project. */
-	startTask: Id | null;
-}
-
-/** Configures aspects of the Docker scaffolding process. */
-export interface ProjectDockerScaffoldConfig {
+/**
+ * Configures our Docker integration.
+ * @since 1.27.0
+ */
+export interface ProjectDockerConfig {
 	/**
-	 * List of glob patterns, relative from the project root,
-	 * to include (or exclude) in the sources skeleton.
+	 * Configures aspects of the `Dockerfile` generation process.
+	 * @since 1.27.0
 	 */
-	include: string[];
-}
-
-/** Configures our Docker integration. */
-export interface ProjectDockerConfig {
-	/** Configures aspects of the `Dockerfile` generation process. */
-	file: ProjectDockerFileConfig;
-	/** Configures aspects of the Docker scaffolding process. */
-	scaffold: ProjectDockerScaffoldConfig;
+	file: DockerFileConfig;
+	/**
+	 * Configures aspects of the Docker scaffolding process.
+	 * @since 1.27.0
+	 */
+	scaffold: DockerScaffoldConfig;
 }
 
 /** Supported programming languages that each project can be written in. */
 export type LanguageType =
 	| 'bash'
 	| 'batch'
+	| 'cplusplus'
+	| 'csharp'
+	| 'dotnet'
 	| 'go'
+	| 'java'
 	| 'javascript'
+	| 'kotlin'
 	| 'php'
 	| 'python'
 	| 'ruby'
 	| 'rust'
+	| 'swift'
 	| 'typescript'
 	| 'unknown'
 	| string;
 
-/** The layer within the project stack, for categorizing. */
+/** The layer within the technology stack, for categorizing. */
 export type LayerType =
 	| 'application'
 	| 'automation'
@@ -98,11 +96,11 @@ export type OwnersPaths = string[] | Record<string, string[]>;
 
 /**
  * Defines ownership of source code within the current project, by mapping
- * file paths and globs to owners. An owner is either a user, team, or group.
+ * file paths and glob patterns to owners. An owner is either a user, team, or group.
  */
 export interface OwnersConfig {
 	/**
-	 * Bitbucket only. A mapping of custom groups (prefixed with `@@@`),
+	 * Bitbucket only. A map of custom groups (prefixed with `@@@`),
 	 * to a list of user and normal groups.
 	 */
 	customGroups: Record<string, string[]>;
@@ -111,9 +109,9 @@ export interface OwnersConfig {
 	/** GitLab only. Marks the code owners section as optional. */
 	optional: boolean;
 	/**
-	 * A mapping of file paths and file globs to owners.
+	 * A list or map of file paths and glob patterns to owners.
 	 * When a list, the `defaultOwner` is the owner, and each item is a path.
-	 * When an object, the key is a path, and the value is a list of owners.
+	 * When a map, the key is a path, and the value is a list of owners.
 	 */
 	paths: OwnersPaths;
 	/**
@@ -127,77 +125,66 @@ export interface OwnersConfig {
 /** Expanded information about the project. */
 export interface ProjectMetadataConfig {
 	/**
-	 * The Slack, Discord, etc, channel to discuss the project.
+	 * The Slack, Discord, IRC, etc, channel to discuss the project.
 	 * Must start with a `#`.
 	 */
 	channel: string | null;
-	/** A description on what the project does, and why it exists. */
-	description: string;
+	/** A description on what the project does and why it exists. */
+	description: string | null;
 	/** The individual maintainers of the project. The format is unspecified. */
 	maintainers: string[];
 	/** Custom metadata fields. */
 	metadata: Record<string, unknown>;
-	/** A human-readable name of the project. */
-	name: string | null;
 	/**
 	 * The owner of the project. Can be an individual, team, or
 	 * organization. The format is unspecified.
 	 */
 	owner: string | null;
+	/** A human-readable title of the project. */
+	title: string | null;
 }
 
 /** The technology stack of the project, for categorizing. */
-export type StackType = 'backend' | 'frontend' | 'infrastructure' | 'systems' | 'unknown';
-
-/** Overrides top-level toolchain settings. */
-export interface ProjectToolchainCommonToolConfig {
-	/** Version of the tool this project will use. */
-	version: UnresolvedVersionSpec | null;
-}
+export type StackType = 'backend' | 'data' | 'frontend' | 'infrastructure' | 'systems' | 'unknown';
 
 export type ProjectToolchainEntry = null | boolean | ToolchainPluginConfig;
 
 /** Overrides top-level toolchain settings, scoped to this project. */
-export interface ProjectToolchainConfig {
-	/** Overrides `bun` settings. */
-	bun: ProjectToolchainCommonToolConfig | null;
+export interface ProjectToolchainsConfig {
 	/**
-	 * The default toolchain(s) for all tasks within the project,
-	 * if their toolchain is unknown.
+	 * A single toolchain, or list of toolchains, to inherit for
+	 * this project and all of its tasks.
+	 * @since 1.31.0
 	 */
 	defaults?: Id | Id[] | null;
 	/**
-	 * The default toolchain(s) for all tasks within the project,
-	 * if their toolchain is unknown.
+	 * A single toolchain, or list of toolchains, to inherit for
+	 * this project and all of its tasks.
+	 * @since 1.31.0
 	 */
 	default: Id | Id[] | null;
-	/** Overrides `deno` settings. */
-	deno: ProjectToolchainCommonToolConfig | null;
-	/** Overrides `node` settings. */
-	node: ProjectToolchainCommonToolConfig | null;
-	/** Overrides toolchains by their ID. */
+	/** Overrides workspace-level toolchains by their identifier. */
 	plugins: Record<Id, ProjectToolchainEntry>;
-	/** Overrides `python` settings. */
-	python: ProjectToolchainCommonToolConfig | null;
-	/** Overrides `rust` settings. */
-	rust: ProjectToolchainCommonToolConfig | null;
 }
 
-/** Controls how tasks are inherited. */
+/** Controls how workspace-level tasks are inherited. */
 export interface ProjectWorkspaceInheritedTasksConfig {
-	/** Excludes inheriting tasks by ID. */
+	/** Excludes inheriting tasks by their identifier. */
 	exclude: Id[];
 	/**
-	 * Only inherits tasks by ID, and ignores the rest.
-	 * When not defined, inherits all matching tasks.
-	 * When an empty list, inherits no tasks.
+	 * Only inherits tasks with the provided identifiers,
+	 * and ignores the rest. When not defined, inherits
+	 * all matching tasks. When an empty list, inherits no tasks.
 	 */
 	include: Id[] | null;
-	/** Renames inherited tasks to a new ID. */
+	/**
+	 * Renames inherited tasks by mapping their existing
+	 * identifier to a new identifier, scoped to this project.
+	 */
 	rename: Record<Id, Id>;
 }
 
-/** Overrides top-level workspace settings, scoped to this project. */
+/** Overrides workspace settings, scoped to this project. */
 export interface ProjectWorkspaceConfig {
 	/** Controls how tasks are inherited. */
 	inheritedTasks: ProjectWorkspaceInheritedTasksConfig;
@@ -208,43 +195,41 @@ export interface ProjectWorkspaceConfig {
  * Docs: https://moonrepo.dev/docs/config/project
  */
 export interface ProjectConfig {
-	/** @default 'https://moonrepo.dev/schemas/project.json' */
-	$schema?: string;
+	$schema: string;
+	/** Other projects that this project depends on. */
+	deps?: ProjectDependsOn[];
 	/** Other projects that this project depends on. */
 	dependsOn: ProjectDependsOn[];
-	/** Configures Docker integration for this project. */
+	/**
+	 * Configures Docker integration for this project.
+	 * @since 1.27.0
+	 */
 	docker: ProjectDockerConfig;
 	/**
-	 * A mapping of environment variables that will be set for
+	 * A map of environment variables that will be inherited by
 	 * all tasks within the project.
 	 */
-	env: Record<string, string>;
+	env: Record<string, string | 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[]>;
 	/**
-	 * Overrides the ID within the project graph, as defined in
+	 * Overrides the identifier within the project graph, as defined in
 	 * the workspace `projects` setting.
+	 * @since 1.18.0
 	 */
 	id: Id | null;
 	/**
 	 * The primary programming language of the project.
 	 *
 	 * @default 'unknown'
-	 * @type {'bash' | 'batch' | 'go' | 'javascript' | 'php' | 'python' | 'ruby' | 'rust' | 'typescript' | 'unknown' | string}
+	 * @type {'bash' | 'batch' | 'cplusplus' | 'csharp' | 'dotnet' | 'go' | 'java' | 'javascript' | 'kotlin' | 'php' | 'python' | 'ruby' | 'rust' | 'swift' | 'typescript' | 'unknown' | string}
 	 */
 	language: LanguageType;
 	/**
-	 * The layer within the project stack, for categorizing.
-	 *
-	 * @default 'unknown'
-	 * @type {'application' | 'automation' | 'configuration' | 'library' | 'scaffolding' | 'tool' | 'unknown'}
-	 */
-	type?: LayerType;
-	/**
-	 * The layer within the project stack, for categorizing.
+	 * The layer within the technology stack, for categorizing.
 	 *
 	 * @default 'unknown'
 	 * @type {'application' | 'automation' | 'configuration' | 'library' | 'scaffolding' | 'tool' | 'unknown'}
@@ -253,23 +238,17 @@ export interface ProjectConfig {
 	/**
 	 * Defines ownership of source code within the current project, by mapping
 	 * file paths and globs to owners. An owner is either a user, team, or group.
+	 * @since 1.8.0
 	 */
 	owners: OwnersConfig;
-	/**
-	 * The default platform for all tasks within the project,
-	 * if their platform is unknown.
-	 *
-	 * @default 'unknown'
-	 * @deprecated
-	 */
-	platform: PlatformType | null;
 	/** Expanded information about the project. */
 	project: ProjectMetadataConfig | null;
 	/**
 	 * The technology stack of the project, for categorizing.
+	 * @since 1.22.0
 	 *
 	 * @default 'unknown'
-	 * @type {'backend' | 'frontend' | 'infrastructure' | 'systems' | 'unknown'}
+	 * @type {'backend' | 'data' | 'frontend' | 'infrastructure' | 'systems' | 'unknown'}
 	 */
 	stack: StackType;
 	/**
@@ -277,17 +256,20 @@ export interface ProjectConfig {
 	 * boundary enforcement, and task inheritance.
 	 */
 	tags: Id[];
-	/** 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>;
 	/** Overrides top-level toolchain settings, scoped to this project. */
-	toolchain: ProjectToolchainConfig;
+	toolchains: ProjectToolchainsConfig;
 	/** Overrides top-level workspace settings, scoped to this project. */
 	workspace: ProjectWorkspaceConfig;
 }
 
 /** Expanded information about a project dependency. */
 export interface PartialProjectDependencyConfig {
-	/** ID of the depended on project. */
+	/** Identifier of the depended on project. */
 	id?: Id | null;
 	/**
 	 * Scope of the dependency relationship.
@@ -307,42 +289,32 @@ export interface PartialProjectDependencyConfig {
 
 export type PartialProjectDependsOn = Id | PartialProjectDependencyConfig;
 
-/** Configures `Dockerfile` generation. */
-export interface PartialProjectDockerFileConfig {
-	/** A task within the current project for building the project. */
-	buildTask?: Id | null;
-	/** The base Docker image. */
-	image?: string | null;
-	/** A task within the current project for starting the project. */
-	startTask?: Id | null;
-}
-
-/** Configures aspects of the Docker scaffolding process. */
-export interface PartialProjectDockerScaffoldConfig {
+/**
+ * Configures our Docker integration.
+ * @since 1.27.0
+ */
+export interface PartialProjectDockerConfig {
 	/**
-	 * List of glob patterns, relative from the project root,
-	 * to include (or exclude) in the sources skeleton.
+	 * Configures aspects of the `Dockerfile` generation process.
+	 * @since 1.27.0
 	 */
-	include?: string[] | null;
-}
-
-/** Configures our Docker integration. */
-export interface PartialProjectDockerConfig {
-	/** Configures aspects of the `Dockerfile` generation process. */
-	file?: PartialProjectDockerFileConfig | null;
-	/** Configures aspects of the Docker scaffolding process. */
-	scaffold?: PartialProjectDockerScaffoldConfig | null;
+	file?: PartialDockerFileConfig | null;
+	/**
+	 * Configures aspects of the Docker scaffolding process.
+	 * @since 1.27.0
+	 */
+	scaffold?: PartialDockerScaffoldConfig | null;
 }
 
 export type PartialOwnersPaths = string[] | Record<string, string[]>;
 
 /**
  * Defines ownership of source code within the current project, by mapping
- * file paths and globs to owners. An owner is either a user, team, or group.
+ * file paths and glob patterns to owners. An owner is either a user, team, or group.
  */
 export interface PartialOwnersConfig {
 	/**
-	 * Bitbucket only. A mapping of custom groups (prefixed with `@@@`),
+	 * Bitbucket only. A map of custom groups (prefixed with `@@@`),
 	 * to a list of user and normal groups.
 	 */
 	customGroups?: Record<string, string[]> | null;
@@ -351,9 +323,9 @@ export interface PartialOwnersConfig {
 	/** GitLab only. Marks the code owners section as optional. */
 	optional?: boolean | null;
 	/**
-	 * A mapping of file paths and file globs to owners.
+	 * A list or map of file paths and glob patterns to owners.
 	 * When a list, the `defaultOwner` is the owner, and each item is a path.
-	 * When an object, the key is a path, and the value is a list of owners.
+	 * When a map, the key is a path, and the value is a list of owners.
 	 */
 	paths?: PartialOwnersPaths | null;
 	/**
@@ -367,74 +339,63 @@ export interface PartialOwnersConfig {
 /** Expanded information about the project. */
 export interface PartialProjectMetadataConfig {
 	/**
-	 * The Slack, Discord, etc, channel to discuss the project.
+	 * The Slack, Discord, IRC, etc, channel to discuss the project.
 	 * Must start with a `#`.
 	 */
 	channel?: string | null;
-	/** A description on what the project does, and why it exists. */
+	/** A description on what the project does and why it exists. */
 	description?: string | null;
 	/** The individual maintainers of the project. The format is unspecified. */
 	maintainers?: string[] | null;
 	/** Custom metadata fields. */
 	metadata?: Record<string, unknown> | null;
-	/** A human-readable name of the project. */
-	name?: string | null;
 	/**
 	 * The owner of the project. Can be an individual, team, or
 	 * organization. The format is unspecified.
 	 */
 	owner?: string | null;
-}
-
-/** Overrides top-level toolchain settings. */
-export interface PartialProjectToolchainCommonToolConfig {
-	/** Version of the tool this project will use. */
-	version?: UnresolvedVersionSpec | null;
+	/** A human-readable title of the project. */
+	title?: string | null;
 }
 
 export type PartialProjectToolchainEntry = null | boolean | PartialToolchainPluginConfig;
 
 /** Overrides top-level toolchain settings, scoped to this project. */
-export interface PartialProjectToolchainConfig {
-	/** Overrides `bun` settings. */
-	bun?: PartialProjectToolchainCommonToolConfig | null;
+export interface PartialProjectToolchainsConfig {
 	/**
-	 * The default toolchain(s) for all tasks within the project,
-	 * if their toolchain is unknown.
+	 * A single toolchain, or list of toolchains, to inherit for
+	 * this project and all of its tasks.
+	 * @since 1.31.0
 	 */
 	defaults?: Id | Id[] | null;
 	/**
-	 * The default toolchain(s) for all tasks within the project,
-	 * if their toolchain is unknown.
+	 * A single toolchain, or list of toolchains, to inherit for
+	 * this project and all of its tasks.
+	 * @since 1.31.0
 	 */
 	default?: Id | Id[] | null;
-	/** Overrides `deno` settings. */
-	deno?: PartialProjectToolchainCommonToolConfig | null;
-	/** Overrides `node` settings. */
-	node?: PartialProjectToolchainCommonToolConfig | null;
-	/** Overrides toolchains by their ID. */
+	/** Overrides workspace-level toolchains by their identifier. */
 	plugins?: Record<Id, PartialProjectToolchainEntry> | null;
-	/** Overrides `python` settings. */
-	python?: PartialProjectToolchainCommonToolConfig | null;
-	/** Overrides `rust` settings. */
-	rust?: PartialProjectToolchainCommonToolConfig | null;
 }
 
-/** Controls how tasks are inherited. */
+/** Controls how workspace-level tasks are inherited. */
 export interface PartialProjectWorkspaceInheritedTasksConfig {
-	/** Excludes inheriting tasks by ID. */
+	/** Excludes inheriting tasks by their identifier. */
 	exclude?: Id[] | null;
 	/**
-	 * Only inherits tasks by ID, and ignores the rest.
-	 * When not defined, inherits all matching tasks.
-	 * When an empty list, inherits no tasks.
+	 * Only inherits tasks with the provided identifiers,
+	 * and ignores the rest. When not defined, inherits
+	 * all matching tasks. When an empty list, inherits no tasks.
 	 */
 	include?: Id[] | null;
-	/** Renames inherited tasks to a new ID. */
+	/**
+	 * Renames inherited tasks by mapping their existing
+	 * identifier to a new identifier, scoped to this project.
+	 */
 	rename?: Record<Id, Id> | null;
 }
 
-/** Overrides top-level workspace settings, scoped to this project. */
+/** Overrides workspace settings, scoped to this project. */
 export interface PartialProjectWorkspaceConfig {
 	/** Controls how tasks are inherited. */
 	inheritedTasks?: PartialProjectWorkspaceInheritedTasksConfig | null;
@@ -445,25 +406,30 @@ export interface PartialProjectWorkspaceConfig {
  * Docs: https://moonrepo.dev/docs/config/project
  */
 export interface PartialProjectConfig {
-	/** @default 'https://moonrepo.dev/schemas/project.json' */
 	$schema?: string | null;
 	/** Other projects that this project depends on. */
+	deps?: PartialProjectDependsOn[] | null;
+	/** Other projects that this project depends on. */
 	dependsOn?: PartialProjectDependsOn[] | null;
-	/** Configures Docker integration for this project. */
+	/**
+	 * Configures Docker integration for this project.
+	 * @since 1.27.0
+	 */
 	docker?: PartialProjectDockerConfig | null;
 	/**
-	 * A mapping of environment variables that will be set for
+	 * A map of environment variables that will be inherited by
 	 * all tasks within the project.
 	 */
-	env?: Record<string, string> | null;
+	env?: Record<string, string | null> | 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;
 	/**
-	 * Overrides the ID within the project graph, as defined in
+	 * Overrides the identifier within the project graph, as defined in
 	 * the workspace `projects` setting.
+	 * @since 1.18.0
 	 */
 	id?: Id | null;
 	/**
@@ -473,13 +439,7 @@ export interface PartialProjectConfig {
 	 */
 	language?: LanguageType | null;
 	/**
-	 * The layer within the project stack, for categorizing.
-	 *
-	 * @default 'unknown'
-	 */
-	type?: LayerType | null;
-	/**
-	 * The layer within the project stack, for categorizing.
+	 * The layer within the technology stack, for categorizing.
 	 *
 	 * @default 'unknown'
 	 */
@@ -487,20 +447,14 @@ export interface PartialProjectConfig {
 	/**
 	 * Defines ownership of source code within the current project, by mapping
 	 * file paths and globs to owners. An owner is either a user, team, or group.
+	 * @since 1.8.0
 	 */
 	owners?: PartialOwnersConfig | null;
-	/**
-	 * The default platform for all tasks within the project,
-	 * if their platform is unknown.
-	 *
-	 * @default 'unknown'
-	 * @deprecated
-	 */
-	platform?: PlatformType | null;
 	/** Expanded information about the project. */
 	project?: PartialProjectMetadataConfig | null;
 	/**
 	 * The technology stack of the project, for categorizing.
+	 * @since 1.22.0
 	 *
 	 * @default 'unknown'
 	 */
@@ -510,10 +464,13 @@ export interface PartialProjectConfig {
 	 * boundary enforcement, and task inheritance.
 	 */
 	tags?: Id[] | 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;
 	/** Overrides top-level toolchain settings, scoped to this project. */
-	toolchain?: PartialProjectToolchainConfig | null;
+	toolchains?: PartialProjectToolchainsConfig | null;
 	/** Overrides top-level workspace settings, scoped to this project. */
 	workspace?: PartialProjectWorkspaceConfig | null;
 }