main.go:10-12: The path should be passed in as a command...

go-gitlint

Lint your git!

Usage

$ ./gitlint --help
usage: gitlint [<flags>]

Flags:
  --help                       Show context-sensitive help (also try --help-long and --help-man).
  --path="."                   Path to the git repo (default: ".").
  --subject-regex=".*"         Commit subject line must conform to this regular expression (default: ".*").
  --subject-maxlen=2147483646  Max length for commit subject line (default: math.MaxInt32 - 1).
  --subject-minlen=0           Min length for commit subject line (default: 0).
  --body-regex=".*"            Commit message body must conform to this regular expression (default: ".*").
  --body-maxlen=2147483646     Max length for commit body (default: math.MaxInt32 - 1)
  --since="1970-01-01"         A date in "yyyy-MM-dd" format starting from which commits will be analyzed (default: "1970-01-01").
  --msg-file=""                Only analyze the commit message found in this file (default: "").
  --max-parents=1              Max number of parents a commit can have in order to be analyzed (default: 1). Useful for excluding merge commits.
  --excl-author-names="$a"     Don't lint commits with authors whose names match these comma-separated regular expressions (default: '$a').
  --excl-author-emails="$a"    Don't lint commits with authors whose emails match these comma-separated regular expressions (default: '$a').

Additionally, it will look for configurations in a file .gitlint in the current directory if it exists. This file's format is just the same command line flags but each on a separate line. Flags passed through the command line take precedence.

Integration

With Git

Lint your commit message when committing to your local branch.

Add a commit-msg hook to your Git repo:

Create hook: echo 'gitlint --msg-file=$1' > .git/hooks/commit-msg
Make it executable: chmod +x .git/hooks/commit-msg

Now your commits will be validated after saving and closing the commit message in your text editor.

With GitHub Actions

To integrate it as GitHub action into CI pipeline use gitlint-action.

With any CI pipeline

Use download-gitlint.sh:

curl https://raw.githubusercontent.com/llorllale/go-gitlint/master/download-gitlint.sh > download-gitlint.sh
chmod +x download-gitlint.sh

Usage:

$ ./download-gitlint.sh -h
./download-gitlint.sh: download go binaries for llorllale/go-gitlint

Usage: ./download-gitlint.sh [-b] bindir [-d] [tag]
  -b sets bindir or installation directory, Defaults to ./bin
  -d turns on debug logging
   [tag] is a tag from
   https://github.com/llorllale/go-gitlint/releases
   If tag is missing, then the latest will be used.

 Generated by godownloader
  https://github.com/goreleaser/godownloader

Exit codes

gitlint's exit code will equal the number of issues found with your commit(s).

Motivation

Validate format of commit message subject and body
Lint commit msgs on varios development platforms (Windows, Linux, Mac)
Configuration from file with cli args taking precedence
commit-msg hook to validate my commit's msg
Performance (because a slow pre-commit hook would render the git workflow unmanageable)
My first Go project :)

Contributing

Fork this repo, make sure make checks works, and then open a PR.

Build dependencies

To run make checks you will need Go 1.16.x and Ruby 2.x (for pdd - see below). Ruby Version Manager is highly recommended.

The make dependencies recipe attempts to download and install the following:

	// @todo #31 Function issues.Filters() can be removed by providing
	// default values for each filter that will effectively render them
	// disabled. For example, OfSubjectRegex() can be effectively disabled
	// by using ".*" as regex.

	// @todo #9 Global variables are a code smell (especially those in filterse.go).
	// They promote coupling across different components inside the same package.
	// Figure out a way to remove these global variables. Whatever command line
	// parser we choose should be able to auto-generate usage.

	// @todo #4 Figure out how to disable the golint check that
	// forces us to write redundant comments of the form
	// 'comment on exported type Commits should be of the form
	// "Commits ..." (with optional leading article)' and rewrite
	// all comments.

	# @todo #1 Enable this configuration after this golangci-lint issue is
	# fixed: https://github.com/golangci/golangci-lint/issues/397. According
	# to the golangci-lint docs, this config is desirable since the CI build
	# should not be required to update go.mod.

	// @todo #4 The path should be passed in as a command line
	// flag instead of being hard coded. All other configuration
	// options should be passed in through CLI as well.

	// @todo #4 Figure out how to split the commit's message into a subject
	// and a body. I believe the separator is the first instance of the
	// CRLFCRLF sequence.

	# @todo #16 The coverage script is ignoring packages that are not tested
	# at all (0% coverage). It should be fixed so that all packages are
	# tested (except for main).

	# @todo #53 upgrade golangci-lint-version to 1.18.x once their docker image is ready
	# - see https://github.com/golangci/golangci-lint/issues/682. For now, linting on
	# local is against 1.18.x vs their service on 1.17.x.

	// @todo #4 These err checks are extremely annoying. Figure out
	// how to handle them elegantly and reduce the cyclo complexity
	// of this function (currently at 4).

llorllale / go-gitlint Goto Github PK

go-gitlint's Introduction

go-gitlint

Usage

Integration

With Git

With GitHub Actions

With any CI pipeline

Exit codes

Motivation

Contributing

Build dependencies

go-gitlint's People

Contributors

Stargazers

Watchers

Forkers

go-gitlint's Issues

Recommend Projects

Recommend Topics

Recommend Org