Add setting.

Author: milesj

CHANGELOG.md

@@ -24,6 +24,9 @@
   - Added extensive testing to account for edge cases.
   - When the server doesn't support the configured compression, it will now default to "identity"
     (uncompressed) instead of disabling the cache entirely.
+- **Tasks**
+  - Added a `taskOptions` setting to `moon.*` that allows you to configure default task options for
+    all tasks within the current project, which can be overridden per task.
 - **VCS**
   - Hardened all executed Git commands: revisions are validated against argument injection,
     credential prompts now fail immediately instead of hanging, and the fsmonitor daemon is now

crates/config/src/project_config.rs

@@ -1,6 +1,7 @@
 use crate::project::*;
 use crate::shapes::Input;
 use crate::task_config::{EnvMap, TaskConfig};
+use crate::task_options_config::{PartialTaskOptionsConfig, TaskOptionsConfig};
 use crate::{config_enum, config_struct, config_unit_enum};
 use moon_common::Id;
 use rustc_hash::FxHashMap;
@@ -163,6 +164,12 @@ config_struct!(
         #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
         pub tasks: BTreeMap<Id, TaskConfig>,
 
+        /// Shared task options for all tasks. Can be overriden per task.
+        /// @since 2.4.0
+        #[setting(nested)]
+        #[serde(skip_serializing_if = "Option::is_none")]
+        pub task_options: Option<TaskOptionsConfig>,
+
         /// Overrides top-level toolchain settings, scoped to this project.
         #[setting(nested)]
         pub toolchains: ProjectToolchainsConfig,

crates/config/src/workspace/cache_config.rs

@@ -8,6 +8,7 @@ config_struct!(
         /// Maximum total size of the local cache, for example "10gb" or
         /// "512mib". When exceeded, the least recently used cached task outputs
         /// are evicted. Unlimited when unset.
+        /// @since 2.4.0
         pub max_size: Option<String>,
 
         // /// Byte threshold above which to use memory-mapped I/O for hashing.
@@ -16,6 +17,7 @@ config_struct!(
         // pub mmap_threshold: u64,
         /// Verify hash on every read. When enabled, reads are slower
         /// but detect on-disk corruption.
+        /// @since 2.3.0
         pub verify_integrity: bool,
     }
 );
@@ -25,6 +27,7 @@ config_struct!(
     #[derive(Config)]
     pub struct CacheConfig {
         /// Configures aspects of the content-addressable storage (CAS) cache.
+        /// @since 2.3.0
         #[setting(nested)]
         pub cas: CacheCasConfig,
     }

crates/config/src/workspace/experiments_config.rs

@@ -6,18 +6,22 @@ config_struct!(
     #[derive(Config)]
     pub struct ExperimentsConfig {
         /// Track and determine affected projects and tasks asynchronously.
+        /// @since 2.2.0
         #[setting(env = "MOON_EXPERIMENT_ASYNC_AFFECTED_TRACKING", parse_env = env::parse_bool)]
         pub async_affected_tracking: bool,
 
         /// Build the project and task graphs asynchronously.
+        /// @since 2.2.0
         #[setting(env = "MOON_EXPERIMENT_ASYNC_GRAPH_BUILDING", parse_env = env::parse_bool)]
         pub async_graph_building: bool,
 
         /// Store task outputs in a local CAS (content-addressable storage) cache.
+        /// @since 2.3.0
         #[setting(env = "MOON_EXPERIMENT_CAS_OUTPUTS_CACHE", parse_env = env::parse_bool)]
         pub cas_outputs_cache: bool,
 
         /// Use native file hashing instead of using the VCS.
+        /// @since 2.3.0
         #[setting(env = "MOON_EXPERIMENT_NATIVE_FILE_HASHING", parse_env = env::parse_bool)]
         pub native_file_hashing: bool,
     }

crates/task-builder/src/tasks_builder.rs

@@ -111,8 +111,8 @@ pub struct TasksBuilder<'proj> {
     // Tasks to merge and build
     task_ids: FxHashSet<&'proj Id>,
     global_tasks: FxHashMap<&'proj Id, Vec<&'proj TaskConfig>>,
-    global_task_options: Vec<&'proj TaskOptionsConfig>,
     local_tasks: FxHashMap<&'proj Id, &'proj TaskConfig>,
+    shared_task_options: Vec<&'proj TaskOptionsConfig>,
     filters: Option<&'proj ProjectWorkspaceInheritedTasksConfig>,
 }
 
@@ -135,7 +135,7 @@ impl<'proj> TasksBuilder<'proj> {
             implicit_inputs: vec![],
             task_ids: FxHashSet::default(),
             global_tasks: FxHashMap::default(),
-            global_task_options: vec![],
+            shared_task_options: vec![],
             local_tasks: FxHashMap::default(),
             filters: None,
         }
@@ -234,7 +234,7 @@ impl<'proj> TasksBuilder<'proj> {
             }
 
             if let Some(options) = &global_config.task_options {
-                self.global_task_options.push(options);
+                self.shared_task_options.push(options);
             }
 
             self.implicit_deps.extend(&global_config.implicit_deps);
@@ -263,6 +263,10 @@ impl<'proj> TasksBuilder<'proj> {
             self.task_ids.insert(id);
         }
 
+        if let Some(options) = &local_config.task_options {
+            self.shared_task_options.push(options);
+        }
+
         self
     }
 
@@ -617,7 +621,7 @@ impl<'proj> TasksBuilder<'proj> {
         options.unix_shell = default_unix_shell();
         options.windows_shell = default_windows_shell();
 
-        let mut chain = self.global_task_options.clone();
+        let mut chain = self.shared_task_options.clone();
 
         chain.extend(
             self.get_config_inherit_chain(id)?

packages/types/src/project-config.ts

@@ -262,6 +262,11 @@ export interface ProjectConfig {
 	 * boundary enforcement, and task inheritance.
 	 */
 	tags?: Id[];
+	/**
+	 * Shared task options for all tasks. Can be overriden per task.
+	 * @since 2.4.0
+	 */
+	taskOptions: TaskOptionsConfig | null;
 	/**
 	 * A map of identifiers to task objects. Tasks represent the work-unit
 	 * of a project, and can be ran in the action pipeline.
@@ -478,6 +483,11 @@ export interface PartialProjectConfig {
 	 * boundary enforcement, and task inheritance.
 	 */
 	tags?: Id[] | null;
+	/**
+	 * Shared task options for all tasks. Can be overriden per task.
+	 * @since 2.4.0
+	 */
+	taskOptions?: PartialTaskOptionsConfig | null;
 	/**
 	 * A map of identifiers to task objects. Tasks represent the work-unit
 	 * of a project, and can be ran in the action pipeline.

packages/types/src/workspace-config.ts

@@ -6,16 +6,27 @@ import type { ExtendsFrom, Id } from './common';
 
 /** Configures aspects of the content-addressable storage (CAS) cache. */
 export interface CacheCasConfig {
+	/**
+	 * Maximum total size of the local cache, for example "10gb" or
+	 * "512mib". When exceeded, the least recently used cached task outputs
+	 * are evicted. Unlimited when unset.
+	 * @since 2.4.0
+	 */
+	maxSize: string | null;
 	/**
 	 * Verify hash on every read. When enabled, reads are slower
 	 * but detect on-disk corruption.
+	 * @since 2.3.0
 	 */
 	verifyIntegrity: boolean;
 }
 
 /** Configures aspects of the caching engine and layer. */
 export interface CacheConfig {
-	/** Configures aspects of the content-addressable storage (CAS) cache. */
+	/**
+	 * Configures aspects of the content-addressable storage (CAS) cache.
+	 * @since 2.3.0
+	 */
 	cas: CacheCasConfig;
 }
 
@@ -164,24 +175,28 @@ export interface DockerConfig {
 export interface ExperimentsConfig {
 	/**
 	 * Track and determine affected projects and tasks asynchronously.
+	 * @since 2.2.0
 	 *
 	 * @env MOON_EXPERIMENT_ASYNC_AFFECTED_TRACKING
 	 */
 	asyncAffectedTracking: boolean;
 	/**
 	 * Build the project and task graphs asynchronously.
+	 * @since 2.2.0
 	 *
 	 * @env MOON_EXPERIMENT_ASYNC_GRAPH_BUILDING
 	 */
 	asyncGraphBuilding: boolean;
 	/**
 	 * Store task outputs in a local CAS (content-addressable storage) cache.
+	 * @since 2.3.0
 	 *
 	 * @env MOON_EXPERIMENT_CAS_OUTPUTS_CACHE
 	 */
 	casOutputsCache: boolean;
 	/**
 	 * Use native file hashing instead of using the VCS.
+	 * @since 2.3.0
 	 *
 	 * @env MOON_EXPERIMENT_NATIVE_FILE_HASHING
 	 */
@@ -678,16 +693,27 @@ export interface WorkspaceConfig {
 
 /** Configures aspects of the content-addressable storage (CAS) cache. */
 export interface PartialCacheCasConfig {
+	/**
+	 * Maximum total size of the local cache, for example "10gb" or
+	 * "512mib". When exceeded, the least recently used cached task outputs
+	 * are evicted. Unlimited when unset.
+	 * @since 2.4.0
+	 */
+	maxSize?: string | null;
 	/**
 	 * Verify hash on every read. When enabled, reads are slower
 	 * but detect on-disk corruption.
+	 * @since 2.3.0
 	 */
 	verifyIntegrity?: boolean | null;
 }
 
 /** Configures aspects of the caching engine and layer. */
 export interface PartialCacheConfig {
-	/** Configures aspects of the content-addressable storage (CAS) cache. */
+	/**
+	 * Configures aspects of the content-addressable storage (CAS) cache.
+	 * @since 2.3.0
+	 */
 	cas?: PartialCacheCasConfig | null;
 }
 
@@ -832,24 +858,28 @@ export interface PartialDockerConfig {
 export interface PartialExperimentsConfig {
 	/**
 	 * Track and determine affected projects and tasks asynchronously.
+	 * @since 2.2.0
 	 *
 	 * @env MOON_EXPERIMENT_ASYNC_AFFECTED_TRACKING
 	 */
 	asyncAffectedTracking?: boolean | null;
 	/**
 	 * Build the project and task graphs asynchronously.
+	 * @since 2.2.0
 	 *
 	 * @env MOON_EXPERIMENT_ASYNC_GRAPH_BUILDING
 	 */
 	asyncGraphBuilding?: boolean | null;
 	/**
 	 * Store task outputs in a local CAS (content-addressable storage) cache.
+	 * @since 2.3.0
 	 *
 	 * @env MOON_EXPERIMENT_CAS_OUTPUTS_CACHE
 	 */
 	casOutputsCache?: boolean | null;
 	/**
 	 * Use native file hashing instead of using the VCS.
+	 * @since 2.3.0
 	 *
 	 * @env MOON_EXPERIMENT_NATIVE_FILE_HASHING
 	 */

website/static/schemas/v2/project.json

@@ -136,6 +136,18 @@
         "$ref": "#/definitions/Id"
       }
     },
+    "taskOptions": {
+      "title": "taskOptions",
+      "description": "Shared task options for all tasks. Can be overriden per task. @since 2.4.0",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/TaskOptionsConfig"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
     "tasks": {
       "title": "tasks",
       "description": "A map of identifiers to task objects. Tasks represent the work-unit of a project, and can be ran in the action pipeline.",

website/static/schemas/v2/workspace.json

@@ -186,11 +186,23 @@
       "description": "Configures aspects of the content-addressable storage (CAS) cache.",
       "type": "object",
       "properties": {
+        "maxSize": {
+          "title": "maxSize",
+          "description": "Maximum total size of the local cache, for example \"10gb\" or \"512mib\". When exceeded, the least recently used cached task outputs are evicted. Unlimited when unset. @since 2.4.0",
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "verifyIntegrity": {
           "title": "verifyIntegrity",
-          "description": "Verify hash on every read. When enabled, reads are slower but detect on-disk corruption.",
+          "description": "Verify hash on every read. When enabled, reads are slower but detect on-disk corruption. @since 2.3.0",
           "type": "boolean",
-          "markdownDescription": "Verify hash on every read. When enabled, reads are slower but detect on-disk corruption."
+          "markdownDescription": "Verify hash on every read. When enabled, reads are slower but detect on-disk corruption. @since 2.3.0"
         }
       },
       "additionalProperties": false,
@@ -202,13 +214,13 @@
       "properties": {
         "cas": {
           "title": "cas",
-          "description": "Configures aspects of the content-addressable storage (CAS) cache.",
+          "description": "Configures aspects of the content-addressable storage (CAS) cache. @since 2.3.0",
           "allOf": [
             {
               "$ref": "#/definitions/CacheCasConfig"
             }
           ],
-          "markdownDescription": "Configures aspects of the content-addressable storage (CAS) cache."
+          "markdownDescription": "Configures aspects of the content-addressable storage (CAS) cache. @since 2.3.0"
         }
       },
       "additionalProperties": false
@@ -465,23 +477,23 @@
       "properties": {
         "asyncAffectedTracking": {
           "title": "asyncAffectedTracking",
-          "description": "Track and determine affected projects and tasks asynchronously.",
+          "description": "Track and determine affected projects and tasks asynchronously. @since 2.2.0",
           "type": "boolean"
         },
         "asyncGraphBuilding": {
           "title": "asyncGraphBuilding",
-          "description": "Build the project and task graphs asynchronously.",
+          "description": "Build the project and task graphs asynchronously. @since 2.2.0",
           "type": "boolean"
         },
         "casOutputsCache": {
           "title": "casOutputsCache",
-          "description": "Store task outputs in a local CAS (content-addressable storage) cache.",
+          "description": "Store task outputs in a local CAS (content-addressable storage) cache. @since 2.3.0",
           "type": "boolean",
-          "markdownDescription": "Store task outputs in a local CAS (content-addressable storage) cache."
+          "markdownDescription": "Store task outputs in a local CAS (content-addressable storage) cache. @since 2.3.0"
         },
         "nativeFileHashing": {
           "title": "nativeFileHashing",
-          "description": "Use native file hashing instead of using the VCS.",
+          "description": "Use native file hashing instead of using the VCS. @since 2.3.0",
           "type": "boolean"
         }
       },