Skip to content

Commit 724a1f9

Browse files
committed
Add links to home pages for third-party tools
This makes it easier for relevant documentation for these tools to be discovered. Closes sds#210
1 parent c5264c5 commit 724a1f9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+94
-2
lines changed

lib/overcommit/hook/commit_msg/gerrit_change_id.rb

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ module Overcommit::Hook::CommitMsg
55
# the reality is that if you want to _ensure_ the Change-Id is included then
66
# you need to do it in a commit-msg hook. This is because the user could still
77
# edit the message after a prepare-commit-msg hook was run.
8+
#
9+
# @see https://code.google.com/p/gerrit/
810
class GerritChangeId < Base
911
SCRIPT_LOCATION = Overcommit::Utils.script_path('gerrit-change-id')
1012

lib/overcommit/hook/commit_msg/spell_check.rb

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
require 'tempfile'
22

33
module Overcommit::Hook::CommitMsg
4-
# Checks the commit message for potential misspellings
4+
# Checks the commit message for potential misspellings with `hunspell`.
5+
#
6+
# @see http://hunspell.sourceforge.net/
57
class SpellCheck < Base
68
Misspelling = Struct.new(:word, :suggestions)
79

lib/overcommit/hook/post_checkout/index_tags.rb

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
module Overcommit::Hook::PostCheckout
44
# Updates ctags index for all source code in the repository.
5+
#
6+
# @see {Overcommit::Hook::Shared::IndexTags}
57
class IndexTags < Base
68
include Overcommit::Hook::Shared::IndexTags
79
end

lib/overcommit/hook/post_commit/git_guilt.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PostCommit
22
# Calculates the change in blame since the last revision.
3+
#
4+
# @see https://www.npmjs.com/package/git-guilt
35
class GitGuilt < Base
46
PLUS_MINUS_REGEX = /^(.*?)(?:(\++)|(-+))$/
57
GREEN = 32

lib/overcommit/hook/post_commit/index_tags.rb

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
module Overcommit::Hook::PostCommit
44
# Updates ctags index for all source code in the repository.
5+
#
6+
# @see {Overcommit::Hook::Shared::IndexTags}
57
class IndexTags < Base
68
include Overcommit::Hook::Shared::IndexTags
79
end

lib/overcommit/hook/post_merge/index_tags.rb

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
module Overcommit::Hook::PostMerge
44
# Updates ctags index for all source code in the repository.
5+
#
6+
# @see {Overcommit::Hook::Shared::IndexTags}
57
class IndexTags < Base
68
include Overcommit::Hook::Shared::IndexTags
79
end

lib/overcommit/hook/post_rewrite/index_tags.rb

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
module Overcommit::Hook::PostRewrite
44
# Updates ctags index for all source code in the repository.
5+
#
6+
# @see {Overcommit::Hook::Shared::IndexTags}
57
class IndexTags < Base
68
include Overcommit::Hook::Shared::IndexTags
79

lib/overcommit/hook/pre_commit/berksfile_check.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
module Overcommit::Hook::PreCommit
22
# Check if local Berksfile.lock matches Berksfile when either changes, unless
33
# Berksfile.lock is ignored by git.
4+
#
5+
# @see http://berkshelf.com/
46
class BerksfileCheck < Base
57
LOCK_FILE = 'Berksfile.lock'
68

lib/overcommit/hook/pre_commit/brakeman.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `brakeman` against any modified Ruby/Rails files.
3+
#
4+
# @see http://brakemanscanner.org/
35
class Brakeman < Base
46
def run
57
result = execute(command + [applicable_files.join(',')])

lib/overcommit/hook/pre_commit/bundle_check.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
module Overcommit::Hook::PreCommit
22
# Check if local Gemfile.lock matches Gemfile when either changes, unless
33
# Gemfile.lock is ignored by git.
4+
#
5+
# @see http://bundler.io/
46
class BundleCheck < Base
57
LOCK_FILE = 'Gemfile.lock'
68

lib/overcommit/hook/pre_commit/chamber_security.rb

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
2-
# Runs `chamber secure` against any modified Chamber settings files
2+
# Runs `chamber secure` against any modified Chamber settings files.
3+
#
4+
# @see https://github.com/thekompanee/chamber
35
class ChamberSecurity < Base
46
def run
57
result = execute(command + applicable_files)

lib/overcommit/hook/pre_commit/coffee_lint.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `coffeelint` against any modified CoffeeScript files.
3+
#
4+
# @see http://www.coffeelint.org/
35
class CoffeeLint < Base
46
def run
57
result = execute(command + applicable_files)

lib/overcommit/hook/pre_commit/css_lint.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `csslint` against any modified CSS files.
3+
#
4+
# @see https://github.com/CSSLint/csslint
35
class CssLint < Base
46
MESSAGE_REGEX = /
57
^(?<file>[^:]+):\s

lib/overcommit/hook/pre_commit/es_lint.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `eslint` against any modified JavaScript files.
3+
#
4+
# @see http://eslint.org/
35
class EsLint < Base
46
def run
57
result = execute(command + applicable_files)

lib/overcommit/hook/pre_commit/go_lint.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `golint` against any modified Golang files.
3+
#
4+
# @see https://github.com/golang/lint
35
class GoLint < Base
46
def run
57
result = execute(command + applicable_files)

lib/overcommit/hook/pre_commit/go_vet.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `go vet` against any modified Golang files.
3+
#
4+
# @see https://godoc.org/code.google.com/p/go-zh.tools/cmd/vet
35
class GoVet < Base
46
def run
57
result = execute(command + applicable_files)

lib/overcommit/hook/pre_commit/haml_lint.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `haml-lint` against any modified HAML files.
3+
#
4+
# @see https://github.com/brigade/haml-lint/
35
class HamlLint < Base
46
MESSAGE_TYPE_CATEGORIZER = lambda do |type|
57
type.include?('W') ? :warning : :error

lib/overcommit/hook/pre_commit/html_tidy.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `tidy` against any modified HTML files.
3+
#
4+
# @see http://www.html-tidy.org/
35
class HtmlTidy < Base
46
MESSAGE_REGEX = /
57
^(?<file>[^:]+):\s

lib/overcommit/hook/pre_commit/image_optim.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Checks for images that can be optimized with `image_optim`.
3+
#
4+
# @see https://imageoptim.com/
35
class ImageOptim < Base
46
def run
57
result = execute(command + applicable_files)

lib/overcommit/hook/pre_commit/java_checkstyle.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `checkstyle` against any modified Java files.
3+
#
4+
# @see http://checkstyle.sourceforge.net/
35
class JavaCheckstyle < Base
46
MESSAGE_REGEX = /^(?<file>[^:]+):(?<line>\d+)/
57

lib/overcommit/hook/pre_commit/js_hint.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `jshint` against any modified JavaScript files.
3+
#
4+
# @see http://jshint.com/
35
class JsHint < Base
46
def run
57
result = execute(command + applicable_files)

lib/overcommit/hook/pre_commit/js_lint.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `jslint` against any modified JavaScript files.
3+
#
4+
# @see http://www.jslint.com/
35
class JsLint < Base
46
MESSAGE_REGEX = /(?<file>[^:]+):(?<line>\d+)/
57

lib/overcommit/hook/pre_commit/jscs.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `jscs` (JavaScript Code Style Checker) against any modified JavaScript
33
# files.
4+
#
5+
# @see http://jscs.info/
46
class Jscs < Base
57
def run
68
result = execute(command + applicable_files)

lib/overcommit/hook/pre_commit/jsl.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `jsl` against any modified JavaScript files.
3+
#
4+
# @see http://www.javascriptlint.com/
35
class Jsl < Base
46
MESSAGE_REGEX = /(?<file>.+)\((?<line>\d+)\):(?<type>[^:]+)/
57

lib/overcommit/hook/pre_commit/pep257.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `pep257` against any modified Python files.
3+
#
4+
# @see https://pypi.python.org/pypi/pep257
35
class Pep257 < Base
46
def run
57
result = execute(command + applicable_files)

lib/overcommit/hook/pre_commit/pep8.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `pep8` against any modified Python files.
3+
#
4+
# @see https://pypi.python.org/pypi/pep8
35
class Pep8 < Base
46
def run
57
result = execute(command + applicable_files)

lib/overcommit/hook/pre_commit/pyflakes.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `pyflakes` against any modified Python files.
3+
#
4+
# @see https://pypi.python.org/pypi/pyflakes
35
class Pyflakes < Base
46
MESSAGE_REGEX = /^(?<file>[^:]+):(?<line>\d+):/
57

lib/overcommit/hook/pre_commit/pylint.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `pylint` against any modified Python files.
3+
#
4+
# @see http://www.pylint.org/
35
class Pylint < Base
46
MESSAGE_REGEX = /^(?<file>.+):(?<line>\d+):(?<type>[CEFRW])/
57

lib/overcommit/hook/pre_commit/python_flake8.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `flake8` against any modified Python files.
3+
#
4+
# @see https://pypi.python.org/pypi/flake8
35
class PythonFlake8 < Base
46
MESSAGE_REGEX = /^(?<file>.+):(?<line>\d+):\d+:\s(?<type>\w\d+)/
57

lib/overcommit/hook/pre_commit/reek.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `reek` against any modified Ruby files.
3+
#
4+
# @see https://github.com/troessner/reek
35
class Reek < Base
46
def run
57
result = execute(command + applicable_files)

lib/overcommit/hook/pre_commit/rubo_cop.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `rubocop` against any modified Ruby files.
3+
#
4+
# @see http://batsov.com/rubocop/
35
class RuboCop < Base
46
MESSAGE_TYPE_CATEGORIZER = lambda do |type|
57
type.include?('W') ? :warning : :error

lib/overcommit/hook/pre_commit/ruby_lint.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `ruby-lint` against any modified Ruby files.
3+
#
4+
# @see https://github.com/YorickPeterse/ruby-lint
35
class RubyLint < Base
46
MESSAGE_TYPE_CATEGORIZER = lambda do |type|
57
type.include?('W') ? :warning : :error

lib/overcommit/hook/pre_commit/scalariform.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `scalariform` against any modified Scala files.
3+
#
4+
# @see https://github.com/mdr/scalariform
35
class Scalariform < Base
46
MESSAGE_REGEX = /^\[(?<type>FAILED|ERROR)\]\s+(?<file>.+)/
57

lib/overcommit/hook/pre_commit/scalastyle.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `scalastyle` against any modified Scala files.
3+
#
4+
# @see http://www.scalastyle.org/
35
class Scalastyle < Base
46
MESSAGE_REGEX = /
57
^(?<type>error|warning)\s

lib/overcommit/hook/pre_commit/scss_lint.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `scss-lint` against any modified SCSS files.
3+
#
4+
# @see https://github.com/brigade/scss-lint
35
class ScssLint < Base
46
MESSAGE_TYPE_CATEGORIZER = lambda do |type|
57
type.include?('W') ? :warning : :error

lib/overcommit/hook/pre_commit/semi_standard.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `semistandard` against any modified JavaScript files.
3+
#
4+
# @see https://github.com/Flet/semistandard
35
class SemiStandard < Base
46
def run
57
result = execute(command + applicable_files)

lib/overcommit/hook/pre_commit/shell_check.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `shellcheck` against any modified shell script files.
3+
#
4+
# @see http://www.shellcheck.net/
35
class ShellCheck < Base
46
MESSAGE_TYPE_CATEGORIZER = lambda do |type|
57
type.include?('note') ? :warning : :error

lib/overcommit/hook/pre_commit/slim_lint.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `slim-lint` against any modified Slim templates.
3+
#
4+
# @see https://github.com/sds/slim-lint
35
class SlimLint < Base
46
MESSAGE_TYPE_CATEGORIZER = lambda do |type|
57
type.include?('W') ? :warning : :error

lib/overcommit/hook/pre_commit/standard.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `standard` against any modified JavaScript files.
3+
#
4+
# @see https://github.com/feross/standard
35
class Standard < Base
46
def run
57
result = execute(command + applicable_files)

lib/overcommit/hook/pre_commit/travis_lint.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `travis-lint` against any modified Travis CI files.
3+
#
4+
# @see https://github.com/travis-ci/travis.rb
35
class TravisLint < Base
46
def run
57
result = execute(command + applicable_files)

lib/overcommit/hook/pre_commit/vint.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `vint` against any modified Vim script files.
3+
#
4+
# @see https://github.com/Kuniwak/vint
35
class Vint < Base
46
def run
57
result = execute(command + applicable_files)

lib/overcommit/hook/pre_commit/w3c_css.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `w3c_validators` against any modified CSS files.
3+
#
4+
# @see https://github.com/alexdunae/w3c_validators
35
class W3cCss < Base
46
def run
57
collect_messages

lib/overcommit/hook/pre_commit/w3c_html.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `w3c_validators` against any modified HTML files.
3+
#
4+
# @see https://github.com/alexdunae/w3c_validators
35
class W3cHtml < Base
46
def run
57
collect_messages

lib/overcommit/hook/pre_commit/xml_lint.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PreCommit
22
# Runs `xmllint` against any modified XML files.
3+
#
4+
# @see http://xmlsoft.org/xmllint.html
35
class XmlLint < Base
46
MESSAGE_REGEX = /^(?<file>[^:]+):(?<line>\d+):/
57

lib/overcommit/hook/pre_push/r_spec.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
module Overcommit::Hook::PrePush
22
# Runs `rspec` test suite before push
3+
#
4+
# @see http://rspec.info/
35
class RSpec < Base
46
def run
57
result = execute(command)

lib/overcommit/hook/shared/index_tags.rb

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
module Overcommit::Hook::Shared
22
# Shared code used by all IndexTags hooks. It runs ctags in the background so
33
# your tag definitions are up-to-date.
4+
#
5+
# @see http://ctags.sourceforge.net/
46
module IndexTags
57
def run
68
execute_in_background([Overcommit::Utils.script_path('index-tags')])

0 commit comments

Comments
 (0)