Add links to home pages for third-party tools

sds · sds · commit 724a1f98d641 · 2015-05-12T21:55:10.000-07:00
This makes it easier for relevant documentation for these tools to be discovered. Closes sds#210
diff --git a/lib/overcommit/hook/commit_msg/gerrit_change_id.rb b/lib/overcommit/hook/commit_msg/gerrit_change_id.rb
@@ -5,6 +5,8 @@ module Overcommit::Hook::CommitMsg
   # the reality is that if you want to _ensure_ the Change-Id is included then
   # you need to do it in a commit-msg hook. This is because the user could still
   # edit the message after a prepare-commit-msg hook was run.
+  #
+  # @see https://code.google.com/p/gerrit/
   class GerritChangeId < Base
     SCRIPT_LOCATION = Overcommit::Utils.script_path('gerrit-change-id')
 
diff --git a/lib/overcommit/hook/commit_msg/spell_check.rb b/lib/overcommit/hook/commit_msg/spell_check.rb
@@ -1,7 +1,9 @@
 require 'tempfile'
 
 module Overcommit::Hook::CommitMsg
-  # Checks the commit message for potential misspellings
+  # Checks the commit message for potential misspellings with `hunspell`.
+  #
+  # @see http://hunspell.sourceforge.net/
   class SpellCheck < Base
     Misspelling = Struct.new(:word, :suggestions)
 
diff --git a/lib/overcommit/hook/post_checkout/index_tags.rb b/lib/overcommit/hook/post_checkout/index_tags.rb
@@ -2,6 +2,8 @@
 
 module Overcommit::Hook::PostCheckout
   # Updates ctags index for all source code in the repository.
+  #
+  # @see {Overcommit::Hook::Shared::IndexTags}
   class IndexTags < Base
     include Overcommit::Hook::Shared::IndexTags
   end
diff --git a/lib/overcommit/hook/post_commit/git_guilt.rb b/lib/overcommit/hook/post_commit/git_guilt.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PostCommit
   # Calculates the change in blame since the last revision.
+  #
+  # @see https://www.npmjs.com/package/git-guilt
   class GitGuilt < Base
     PLUS_MINUS_REGEX = /^(.*?)(?:(\++)|(-+))$/
     GREEN = 32
diff --git a/lib/overcommit/hook/post_commit/index_tags.rb b/lib/overcommit/hook/post_commit/index_tags.rb
@@ -2,6 +2,8 @@
 
 module Overcommit::Hook::PostCommit
   # Updates ctags index for all source code in the repository.
+  #
+  # @see {Overcommit::Hook::Shared::IndexTags}
   class IndexTags < Base
     include Overcommit::Hook::Shared::IndexTags
   end
diff --git a/lib/overcommit/hook/post_merge/index_tags.rb b/lib/overcommit/hook/post_merge/index_tags.rb
@@ -2,6 +2,8 @@
 
 module Overcommit::Hook::PostMerge
   # Updates ctags index for all source code in the repository.
+  #
+  # @see {Overcommit::Hook::Shared::IndexTags}
   class IndexTags < Base
     include Overcommit::Hook::Shared::IndexTags
   end
diff --git a/lib/overcommit/hook/post_rewrite/index_tags.rb b/lib/overcommit/hook/post_rewrite/index_tags.rb
@@ -2,6 +2,8 @@
 
 module Overcommit::Hook::PostRewrite
   # Updates ctags index for all source code in the repository.
+  #
+  # @see {Overcommit::Hook::Shared::IndexTags}
   class IndexTags < Base
     include Overcommit::Hook::Shared::IndexTags
 
diff --git a/lib/overcommit/hook/pre_commit/berksfile_check.rb b/lib/overcommit/hook/pre_commit/berksfile_check.rb
@@ -1,6 +1,8 @@
 module Overcommit::Hook::PreCommit
   # Check if local Berksfile.lock matches Berksfile when either changes, unless
   # Berksfile.lock is ignored by git.
+  #
+  # @see http://berkshelf.com/
   class BerksfileCheck < Base
     LOCK_FILE = 'Berksfile.lock'
 
diff --git a/lib/overcommit/hook/pre_commit/brakeman.rb b/lib/overcommit/hook/pre_commit/brakeman.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `brakeman` against any modified Ruby/Rails files.
+  #
+  # @see http://brakemanscanner.org/
   class Brakeman < Base
     def run
       result = execute(command + [applicable_files.join(',')])
diff --git a/lib/overcommit/hook/pre_commit/bundle_check.rb b/lib/overcommit/hook/pre_commit/bundle_check.rb
@@ -1,6 +1,8 @@
 module Overcommit::Hook::PreCommit
   # Check if local Gemfile.lock matches Gemfile when either changes, unless
   # Gemfile.lock is ignored by git.
+  #
+  # @see http://bundler.io/
   class BundleCheck < Base
     LOCK_FILE = 'Gemfile.lock'
 
diff --git a/lib/overcommit/hook/pre_commit/chamber_security.rb b/lib/overcommit/hook/pre_commit/chamber_security.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
-  # Runs `chamber secure` against any modified Chamber settings files
+  # Runs `chamber secure` against any modified Chamber settings files.
+  #
+  # @see https://github.com/thekompanee/chamber
   class ChamberSecurity < Base
     def run
       result = execute(command + applicable_files)
diff --git a/lib/overcommit/hook/pre_commit/coffee_lint.rb b/lib/overcommit/hook/pre_commit/coffee_lint.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `coffeelint` against any modified CoffeeScript files.
+  #
+  # @see http://www.coffeelint.org/
   class CoffeeLint < Base
     def run
       result = execute(command + applicable_files)
diff --git a/lib/overcommit/hook/pre_commit/css_lint.rb b/lib/overcommit/hook/pre_commit/css_lint.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `csslint` against any modified CSS files.
+  #
+  # @see https://github.com/CSSLint/csslint
   class CssLint < Base
     MESSAGE_REGEX = /
       ^(?<file>[^:]+):\s
diff --git a/lib/overcommit/hook/pre_commit/es_lint.rb b/lib/overcommit/hook/pre_commit/es_lint.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `eslint` against any modified JavaScript files.
+  #
+  # @see http://eslint.org/
   class EsLint < Base
     def run
       result = execute(command + applicable_files)
diff --git a/lib/overcommit/hook/pre_commit/go_lint.rb b/lib/overcommit/hook/pre_commit/go_lint.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `golint` against any modified Golang files.
+  #
+  # @see https://github.com/golang/lint
   class GoLint < Base
     def run
       result = execute(command + applicable_files)
diff --git a/lib/overcommit/hook/pre_commit/go_vet.rb b/lib/overcommit/hook/pre_commit/go_vet.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `go vet` against any modified Golang files.
+  #
+  # @see https://godoc.org/code.google.com/p/go-zh.tools/cmd/vet
   class GoVet < Base
     def run
       result = execute(command + applicable_files)
diff --git a/lib/overcommit/hook/pre_commit/haml_lint.rb b/lib/overcommit/hook/pre_commit/haml_lint.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `haml-lint` against any modified HAML files.
+  #
+  # @see https://github.com/brigade/haml-lint/
   class HamlLint < Base
     MESSAGE_TYPE_CATEGORIZER = lambda do |type|
       type.include?('W') ? :warning : :error
diff --git a/lib/overcommit/hook/pre_commit/html_tidy.rb b/lib/overcommit/hook/pre_commit/html_tidy.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `tidy` against any modified HTML files.
+  #
+  # @see http://www.html-tidy.org/
   class HtmlTidy < Base
     MESSAGE_REGEX = /
       ^(?<file>[^:]+):\s
diff --git a/lib/overcommit/hook/pre_commit/image_optim.rb b/lib/overcommit/hook/pre_commit/image_optim.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Checks for images that can be optimized with `image_optim`.
+  #
+  # @see https://imageoptim.com/
   class ImageOptim < Base
     def run
       result = execute(command + applicable_files)
diff --git a/lib/overcommit/hook/pre_commit/java_checkstyle.rb b/lib/overcommit/hook/pre_commit/java_checkstyle.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `checkstyle` against any modified Java files.
+  #
+  # @see http://checkstyle.sourceforge.net/
   class JavaCheckstyle < Base
     MESSAGE_REGEX = /^(?<file>[^:]+):(?<line>\d+)/
 
diff --git a/lib/overcommit/hook/pre_commit/js_hint.rb b/lib/overcommit/hook/pre_commit/js_hint.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `jshint` against any modified JavaScript files.
+  #
+  # @see http://jshint.com/
   class JsHint < Base
     def run
       result = execute(command + applicable_files)
diff --git a/lib/overcommit/hook/pre_commit/js_lint.rb b/lib/overcommit/hook/pre_commit/js_lint.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `jslint` against any modified JavaScript files.
+  #
+  # @see http://www.jslint.com/
   class JsLint < Base
     MESSAGE_REGEX = /(?<file>[^:]+):(?<line>\d+)/
 
diff --git a/lib/overcommit/hook/pre_commit/jscs.rb b/lib/overcommit/hook/pre_commit/jscs.rb
@@ -1,6 +1,8 @@
 module Overcommit::Hook::PreCommit
   # Runs `jscs` (JavaScript Code Style Checker) against any modified JavaScript
   # files.
+  #
+  # @see http://jscs.info/
   class Jscs < Base
     def run
       result = execute(command + applicable_files)
diff --git a/lib/overcommit/hook/pre_commit/jsl.rb b/lib/overcommit/hook/pre_commit/jsl.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `jsl` against any modified JavaScript files.
+  #
+  # @see http://www.javascriptlint.com/
   class Jsl < Base
     MESSAGE_REGEX = /(?<file>.+)\((?<line>\d+)\):(?<type>[^:]+)/
 
diff --git a/lib/overcommit/hook/pre_commit/pep257.rb b/lib/overcommit/hook/pre_commit/pep257.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `pep257` against any modified Python files.
+  #
+  # @see https://pypi.python.org/pypi/pep257
   class Pep257 < Base
     def run
       result = execute(command + applicable_files)
diff --git a/lib/overcommit/hook/pre_commit/pep8.rb b/lib/overcommit/hook/pre_commit/pep8.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `pep8` against any modified Python files.
+  #
+  # @see https://pypi.python.org/pypi/pep8
   class Pep8 < Base
     def run
       result = execute(command + applicable_files)
diff --git a/lib/overcommit/hook/pre_commit/pyflakes.rb b/lib/overcommit/hook/pre_commit/pyflakes.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `pyflakes` against any modified Python files.
+  #
+  # @see https://pypi.python.org/pypi/pyflakes
   class Pyflakes < Base
     MESSAGE_REGEX = /^(?<file>[^:]+):(?<line>\d+):/
 
diff --git a/lib/overcommit/hook/pre_commit/pylint.rb b/lib/overcommit/hook/pre_commit/pylint.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `pylint` against any modified Python files.
+  #
+  # @see http://www.pylint.org/
   class Pylint < Base
     MESSAGE_REGEX = /^(?<file>.+):(?<line>\d+):(?<type>[CEFRW])/
 
diff --git a/lib/overcommit/hook/pre_commit/python_flake8.rb b/lib/overcommit/hook/pre_commit/python_flake8.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `flake8` against any modified Python files.
+  #
+  # @see https://pypi.python.org/pypi/flake8
   class PythonFlake8 < Base
     MESSAGE_REGEX = /^(?<file>.+):(?<line>\d+):\d+:\s(?<type>\w\d+)/
 
diff --git a/lib/overcommit/hook/pre_commit/reek.rb b/lib/overcommit/hook/pre_commit/reek.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `reek` against any modified Ruby files.
+  #
+  # @see https://github.com/troessner/reek
   class Reek < Base
     def run
       result = execute(command + applicable_files)
diff --git a/lib/overcommit/hook/pre_commit/rubo_cop.rb b/lib/overcommit/hook/pre_commit/rubo_cop.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `rubocop` against any modified Ruby files.
+  #
+  # @see http://batsov.com/rubocop/
   class RuboCop < Base
     MESSAGE_TYPE_CATEGORIZER = lambda do |type|
       type.include?('W') ? :warning : :error
diff --git a/lib/overcommit/hook/pre_commit/ruby_lint.rb b/lib/overcommit/hook/pre_commit/ruby_lint.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `ruby-lint` against any modified Ruby files.
+  #
+  # @see https://github.com/YorickPeterse/ruby-lint
   class RubyLint < Base
     MESSAGE_TYPE_CATEGORIZER = lambda do |type|
       type.include?('W') ? :warning : :error
diff --git a/lib/overcommit/hook/pre_commit/scalariform.rb b/lib/overcommit/hook/pre_commit/scalariform.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `scalariform` against any modified Scala files.
+  #
+  # @see https://github.com/mdr/scalariform
   class Scalariform < Base
     MESSAGE_REGEX = /^\[(?<type>FAILED|ERROR)\]\s+(?<file>.+)/
 
diff --git a/lib/overcommit/hook/pre_commit/scalastyle.rb b/lib/overcommit/hook/pre_commit/scalastyle.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `scalastyle` against any modified Scala files.
+  #
+  # @see http://www.scalastyle.org/
   class Scalastyle < Base
     MESSAGE_REGEX = /
       ^(?<type>error|warning)\s
diff --git a/lib/overcommit/hook/pre_commit/scss_lint.rb b/lib/overcommit/hook/pre_commit/scss_lint.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `scss-lint` against any modified SCSS files.
+  #
+  # @see https://github.com/brigade/scss-lint
   class ScssLint < Base
     MESSAGE_TYPE_CATEGORIZER = lambda do |type|
       type.include?('W') ? :warning : :error
diff --git a/lib/overcommit/hook/pre_commit/semi_standard.rb b/lib/overcommit/hook/pre_commit/semi_standard.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `semistandard` against any modified JavaScript files.
+  #
+  # @see https://github.com/Flet/semistandard
   class SemiStandard < Base
     def run
       result = execute(command + applicable_files)
diff --git a/lib/overcommit/hook/pre_commit/shell_check.rb b/lib/overcommit/hook/pre_commit/shell_check.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `shellcheck` against any modified shell script files.
+  #
+  # @see http://www.shellcheck.net/
   class ShellCheck < Base
     MESSAGE_TYPE_CATEGORIZER = lambda do |type|
       type.include?('note') ? :warning : :error
diff --git a/lib/overcommit/hook/pre_commit/slim_lint.rb b/lib/overcommit/hook/pre_commit/slim_lint.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `slim-lint` against any modified Slim templates.
+  #
+  # @see https://github.com/sds/slim-lint
   class SlimLint < Base
     MESSAGE_TYPE_CATEGORIZER = lambda do |type|
       type.include?('W') ? :warning : :error
diff --git a/lib/overcommit/hook/pre_commit/standard.rb b/lib/overcommit/hook/pre_commit/standard.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `standard` against any modified JavaScript files.
+  #
+  # @see https://github.com/feross/standard
   class Standard < Base
     def run
       result = execute(command + applicable_files)
diff --git a/lib/overcommit/hook/pre_commit/travis_lint.rb b/lib/overcommit/hook/pre_commit/travis_lint.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `travis-lint` against any modified Travis CI files.
+  #
+  # @see https://github.com/travis-ci/travis.rb
   class TravisLint < Base
     def run
       result = execute(command + applicable_files)
diff --git a/lib/overcommit/hook/pre_commit/vint.rb b/lib/overcommit/hook/pre_commit/vint.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `vint` against any modified Vim script files.
+  #
+  # @see https://github.com/Kuniwak/vint
   class Vint < Base
     def run
       result = execute(command + applicable_files)
diff --git a/lib/overcommit/hook/pre_commit/w3c_css.rb b/lib/overcommit/hook/pre_commit/w3c_css.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `w3c_validators` against any modified CSS files.
+  #
+  # @see https://github.com/alexdunae/w3c_validators
   class W3cCss < Base
     def run
       collect_messages
diff --git a/lib/overcommit/hook/pre_commit/w3c_html.rb b/lib/overcommit/hook/pre_commit/w3c_html.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `w3c_validators` against any modified HTML files.
+  #
+  # @see https://github.com/alexdunae/w3c_validators
   class W3cHtml < Base
     def run
       collect_messages
diff --git a/lib/overcommit/hook/pre_commit/xml_lint.rb b/lib/overcommit/hook/pre_commit/xml_lint.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Runs `xmllint` against any modified XML files.
+  #
+  # @see http://xmlsoft.org/xmllint.html
   class XmlLint < Base
     MESSAGE_REGEX = /^(?<file>[^:]+):(?<line>\d+):/
 
diff --git a/lib/overcommit/hook/pre_push/r_spec.rb b/lib/overcommit/hook/pre_push/r_spec.rb
@@ -1,5 +1,7 @@
 module Overcommit::Hook::PrePush
   # Runs `rspec` test suite before push
+  #
+  # @see http://rspec.info/
   class RSpec < Base
     def run
       result = execute(command)
diff --git a/lib/overcommit/hook/shared/index_tags.rb b/lib/overcommit/hook/shared/index_tags.rb
@@ -1,6 +1,8 @@
 module Overcommit::Hook::Shared
   # Shared code used by all IndexTags hooks. It runs ctags in the background so
   # your tag definitions are up-to-date.
+  #
+  # @see http://ctags.sourceforge.net/
   module IndexTags
     def run
       execute_in_background([Overcommit::Utils.script_path('index-tags')])
