Add --style option to allow different graphical styles

Signed-off-by: Jacob Stopak <jacob@initialcommit.io>

Author: initialcommit-io

README.md

@@ -150,7 +150,8 @@ The `[global options]` apply to the overarching `git-sim` simulation itself, inc
 `--stdout`: Write raw image data to stdout while suppressing all other program output.  
 `--output-only-path`: Only output the path to the generated media file to stdout. Useful for other programs to ingest.  
 `--quiet, -q`: Suppress all output except errors.  
-`--highlight-commit-messages`: Make commit message text bigger and bold, and hide commit ids.
+`--highlight-commit-messages`: Make commit message text bigger and bold, and hide commit ids.  
+`--style`: Graphical style of the output image or animated video, i.e. `clean` (default) or `thick`.
 
 Animation-only global options (to be used in conjunction with `--animate`):
 

git_sim/__main__.py

@@ -7,7 +7,7 @@
 import typer
 
 import git_sim.commands
-from git_sim.settings import ColorByOptions, ImgFormat, VideoFormat, settings
+from git_sim.settings import ColorByOptions, StyleOptions, ImgFormat, VideoFormat, settings
 
 app = typer.Typer(context_settings={"help_option_names": ["-h", "--help"]})
 
@@ -144,9 +144,13 @@ def main(
         False,
         "--version",
         "-v",
-        help="Show the version of git-sim and exit.",
+        help="Show the version of git-sim and exit",
         callback=version_callback,
     ),
+    style: StyleOptions = typer.Option(
+        settings.style.value,
+        help="Graphical style of the output image or animated video",
+    ),
 ):
     import git
     from manim import WHITE, config
@@ -178,6 +182,7 @@ def main(
     settings.all = all
     settings.color_by = color_by
     settings.highlight_commit_messages = highlight_commit_messages
+    settings.style = style
 
     try:
         if sys.platform == "linux" or sys.platform == "darwin":

git_sim/enums.py

@@ -21,6 +21,11 @@ class ColorByOptions(Enum):
     notlocal2 = "notlocal2"
 
 
+class StyleOptions(Enum):
+    CLEAN = "clean"
+    THICK = "thick"
+
+
 class VideoFormat(str, Enum):
     mp4 = "mp4"
     webm = "webm"

git_sim/git_sim_base_command.py

@@ -11,7 +11,7 @@
 from git.exc import GitCommandError, InvalidGitRepositoryError
 from git.repo import Repo
 
-from git_sim.enums import ColorByOptions
+from git_sim.enums import ColorByOptions, StyleOptions
 from git_sim.settings import settings
 
 
@@ -62,6 +62,17 @@ def __init__(self):
             self.fill_opacity = 0.5
             self.ref_fill_opacity = 1.0
 
+        if settings.style == StyleOptions.CLEAN:
+            self.commit_stroke_width = 5
+            self.arrow_stroke_width = 5
+            self.arrow_tip_shape = m.ArrowTriangleFilledTip
+            self.font_weight = m.NORMAL
+        elif settings.style == StyleOptions.THICK:
+            self.commit_stroke_width = 30
+            self.arrow_stroke_width = 10
+            self.arrow_tip_shape = m.StealthTip
+            self.font_weight = m.BOLD
+            
     def init_repo(self):
         try:
             self.repo = Repo(search_parent_directories=True)
@@ -243,6 +254,7 @@ def draw_commit(self, commit, i, prevCircle, shift=numpy.array([0.0, 0.0, 0.0]))
 
         circle = m.Circle(
             stroke_color=commit_fill,
+            stroke_width=self.commit_stroke_width,
             fill_color=commit_fill,
             fill_opacity=self.fill_opacity,
         )
@@ -280,7 +292,7 @@ def draw_commit(self, commit, i, prevCircle, shift=numpy.array([0.0, 0.0, 0.0]))
             )
             end = self.drawnCommits[commit.hexsha].get_center()
 
-        arrow = m.Arrow(start, end, color=self.fontColor)
+        arrow = m.Arrow(start, end, color=self.fontColor, stroke_width=self.arrow_stroke_width, tip_shape=self.arrow_tip_shape, max_stroke_width_to_length_ratio=1000)
 
         if commit == "dark":
             arrow = m.Arrow(
@@ -299,7 +311,7 @@ def draw_commit(self, commit, i, prevCircle, shift=numpy.array([0.0, 0.0, 0.0]))
         for commitCircle in self.drawnCommits.values():
             inter = m.Intersection(lineRect, commitCircle)
             if inter.has_points():
-                arrow = m.CurvedArrow(start, end, color=self.fontColor)
+                arrow = m.CurvedArrow(start, end, color=self.fontColor, stroke_width=self.arrow_stroke_width, tip_shape=self.arrow_tip_shape)
                 if start[1] == end[1]:
                     arrow.shift(m.UP * 1.25)
                 if start[0] < end[0] and start[1] == end[1]:
@@ -320,7 +332,7 @@ def draw_commit(self, commit, i, prevCircle, shift=numpy.array([0.0, 0.0, 0.0]))
             font="Monospace",
             font_size=20 if settings.highlight_commit_messages else 14,
             color=self.fontColor,
-            weight=m.BOLD if settings.highlight_commit_messages else m.NORMAL,
+            weight=m.BOLD if settings.highlight_commit_messages or settings.style == StyleOptions.THICK else m.NORMAL,
         ).next_to(circle, m.DOWN)
 
         if settings.animate and commit != "dark" and isNewCommit:
@@ -373,14 +385,15 @@ def get_nonparent_branch_names(self):
     def build_commit_id_and_message(self, commit, i):
         hide_refs = False
         if commit == "dark":
-            commitId = m.Text("", font="Monospace", font_size=20, color=self.fontColor)
+            commitId = m.Text("", font="Monospace", font_size=20, color=self.fontColor, weight=self.font_weight)
             commitMessage = ""
         else:
             commitId = m.Text(
                 commit.hexsha[0:6],
                 font="Monospace",
                 font_size=20,
                 color=self.fontColor,
+                weight=self.font_weight,
             )
             commitMessage = commit.message.split("\n")[0][:40].replace("\n", " ")
         return commitId, commitMessage, commit, hide_refs
@@ -397,7 +410,7 @@ def draw_head(self, commit, i, commitId):
             else:
                 headbox.next_to(commitId, m.UP)
             headText = m.Text(
-                "HEAD", font="Monospace", font_size=20, color=self.fontColor
+                "HEAD", font="Monospace", font_size=20, color=self.fontColor, weight=self.font_weight,
             ).move_to(headbox.get_center())
 
             head = m.VGroup(headbox, headText)
@@ -444,7 +457,7 @@ def draw_branch(self, commit, i, make_branches_remote=False):
                 )
 
                 branchText = m.Text(
-                    text, font="Monospace", font_size=20, color=self.fontColor
+                    text, font="Monospace", font_size=20, color=self.fontColor, weight=self.font_weight,
                 )
                 branchRec = m.Rectangle(
                     color=m.GREEN,
@@ -490,6 +503,7 @@ def draw_tag(self, commit, i):
                         font="Monospace",
                         font_size=20,
                         color=self.fontColor,
+                        weight=self.font_weight,
                     )
                     tagRec = m.Rectangle(
                         color=m.YELLOW,
@@ -653,6 +667,7 @@ def setup_and_draw_zones(
                 font="Monospace",
                 font_size=28,
                 color=self.fontColor,
+                weight=m.BOLD,
             )
             .move_to((vert1.get_center()[0] - 4, 0, 0))
             .shift(m.UP * self.zone_title_offset)
@@ -663,6 +678,7 @@ def setup_and_draw_zones(
                 font="Monospace",
                 font_size=28,
                 color=self.fontColor,
+                weight=m.BOLD,
             )
             .move_to(self.camera.frame.get_center())
             .align_to(firstColumnTitle, m.UP)
@@ -673,6 +689,7 @@ def setup_and_draw_zones(
                 font="Monospace",
                 font_size=28,
                 color=self.fontColor,
+                weight=m.BOLD,
             )
             .move_to((vert2.get_center()[0] + 4, 0, 0))
             .align_to(firstColumnTitle, m.UP)
@@ -985,7 +1002,7 @@ def setup_and_draw_parent(
         color=m.RED,
     ):
         circle = m.Circle(
-            stroke_color=color, fill_color=color, fill_opacity=self.ref_fill_opacity
+            stroke_color=color, stroke_width=self.commit_stroke_width, fill_color=color, fill_opacity=self.ref_fill_opacity
         )
         circle.height = 1
         circle.next_to(
@@ -997,12 +1014,12 @@ def setup_and_draw_parent(
 
         start = circle.get_center()
         end = self.drawnCommits[child.hexsha].get_center()
-        arrow = m.Arrow(start, end, color=self.fontColor)
+        arrow = m.Arrow(start, end, color=self.fontColor, stroke_width=self.arrow_stroke_width, tip_shape=self.arrow_tip_shape, max_stroke_width_to_length_ratio=1000)
         length = numpy.linalg.norm(start - end) - (1.5 if start[1] == end[1] else 3)
         arrow.set_length(length)
 
         commitId = m.Text(
-            "abcdef", font="Monospace", font_size=20, color=self.fontColor
+            "abcdef", font="Monospace", font_size=20, color=self.fontColor, weight=self.font_weight,
         ).next_to(circle, m.UP)
         self.toFadeOut.add(commitId)
 
@@ -1014,6 +1031,7 @@ def setup_and_draw_parent(
             font="Monospace",
             font_size=14,
             color=self.fontColor,
+            weight=self.font_weight,
         ).next_to(circle, m.DOWN)
         self.toFadeOut.add(message)
 
@@ -1061,7 +1079,7 @@ def get_nondark_commits(self):
         return nondark_commits
 
     def draw_ref(self, commit, top, i=0, text="HEAD", color=m.BLUE):
-        refText = m.Text(text, font="Monospace", font_size=20, color=self.fontColor)
+        refText = m.Text(text, font="Monospace", font_size=20, color=self.fontColor, weight=self.font_weight)
         refbox = m.Rectangle(
             color=color,
             fill_color=color,
@@ -1196,6 +1214,7 @@ def color_by(self, offset=0):
                     font="Monospace",
                     font_size=36,
                     color=self.colors[int(i % 11)],
+                    weight=self.font_weight,
                 )
                 authorText.move_to(
                     [(-5 - offset) if settings.reverse else (5 + offset), -i, 0]

git_sim/merge.py

@@ -83,7 +83,7 @@ def construct(self):
                 if head_commit.hexsha in self.drawnCommits:
                     start = self.drawnCommits["abcdef"].get_center()
                     end = self.drawnCommits[head_commit.hexsha].get_center()
-                    arrow = m.CurvedArrow(start, end, color=self.fontColor)
+                    arrow = m.CurvedArrow(start, end, color=self.fontColor, stroke_width=self.arrow_stroke_width, tip_shape=self.arrow_tip_shape)
                     self.draw_arrow(True, arrow)
 
                 reset_head_to = "abcdef"
@@ -152,7 +152,10 @@ def construct(self):
         self.repo.git.clear_cache()
 
         # Delete the local clone
-        shutil.rmtree(new_dir, onerror=self.del_rw)
+        try:
+            shutil.rmtree(new_dir, onerror=self.del_rw)
+        except (FileNotFoundError, UnboundLocalError):
+            pass
 
     def check_merge_conflict(self, branch1, branch2):
         git_root = self.repo.git.rev_parse("--show-toplevel")

git_sim/rebase.py

@@ -111,7 +111,7 @@ def setup_and_draw_parent(
         shift=numpy.array([0.0, 0.0, 0.0]),
         draw_arrow=True,
     ):
-        circle = m.Circle(stroke_color=m.RED, fill_color=m.RED, fill_opacity=0.25)
+        circle = m.Circle(stroke_color=m.RED, stroke_width=self.commit_stroke_width, fill_color=m.RED, fill_opacity=0.25)
         circle.height = 1
         circle.next_to(
             self.drawnCommits[child],
@@ -122,7 +122,7 @@ def setup_and_draw_parent(
 
         start = circle.get_center()
         end = self.drawnCommits[child].get_center()
-        arrow = m.Arrow(start, end, color=self.fontColor)
+        arrow = m.Arrow(start, end, color=self.fontColor, stroke_width=self.arrow_stroke_width, tip_shape=self.arrow_tip_shape, max_stroke_width_to_length_ratio=1000)
         length = numpy.linalg.norm(start - end) - (1.5 if start[1] == end[1] else 3)
         arrow.set_length(length)
 

git_sim/revert.py

@@ -91,7 +91,7 @@ def build_commit_id_and_message(self, commit, i):
         return commitId, commitMessage, commit, hide_refs
 
     def setup_and_draw_revert_commit(self):
-        circle = m.Circle(stroke_color=m.RED, fill_color=m.RED, fill_opacity=0.25)
+        circle = m.Circle(stroke_color=m.RED, stroke_width=self.commit_stroke_width, fill_color=m.RED, fill_opacity=0.25)
         circle.height = 1
         circle.next_to(
             self.drawnCommits[self.get_commit().hexsha],
@@ -101,7 +101,7 @@ def setup_and_draw_revert_commit(self):
 
         start = circle.get_center()
         end = self.drawnCommits[self.get_commit().hexsha].get_center()
-        arrow = m.Arrow(start, end, color=self.fontColor)
+        arrow = m.Arrow(start, end, color=self.fontColor, stroke_width=self.arrow_stroke_width, tip_shape=self.arrow_tip_shape, max_stroke_width_to_length_ratio=1000)
         length = numpy.linalg.norm(start - end) - (1.5 if start[1] == end[1] else 3)
         arrow.set_length(length)
 

git_sim/settings.py

@@ -3,7 +3,7 @@
 
 from pydantic import BaseSettings
 
-from git_sim.enums import ColorByOptions, ImgFormat, VideoFormat
+from git_sim.enums import StyleOptions, ColorByOptions, ImgFormat, VideoFormat
 
 
 class Settings(BaseSettings):
@@ -39,6 +39,7 @@ class Settings(BaseSettings):
     all = False
     color_by: Union[ColorByOptions, None] = None
     highlight_commit_messages = False
+    style: Union[StyleOptions, None] = StyleOptions.CLEAN
 
     class Config:
         env_prefix = "git_sim_"