README
¶
Lazy Commit
Be lazy and just commit
Description
This provides the git lzc command. This command can be used
in situations where you don't really care about choosing which
changes to track or writing your commit message -- you just want to
commit your work.
By its nature, git lzc can very easily add accidental changes
to the git history if the user isn't careful. So, while this
tool may be appealing to git beginners, its target audience is
actually experienced git users who know when they want to break
the rules for creating good commits.
Staged Changes
If you have staged changes (git add path/to/file), then
git lzc will commit those staged changes. If you do not
have any staged changes, then git lzc will commit all changes,
including untracked files (so be careful!).
Commit Messages
git lzc will write your commit message for you. If you've changed
a single file, the commit message will look like this:
Update www/index.html
If you've changed multiple files that share a similar directory, your commit message will look like this:
Update public/
- Update public/favicon.ico
- Create public/icons/favicon-16x16.png
- Create public/icons/favicon-32x32.png
If there aren't any similar directories that all changes share, or at least one of the updated files is in the root of the repository, your commit message will look like this:
Update files
- Update views.py
- Update templates/myapp/index.html
Installation
Download the appropriate executable from the release assets,
rename it to git-lzc, and add it to a location in PATH.
Documentation
¶
Overview ¶
Package lazycommit mostly provides wrappers around go-git to make it easier for "lazy" usage.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Repo ¶ added in v0.2.0
type Repo string
Repo is a path to a git repository. Used to call the "git" command on the repository.
func (Repo) Commit ¶ added in v0.2.0
Commit commits all changes in the repository.
It returns the output of the commit command.
func (Repo) CommitMsg ¶ added in v0.2.0
CommitMsg builds a commit message using the tracked files in the repository.
func (Repo) NoStaged ¶ added in v0.2.0
NoStaged checks if there are no staged changes (added files, changed files, removed files) in the repository.
func (Repo) Status ¶ added in v0.2.0
func (repo Repo) Status() ([]StatusRecord, error)
Status gets and parses the repo's status.
type StatusRecord ¶ added in v0.2.0
type StatusRecord struct {
// Staged is the staged status of the file.
Staged rune
// Unstaged is the unstaged status of the file.
Unstaged rune
// Path is the path to the file.
Path string
// Src is the original path for a rename or copy.
Src string
}
StatusRecord represents a single status record from "git status".
func (StatusRecord) Message ¶ added in v0.2.0
func (s StatusRecord) Message() string
Message returns a human-readable message usable for a commit message.
Source Files
Directories