breaking: Rename task type to platform. (#378)

* Rename to platform. * Update tests and docs. * Rename token. * Add new token. * Update blog post.
moonrepo · Oct 20, 2022 · daf3b1b · daf3b1b
1 parent 3e4355e
commit daf3b1b
Show file tree

Hide file tree

Showing 26 changed files with 263 additions and 183 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/cli/tests/snapshots/migrate_test__from_package_json__converts_scripts-2.snap b/crates/cli/tests/snapshots/migrate_test__from_package_json__converts_scripts-2.snap
@@ -9,13 +9,13 @@ tasks:
     command:
     - eslint
     - .
-    type: node
+    platform: node
   lint-fix:
     command:
     - moon
     - run
     - common:lint
     - --
     - --fix
-    type: node
+    platform: node
 
diff --git a/crates/cli/tests/snapshots/migrate_test__from_package_json__links_depends_on-2.snap b/crates/cli/tests/snapshots/migrate_test__from_package_json__links_depends_on-2.snap
@@ -15,8 +15,8 @@ tasks:
     - ./lib
     outputs:
     - lib
-    type: node
+    platform: node
   test:
     command: jest
-    type: node
+    platform: node
 
diff --git a/crates/config/src/project/task.rs b/crates/config/src/project/task.rs
@@ -105,8 +105,7 @@ pub struct TaskConfig {
     pub options: TaskOptionsConfig,
 
     #[serde(skip_serializing_if = "skip_if_default")]
-    #[serde(rename = "type")]
-    pub type_of: PlatformType,
+    pub platform: PlatformType,
 }
 
 impl TaskConfig {

diff --git a/crates/config/templates/global_project.yml b/crates/config/templates/global_project.yml
@@ -68,6 +68,6 @@ tasks:
     # To output files to the workspace root, prefix the path with a "/".
     outputs: []
 
-    # The type of command to run, and where to locate it.
-    # Accepts "node" (default) or "system".
-    type: 'node'
+    # The platform to run the command on, and where to locate it.
+    # Accepts "node" or "system". Defaults based on project `language`.
+    platform: 'node'
diff --git a/crates/config/tests/tasks_test.rs b/crates/config/tests/tasks_test.rs
@@ -539,18 +539,18 @@ outputs:
     }
 }
 
-mod type_of {
+mod platform {
     #[test]
     #[should_panic(
-        expected = "unknown variant: found `whatisthis`, expected `one of `node`, `system`, `unknown`` for key \"default.type\""
+        expected = "unknown variant: found `whatisthis`, expected `one of `node`, `system`, `unknown`` for key \"default.platform\""
     )]
     fn invalid_type() {
         figment::Jail::expect_with(|jail| {
             jail.create_file(
                 super::CONFIG_FILENAME,
                 r#"
 command: foo
-type: whatisthis
+platform: whatisthis
 "#,
             )?;
 

diff --git a/crates/platform-node/src/task.rs b/crates/platform-node/src/task.rs
@@ -170,7 +170,7 @@ pub fn create_task(
     }
 
     if is_wrapping {
-        task_config.type_of = PlatformType::Node;
+        task_config.platform = PlatformType::Node;
         task_config.command = Some(TaskCommandArgs::Sequence(string_vec![
             "moon",
             "node",
@@ -190,7 +190,7 @@ pub fn create_task(
             args.insert(0, "noop".to_owned());
         }
 
-        task_config.type_of = detect_platform_type(&args[0]);
+        task_config.platform = detect_platform_type(&args[0]);
         task_config.command = Some(if args.len() == 1 {
             TaskCommandArgs::String(args.remove(0))
         } else {