[chore][command] implements show-index for reading index easily

xgit/cli.py

@@ -1,6 +1,6 @@
 import typer
 
-from xgit.commands import init, cat_file, ls_files, hash_object
+from xgit.commands import init, cat_file, ls_files, show_index, hash_object
 
 app = typer.Typer(add_completion=False, rich_markup_mode="markdown")
 
@@ -9,6 +9,7 @@
 app.command()(init.init)
 app.command()(cat_file.cat_file)
 app.command()(ls_files.ls_files)
+app.command(hidden=True)(show_index.show_index)
 
 
 def main():

xgit/commands/show_index.py

@@ -0,0 +1,12 @@
+from rich.pretty import pprint
+
+from xgit.types.index import get_index
+
+
+def show_index():
+    """
+    以可读的方式输出 index。
+    这并非 git 本身支持的功能，只是为了方便调试和展示结果。
+    """
+    index = get_index()
+    pprint(index)

xgit/types/index.py

@@ -59,6 +59,12 @@ def to_bytes(self) -> bytes:
             data |= self.name_length
             return data.to_bytes(2, "big")
 
+        def __rich_repr__(self):
+            yield "assume_valid", self.assume_valid
+            yield "extended", self.extended
+            yield "stage", self.stage
+            yield "name_length", self.name_length
+
     ctime_s: int
     ctime_ns: int
     mtime_s: int
@@ -186,6 +192,22 @@ def to_bytes(self) -> bytes:
 
         return entry
 
+    def __rich_repr__(self):
+        yield "ctime_s", self.ctime_s
+        yield "ctime_ns", self.ctime_ns
+        yield "mtime_s", self.mtime_s
+        yield "mtime_ns", self.mtime_ns
+        yield "dev", self.dev
+        yield "inode", self.inode
+        yield "mode", self.mode
+        yield "uid", self.uid
+        yield "gid", self.gid
+        yield "file_size", self.file_size
+        yield "sha", self.sha
+        yield "flags", self.flags
+        yield "extended_flags", self.extended_flags
+        yield "file_name", self.file_name
+
 
 class Index:
     version: int
@@ -217,6 +239,12 @@ def to_bytes(self) -> bytes:
         index += hashlib.sha1(index).digest()
         return index
 
+    def __rich_repr__(self):
+        yield "version", self.version
+        yield "entry_count", self.entry_count
+        yield "entries", self.entries
+        yield "extensions", self.extensions
+
 
 def get_index() -> Index:
     index_path = find_repo() / GIT_DIR / "index"