fix!: Speak in user terms for Tree::files

Author: epage

schema.json

@@ -139,10 +139,10 @@
     "Tree": {
       "type": "object",
       "required": [
-        "tracked"
+        "files"
       ],
       "properties": {
-        "tracked": {
+        "files": {
           "type": "object",
           "additionalProperties": {
             "$ref": "#/definitions/FileContent"

src/lib.rs

@@ -105,7 +105,7 @@ impl TodoList {
                             .ok()
                             .wrap_err_with(|| format!("Failed to remove {}", relpath.display()))?;
                     }
-                    for (relpath, content) in tree.tracked.iter() {
+                    for (relpath, content) in tree.files.iter() {
                         let path = cwd.join(relpath);
                         if let Some(parent) = path.parent() {
                             std::fs::create_dir_all(parent).wrap_err_with(|| {

src/model.rs

@@ -64,7 +64,7 @@ impl From<Tree> for Command {
 #[cfg_attr(feature = "serde", serde(rename_all = "snake_case"))]
 #[cfg_attr(feature = "serde", serde(deny_unknown_fields))]
 pub struct Tree {
-    pub tracked: std::collections::HashMap<std::path::PathBuf, FileContent>,
+    pub files: std::collections::HashMap<std::path::PathBuf, FileContent>,
     #[cfg_attr(feature = "serde", serde(default))]
     pub message: Option<String>,
     #[cfg_attr(feature = "serde", serde(default))]

tests/fixtures/branches.yml

@@ -1,59 +1,59 @@
 init: true
 commands:
 - tree:
-    tracked:
+    files:
       "file_a.txt": "1"
     message: "1"
 - branch: initial
 - tree:
-    tracked:
+    files:
       "file_a.txt": "2"
     message: "2"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
     message: "3"
 - branch: base
 - label: base
 
 - reset: base
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "1"
     message: "4"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "2"
     message: "5"
 - branch: master
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "3"
     message: "6"
 - branch: off_master
 
 - reset: base
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_c.txt": "1"
     message: "7"
 - branch: feature1
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_c.txt": "2"
     message: "8"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_c.txt": "3"
     message: "9"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_c.txt": "4"
     message: "10"

tests/fixtures/conflict.yml

@@ -1,35 +1,35 @@
 init: true
 commands:
 - tree:
-    tracked:
+    files:
       "file_a.txt": "1"
     message: "1"
 - branch: initial
 - tree:
-    tracked:
+    files:
       "file_a.txt": "2"
     message: "2"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
     message: "3"
 - branch: base
 - label: base
 
 - reset: base
 - tree:
-    tracked:
+    files:
       "file_a.txt": "4"
     message: "4"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "5"
     message: "5"
 - branch: master
 
 - reset: base
 - tree:
-    tracked:
+    files:
       "file_a.txt": "6"
     message: "7"
 - branch: feature1

tests/fixtures/fixup.yml

@@ -1,59 +1,59 @@
 init: true
 commands:
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
     message: "commit 1"
 - branch: base
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "1"
     message: "commit 2"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "2"
     message: "master commit"
 - branch: master
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "3"
     message: "feature1 commit 1"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "5"
     message: "feature1 commit 2"
 - branch: feature1
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_c.txt": "1"
     message: "fixup! feature1 commit 1"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_c.txt": "4"
     message: "feature1 commit 3"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_c.txt": "1"
     message: "fixup! feature1 commit 1"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_c.txt": "2"
     message: "fixup! feature1 commit 2"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_c.txt": "4"
     message: "feature2 commit"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_c.txt": "1"
     message: "fixup! feature1 commit 1"

tests/fixtures/git_rebase_existing.yml

@@ -1,29 +1,29 @@
 init: true
 commands:
 - tree:
-    tracked:
+    files:
       "file_a.txt": "1"
     message: "1"
 - branch: initial
 - tree:
-    tracked:
+    files:
       "file_a.txt": "2"
     message: "2"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
     message: "3"
 - branch: master
 - label: master
 
 - reset: master
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "1"
     message: "7"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "2"
     message: "8"
@@ -32,7 +32,7 @@ commands:
 # `git rebase master` caused the history to split
 - reset: master
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "1"
     message: "7"

tests/fixtures/git_rebase_new.yml

@@ -1,29 +1,29 @@
 init: true
 commands:
 - tree:
-    tracked:
+    files:
       "file_a.txt": "1"
     message: "1"
 - branch: initial
 - tree:
-    tracked:
+    files:
       "file_a.txt": "2"
     message: "2"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
     message: "3"
 - branch: master
 - label: master
 
 - reset: master
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "1"
     message: "7"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "1"
       "file_c.txt": "1"
@@ -33,7 +33,7 @@ commands:
 # `git rebase master` caused the history to split
 - reset: master
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "1"
     message: "7"

tests/fixtures/pr-semi-linear-merge.yml

@@ -1,59 +1,59 @@
 init: true
 commands:
 - tree:
-    tracked:
+    files:
       "file_a.txt": "1"
     message: "1"
 - branch: initial
 - tree:
-    tracked:
+    files:
       "file_a.txt": "2"
     message: "2"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
     message: "3"
 - branch: base
 - label: base
 
 - reset: base
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "1"
     message: "4"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "2"
     message: "5"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "3"
     message: "6"
 - branch: old_master
 # AzDO has the "semi-linear merge" type which rebases the branch before merging
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "3"
       "file_c.txt": "1"
     message: "7"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "3"
       "file_c.txt": "2"
     message: "8"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "3"
       "file_c.txt": "3"
     message: "9"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_b.txt": "3"
       "file_c.txt": "4"
@@ -62,23 +62,23 @@ commands:
 
 - reset: base
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_c.txt": "1"
     message: "7"
 - branch: feature1
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_c.txt": "2"
     message: "8"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_c.txt": "3"
     message: "9"
 - tree:
-    tracked:
+    files:
       "file_a.txt": "3"
       "file_c.txt": "4"
     message: "10"