Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 1.85 KB

architecture.md

File metadata and controls

51 lines (38 loc) · 1.85 KB
Raw

Architecture of the Git Town code base

Source code

Git Town is written in Go. The source code is located in the src folder.

CLI wrapper

Git Town uses the Cobra CLI framework. src/cmd contains the commands that Git Town understands.

Steps

See the step list documentation

Utility code

The other folders in src are utility methods used by the commands and steps:

  • src/browsers provides code to open a browser window with a given URL
  • src/cfmt contains helpers to print colored text in the terminal
  • src/command contains a helper to run external tools like Git in a subshell and capture their output
  • src/drivers contains the driver infrastructure for the APIs of various code hosting services that Git Town supports
  • src/dryrun contains code that allows to run commands that only print but don't execute their steps
  • src/git contains code to run various Git commands and parse their output intelligently
  • src/prompt contains the code to interactively ask the user for information via the command line
  • src/script contains high-level, Git-Town specific helpers
  • src/util contains a variety of other low-level helper methods

State files

When a Git Town command finishes, a list of the steps to undo the command as well as optionally any remaining steps to be run (in case the command encountered conflicts) are stored in a state files in a temp folder on the machine. The struct that holds the state is in src/steps/run_state.go.

Tests

The test architecture is described separately.