Better names for public API on ArchiveTool and SerializedFileTool

Author: SkowronskiAndrew

Archive/ArchiveTool.cs

@@ -15,7 +15,7 @@ public enum OutputFormat
         Json
     }
 
-    public static int HandleExtract(FileInfo filename, DirectoryInfo outputFolder, string filter = null)
+    public static int ExtractContent(FileInfo filename, DirectoryInfo outputFolder, string filter = null)
     {
         try
         {
@@ -45,7 +45,7 @@ err is NotSupportedException
         return 0;
     }
 
-    public static int HandleList(FileInfo filename, OutputFormat format)
+    public static int ListContent(FileInfo filename, OutputFormat format)
     {
         try
         {
@@ -76,7 +76,7 @@ err is NotSupportedException
         return 0;
     }
 
-    public static int HandleHeader(FileInfo filename, OutputFormat format)
+    public static int PrintHeader(FileInfo filename, OutputFormat format)
     {
         var path = filename.ToString();
 
@@ -100,7 +100,7 @@ public static int HandleHeader(FileInfo filename, OutputFormat format)
         return 0;
     }
 
-    public static int HandleBlocks(FileInfo filename, OutputFormat format)
+    public static int ListBlocks(FileInfo filename, OutputFormat format)
     {
         var path = filename.ToString();
 
@@ -130,7 +130,7 @@ public static int HandleBlocks(FileInfo filename, OutputFormat format)
         return 0;
     }
 
-    public static int HandleInfo(FileInfo filename, OutputFormat format)
+    public static int PrintSummary(FileInfo filename, OutputFormat format)
     {
         var path = filename.ToString();
 

SerializedFile/SerializedFileTool.cs

@@ -15,7 +15,7 @@ public enum OutputFormat
         Json
     }
 
-    public static int HandleExternalRefs(FileInfo filename, OutputFormat format)
+    public static int ListExternalRefs(FileInfo filename, OutputFormat format)
     {
         // External references are read directly from the parsed metadata rather than via UnityFileSystemApi.
         //
@@ -50,10 +50,10 @@ public static int HandleExternalRefs(FileInfo filename, OutputFormat format)
         return 0;
     }
 
-    public static int HandleObjectList(FileInfo filename, OutputFormat format)
+    public static int ListObjects(FileInfo filename, OutputFormat format)
     {
         // The object list is read directly from the parsed metadata rather than via UnityFileSystemApi.
-        // (See comment in HandleExternalRefs() for the reasons for doing it that way)
+        // (See comment in ListExternalRefs() for the reasons for doing it that way)
         if (!ValidateSerializedFile(filename.FullName, out var fileInfo))
             return 1;
 
@@ -78,7 +78,7 @@ public static int HandleObjectList(FileInfo filename, OutputFormat format)
         return 0;
     }
 
-    public static int HandleHeader(FileInfo filename, OutputFormat format)
+    public static int PrintHeader(FileInfo filename, OutputFormat format)
     {
         if (!ValidateSerializedFile(filename.FullName, out var fileInfo))
             return 1;
@@ -91,7 +91,7 @@ public static int HandleHeader(FileInfo filename, OutputFormat format)
         return 0;
     }
 
-    public static int HandleMetadata(FileInfo filename, OutputFormat format)
+    public static int PrintMetadata(FileInfo filename, OutputFormat format)
     {
         if (!ValidateSerializedFile(filename.FullName, out var fileInfo))
             return 1;

UnityDataTool/Program.cs

@@ -225,7 +225,7 @@ static Command BuildArchiveCommand()
             filterOpt,
         };
         extractArchiveCommand.SetHandler(
-            (FileInfo fi, DirectoryInfo o, string filter) => Task.FromResult(ArchiveTool.HandleExtract(fi, o, filter)),
+            (FileInfo fi, DirectoryInfo o, string filter) => Task.FromResult(ArchiveTool.ExtractContent(fi, o, filter)),
             pathArg, oOpt, filterOpt);
 
         var fOpt = new Option<ArchiveTool.OutputFormat>(aliases: new[] { "--format", "-f" }, description: "Output format", getDefaultValue: () => ArchiveTool.OutputFormat.Text);
@@ -236,7 +236,7 @@ static Command BuildArchiveCommand()
             fOpt,
         };
         listArchiveCommand.SetHandler(
-            (FileInfo fi, ArchiveTool.OutputFormat f) => Task.FromResult(ArchiveTool.HandleList(fi, f)),
+            (FileInfo fi, ArchiveTool.OutputFormat f) => Task.FromResult(ArchiveTool.ListContent(fi, f)),
             pathArg, fOpt);
 
         var headerArchiveCommand = new Command("header", "Display the header of a Unity Archive file.")
@@ -245,7 +245,7 @@ static Command BuildArchiveCommand()
             fOpt,
         };
         headerArchiveCommand.SetHandler(
-            (FileInfo fi, ArchiveTool.OutputFormat f) => Task.FromResult(ArchiveTool.HandleHeader(fi, f)),
+            (FileInfo fi, ArchiveTool.OutputFormat f) => Task.FromResult(ArchiveTool.PrintHeader(fi, f)),
             pathArg, fOpt);
 
         var blocksArchiveCommand = new Command("blocks", "Display the block list of a Unity Archive file.")
@@ -254,7 +254,7 @@ static Command BuildArchiveCommand()
             fOpt,
         };
         blocksArchiveCommand.SetHandler(
-            (FileInfo fi, ArchiveTool.OutputFormat f) => Task.FromResult(ArchiveTool.HandleBlocks(fi, f)),
+            (FileInfo fi, ArchiveTool.OutputFormat f) => Task.FromResult(ArchiveTool.ListBlocks(fi, f)),
             pathArg, fOpt);
 
         var infoArchiveCommand = new Command("info", "Display a high-level summary of a Unity Archive file.")
@@ -263,7 +263,7 @@ static Command BuildArchiveCommand()
             fOpt,
         };
         infoArchiveCommand.SetHandler(
-            (FileInfo fi, ArchiveTool.OutputFormat f) => Task.FromResult(ArchiveTool.HandleInfo(fi, f)),
+            (FileInfo fi, ArchiveTool.OutputFormat f) => Task.FromResult(ArchiveTool.PrintSummary(fi, f)),
             pathArg, fOpt);
 
         return new Command("archive", "Inspect or extract the contents of a Unity archive (AssetBundle or web platform .data file).")
@@ -287,7 +287,7 @@ static Command BuildSerializedFileCommand()
             fOpt,
         };
         externalRefsCommand.SetHandler(
-            (FileInfo fi, SerializedFileTool.OutputFormat f) => Task.FromResult(SerializedFileTool.HandleExternalRefs(fi, f)),
+            (FileInfo fi, SerializedFileTool.OutputFormat f) => Task.FromResult(SerializedFileTool.ListExternalRefs(fi, f)),
             pathArg, fOpt);
 
         var objectListCommand = new Command("objectlist", "List all objects in a SerializedFile.")
@@ -296,7 +296,7 @@ static Command BuildSerializedFileCommand()
             fOpt,
         };
         objectListCommand.SetHandler(
-            (FileInfo fi, SerializedFileTool.OutputFormat f) => Task.FromResult(SerializedFileTool.HandleObjectList(fi, f)),
+            (FileInfo fi, SerializedFileTool.OutputFormat f) => Task.FromResult(SerializedFileTool.ListObjects(fi, f)),
             pathArg, fOpt);
 
         var headerCommand = new Command("header", "Show SerializedFile header information.")
@@ -305,7 +305,7 @@ static Command BuildSerializedFileCommand()
             fOpt,
         };
         headerCommand.SetHandler(
-            (FileInfo fi, SerializedFileTool.OutputFormat f) => Task.FromResult(SerializedFileTool.HandleHeader(fi, f)),
+            (FileInfo fi, SerializedFileTool.OutputFormat f) => Task.FromResult(SerializedFileTool.PrintHeader(fi, f)),
             pathArg, fOpt);
 
         var metadataCommand = new Command("metadata", "Show information from the metadata section of the SerializedFile (use `-f Json` for detailed information).")
@@ -314,7 +314,7 @@ static Command BuildSerializedFileCommand()
             fOpt,
         };
         metadataCommand.SetHandler(
-            (FileInfo fi, SerializedFileTool.OutputFormat f) => Task.FromResult(SerializedFileTool.HandleMetadata(fi, f)),
+            (FileInfo fi, SerializedFileTool.OutputFormat f) => Task.FromResult(SerializedFileTool.PrintMetadata(fi, f)),
             pathArg, fOpt);
 
         var serializedFileCommand = new Command("serialized-file", "Inspect a SerializedFile (scene, assets, etc.).")