EmEditor Home - EmEditor Help - How to - Plug-ins
To Use CommitList Plug-in
The CommitList plug-in is installed by default with EmEditor Professional. This plug-in shows the current changes and the commit history of a Git repo. To use the CommitList plug-in, click 
on the Plug-ins bar. Or in the Tools menu, point to Plug-ins, and then click CommitList.
Some features of CommitList require Git to be installed and callable from command prompt with the command git.
Changes sidebar
The plug-in will first check if the current document is in a Git repo. If it is, the repo will be opened and its repo status will be shown. You can click on the Open... button in the sidebar to open a different repo.
Current changes and staged changes are shown in the sidebar. Staged changes are changes that were added to the index. All other changes to the working directory are shown in the changes list.
Right-clicking on a changed file in the sidebar will show a menu with commands for that changed file. You can Stage or Unstage the change. You can Undo Changes to revert the file to the previous state. You can also View Changes and Open File in the editor. Clicking on Refresh will refresh the changed files list.
CommitList monitors the file system so that if a file in the repo directory was modified by an external program, the sidebar is refreshed.
The Pull button pulls changes from the remote to the local repo. Push sends local changes to the remote repo. If the current branch is not associated with an upstream branch, the upstream branch will be created before pushing changes to it. These commands print a message to the status bar on completion.
You can click on the > button to access more commands. The Fetch command updates your remote-tracking branches. The Status command prints the output of git status.
You can change the current branch with the dropdown menu. Changing the branch is equivalent to the command git checkout branch. Conflicting changes will prevent you from checking out a branch.
The edit control below the branch dropdown is where you can write a commit message. Click on Commit Staged/Commit All to either commit the staged changes or to stage all changes and commit. The commit will be made to the currently selected branch.
Commit list
Click on the Commit List button to view the commit history. When a commit is selected, the right panel displays the commit details and the list of files changed on this commit. Right-click on a file in the list and select Compare with Previous to see what changed to the file on this commit.
In the commit list, you can right-click on a commit and select Copy to copy the commit details. Browse Files At Commit will show the directory tree when the commit was made. And Compare Commits will show you the differences between two commits.
You can checkout the commit with Checkout (--detach), which creates a detached HEAD. If you want to create a new branch from the commit, select Create New Branch....
You can filter the list by clicking on Filter History . Enter the Filter String, select a Filter By option, then click Filter. The commit list now only shows commits that match the filter. The X button next to the Filter History button cancels the filter.
The left panel shows a list of branches in the repo. Select View Branch to show the list of commits for that branch. You can Checkout Branch to switch to the branch, Create New Branch from the selected branch, or Delete Branch. When two branches are selected, you can compare the files between those branches with Compare Branches.
If a file that is in the current repo is opened in the editor, the View History For Current Document button can be selected. It lists any commits that include changes to the current file. Right-clicking on a commit will show four options. Show Commit jumps to that commit in the main commit list. Compare with Previous compares the file with its previous revision. Compare File at Commits compares the file at two different commits. Compare with File in Working Tree compares the file at the selected commit and the work tree version.
Tips
•Press the F6 key or ESC key to set the keyboard focus back to the editor.
Copyright © 2003-2023 by Emurasoft, Inc.
