Wolfram Function Repository
Instant-use add-on functions for the Wolfram Language
Function Repository Resource:
ShowGit
Display the status of a git repository
Contributed by:
Michael Sollami
ResourceFunction["ShowGitStatus"][] returns the status of the git repository in the working Directory[]. | |
ResourceFunction["ShowGitStatus"][dir] returns the status of the git repository located in the given directory dir. |
Details and Options
Assuming a valid git repo is found, ResourceFunction["ShowGitStatus"] returns one of four string values: "Untracked files present", "Unstaged changes", "Unpushed commits", "Working directory clean".
ResourceFunction["ShowGitStatus"] accepts the following options:
| Appearance | "Styled" | the format of the output |
| "GitPath" | Automatic | the location of the git executable |
The possible values for Appearance are:
| "String" | an unstyled string indicating status |
| "Styled" | a status string with additional font coloring to indicate status |
| "Tooltip" | a colored icon with the status in a tooltip |
When "GitPath" is Automatic, ResourceFunction["ShowGitStatus"] uses platform-dependent system commands to find git executables:
| Linux | which | system installed git |
| MacOS | which | git installed with brew |
| Windows | where | system installed git |
If the path to the git executable cannot be determined automatically, the absolute path should be provided to the option "GitPath"
Examples
Basic Examples (2)
Check if a directory is a git repo:
| In[1]:= |
![SetDirectory["~/Documents/rd"];
ResourceFunction["ShowGitStatus"][]](https://www.wolframcloud.com/obj/resourcesystem/images/97f/97f65e5f-36f6-4853-b4fb-555e7cda782f/15b3f0f73db0d6e9.png){kind=small}
|
| Out[2]= |
|
Visualize the git status of any path:
| In[3]:= |
![ResourceFunction["ShowGitStatus"]["~/Downloads/rd"]](https://www.wolframcloud.com/obj/resourcesystem/images/97f/97f65e5f-36f6-4853-b4fb-555e7cda782f/3cdfa3ed0ae612b4.png){kind=small}
|
| Out[3]= |
|
| In[4]:= |
![ResourceFunction["ShowGitStatus"]["~/Documents/dsblog"]](https://www.wolframcloud.com/obj/resourcesystem/images/97f/97f65e5f-36f6-4853-b4fb-555e7cda782f/024478232af9d0eb.png){kind=small}
|
| Out[4]= |
|
| In[5]:= |
![ResourceFunction["ShowGitStatus"]["~/repos/torch"]](https://www.wolframcloud.com/obj/resourcesystem/images/97f/97f65e5f-36f6-4853-b4fb-555e7cda782f/2ae899cf821c2262.png){kind=small}
|
| Out[5]= |
|
Options (1)
Change the appearance of the returned status:
| In[6]:= |
![ResourceFunction["ShowGitStatus"]["~/Downloads/rd", Appearance -> #] & /@ {"Tooltip", "StyledString", "String"}](https://www.wolframcloud.com/obj/resourcesystem/images/97f/97f65e5f-36f6-4853-b4fb-555e7cda782f/6344e338d9c0ec9c.png){kind=small}
|
| Out[6]= |
|
Publisher
Related Links
Version History
- 1.0.0 – 08 February 2021
Related Resources
Related Symbols
License Information
This work is licensed under a Creative Commons Attribution 4.0 International License