From 9e9c87f835901fce5164e09f858e5518e6249f46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guillaume=20D=C3=A9flache?= Date: Fri, 11 Jun 2021 17:03:14 +0200 Subject: [PATCH 1/7] Add some tests for ad-hoc (pre-commit) Git hooks --- .../hook_loader/plugin_hook_loader_spec.rb | 68 +++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 spec/overcommit/hook_loader/plugin_hook_loader_spec.rb diff --git a/spec/overcommit/hook_loader/plugin_hook_loader_spec.rb b/spec/overcommit/hook_loader/plugin_hook_loader_spec.rb new file mode 100644 index 00000000..d8cdc505 --- /dev/null +++ b/spec/overcommit/hook_loader/plugin_hook_loader_spec.rb @@ -0,0 +1,68 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'ad-hoc pre-commit hook' do + subject do + hook_loader = Overcommit::HookLoader::PluginHookLoader.new( + config, + context, + Overcommit::Logger.new(STDOUT) + ) + hooks = hook_loader.load_hooks + hooks.find { |h| h.name == hook_name } + end + let(:config) do + config = Overcommit::Configuration.new( + YAML.safe_load(config_contents, [Regexp]), { + validate: false + } + ) + Overcommit::ConfigurationLoader.default_configuration.merge(config) + end + let(:context) do + empty_stdin = File.open(File::NULL) # pre-commit hooks don't take input + context = Overcommit::HookContext.create('pre-commit', config, applicable_files, empty_stdin) + context + end + + around do |example| + repo do + example.run + end + end + + describe 'if not line-aware' do + let(:config_contents) do + <<-'YML' + PreCommit: + FooGitHook: + enabled: true + command: "foocmd" + YML + end + let(:hook_name) { 'FooGitHook' } + let(:applicable_files) { nil } + + before do + context.stub(:execute_hook).with(%w[foocmd]). + and_return(result) + end + + context 'when command succeeds' do + let(:result) do + double(success?: true, stdout: '') + end + + it { should pass } + end + + context 'when command fails' do + let(:result) do + double(success?: false, stdout: '', stderr: '') + end + + it { should fail_hook } + end + end +end From a359629d74072e3eeb06f127c98c833b233437cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guillaume=20D=C3=A9flache?= Date: Fri, 11 Jun 2021 19:37:38 +0200 Subject: [PATCH 2/7] Add "ad-hoc" line-aware command hooks --- CHANGELOG.md | 1 + README.md | 62 +++++++++ lib/overcommit/hook_loader/base.rb | 28 ++++ .../hook_loader/plugin_hook_loader.rb | 26 +++- lib/overcommit/utils/messages_utils.rb | 8 ++ .../hook_loader/plugin_hook_loader_spec.rb | 131 ++++++++++++++++++ 6 files changed, 250 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f27e6208..a154d308 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ## master (unreleased) * Add `--disable-pending-cops` as default flag to `RuboCop` pre-commit hook to ignore non-existent cops. Requires RuboCop `0.82.0` or newer. +* Add "ad-hoc" line-aware command hooks ## 0.58.0 diff --git a/README.md b/README.md index 36126a2c..d0404762 100644 --- a/README.md +++ b/README.md @@ -240,6 +240,7 @@ Option | Description `install_command` | Command the user can run to install the `required_executable` (or alternately the specified `required_libraries`). This is intended for documentation purposes, as Overcommit does not install software on your behalf since there are too many edge cases where such behavior would result in incorrectly configured installations (e.g. installing a Python package in the global package space instead of in a virtual environment). `skip_file_checkout` | Whether to skip this hook for file checkouts (e.g. `git checkout some-ref -- file`). Only applicable to `PostCheckout` hooks. `skip_if` | Array of arguments to be executed to determine whether or not the hook should run. For example, setting this to a value of `['bash', '-c', '! which my-executable']` would allow you to skip running this hook if `my-executable` was not in the bin path. +`ad_hoc` | *["Ad-hoc" line-aware command hooks](#adding-existing-line-aware-commands) only.* In addition to the built-in configuration options, each hook can expose its own unique configuration options. The `AuthorEmail` hook, for example, allows @@ -671,6 +672,67 @@ of hook, see the [git-hooks documentation][GHD]. [GHD]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks +### Adding Existing Line-Aware Commands + +Or in other words "low-code error format support." + +If you use tools that analyze files and report their findings line-by-line, +and that Overcommit does not yet support, you may be able to integrate them +with Overcommit without writing any Ruby code in a similar way as +[for existing Git hooks](#adding-existing-git-hooks). + +These special line-aware command hooks behave and are configured the same way +as the Git ones, except only file arguments get passed to them. +Also they must have the `ad_hoc` option, so that, using the command output: +- differentiating between warnings and errors becomes possible +- modified lines can be detected and acted upon as defined by + the `problem_on_unmodified_line`, `requires_files`, `include` and `exclude` + [hook options](#hook-options) + +**Warning**: Only the command's standard output stream is considered for now, +*not* its standard error stream. + +To differentiate between warning and error messages, +the `warning_message_type_pattern` suboption may be specified: +the `type` field of the `message_pattern` regexp below must then include +the `warning_message_type_pattern` option's text. + +The `message_pattern` suboption specifies the format of the command's messages. +It is a optional [(Ruby) regexp][RubyRE], which if present must at least define +a `file` [named capture group][RubyRENCG]. +The only other allowed ones are `line` and `type`, which when specified +enable detection of modified lines and warnings respectively. + +**Note**: The default value for this option is often adequate: +it generalizes the quasi-standard [GNU/Emacs-style error format][GNUEerrf], +adding the most frequently used warning syntax to it. + +For example: + +```yaml +PreCommit: + CustomScript: + enabled: true + command: './bin/custom-script' + ad_hoc: + message_pattern: !ruby/regexp /^(?[^:]+):(?[0-9]+):(?[^ ]+)/ + warning_message_type_pattern: warning +``` + +**Tip**: To get the syntax of the regexps right, a Ruby interpreter like `irb` +can help: + +```ruby +require('yaml'); puts YAML.dump(/MY-REGEXP/) +``` + +Then copy the output line text as the YAML option's value, thereby +omitting the `---` prefix. + +[RubyRE]: https://ruby-doc.org/core-2.4.1/Regexp.html +[RubyRENCG]: https://ruby-doc.org/core-2.4.1/Regexp.html#class-Regexp-label-Capturing +[GNUEerrf]: https://www.gnu.org/prep/standards/standards.html#Errors + ## Security While Overcommit can make managing Git hooks easier and more convenient, diff --git a/lib/overcommit/hook_loader/base.rb b/lib/overcommit/hook_loader/base.rb index 9173e9f1..0f501a82 100644 --- a/lib/overcommit/hook_loader/base.rb +++ b/lib/overcommit/hook_loader/base.rb @@ -22,6 +22,34 @@ def load_hooks private + # GNU/Emacs-style error format: + AD_HOC_HOOK_DEFAULT_MESSAGE_PATTERN = + /^(?(?:\w:)?[^:]+):(?\d+):[^ ]* (?[^ ]+)/.freeze + + def create_line_aware_command_hook_class(hook_base) + Class.new(hook_base) do + def run + result = execute(command, args: applicable_files) + + return :pass if result.success? + + extract_messages(@config['ad_hoc'], result) + end + + def extract_messages(ad_hoc_config, result) + warning_message_type_pattern = ad_hoc_config['warning_message_type_pattern'] + Overcommit::Utils::MessagesUtils.extract_messages( + result.stdout.split("\n"), + ad_hoc_config['message_pattern'] || + AD_HOC_HOOK_DEFAULT_MESSAGE_PATTERN, + Overcommit::Utils::MessagesUtils.create_type_categorizer( + warning_message_type_pattern + ) + ) + end + end + end + attr_reader :log # Load and return a {Hook} from a CamelCase hook name. diff --git a/lib/overcommit/hook_loader/plugin_hook_loader.rb b/lib/overcommit/hook_loader/plugin_hook_loader.rb index d168a0de..2c829854 100644 --- a/lib/overcommit/hook_loader/plugin_hook_loader.rb +++ b/lib/overcommit/hook_loader/plugin_hook_loader.rb @@ -74,16 +74,12 @@ def check_for_modified_plugins raise Overcommit::Exceptions::InvalidHookSignature end - def create_ad_hoc_hook(hook_name) - hook_module = Overcommit::Hook.const_get(@context.hook_class_name) - hook_base = hook_module.const_get('Base') - + def create_git_hook_class(hook_base) # Implement a simple class that executes the command and returns pass/fail # based on the exit status - hook_class = Class.new(hook_base) do + Class.new(hook_base) do def run result = @context.execute_hook(command) - if result.success? :pass else @@ -91,6 +87,24 @@ def run end end end + end + + def create_ad_hoc_hook(hook_name) + hook_module = Overcommit::Hook.const_get(@context.hook_class_name) + hook_base = hook_module.const_get('Base') + + hook_config = @config.for_hook(hook_name, @context.hook_class_name) + hook_class = + if hook_config['ad_hoc'] + create_line_aware_command_hook_class(hook_base) + else + create_git_hook_class(hook_base) + end + + # Only to avoid warnings in unit tests...: + if hook_module.const_defined?(hook_name) + return hook_module.const_get(hook_name).new(@config, @context) + end hook_module.const_set(hook_name, hook_class).new(@config, @context) rescue LoadError, NameError => e diff --git a/lib/overcommit/utils/messages_utils.rb b/lib/overcommit/utils/messages_utils.rb index c92a6010..a7baecb2 100644 --- a/lib/overcommit/utils/messages_utils.rb +++ b/lib/overcommit/utils/messages_utils.rb @@ -37,6 +37,14 @@ def extract_messages(output_messages, regex, type_categorizer = nil) end end + def create_type_categorizer(warning_pattern) + return nil if warning_pattern.nil? + + lambda do |type| + type.include?(warning_pattern) ? :warning : :error + end + end + private def extract_file(match, message) diff --git a/spec/overcommit/hook_loader/plugin_hook_loader_spec.rb b/spec/overcommit/hook_loader/plugin_hook_loader_spec.rb index d8cdc505..dad1f28f 100644 --- a/spec/overcommit/hook_loader/plugin_hook_loader_spec.rb +++ b/spec/overcommit/hook_loader/plugin_hook_loader_spec.rb @@ -65,4 +65,135 @@ it { should fail_hook } end end + + describe 'if line-aware' do + let(:config_contents) do + <<-'YML' + PreCommit: + FooLint: + enabled: true + command: ["foo", "lint"] + ad_hoc: + message_pattern: !ruby/regexp /^(?[^:]+):(?[0-9]+):(?[^ ]+)/ + warning_message_type_pattern: warning + flags: + - "--format=emacs" + include: '**/*.foo' + FooLintDefault: + enabled: true + command: ["foo", "lint"] + ad_hoc: + warning_message_type_pattern: warning + flags: + - "--format=emacs" + include: '**/*.foo' + FooLintDefaultNoWarnings: + enabled: true + command: ["foo", "lint"] + ad_hoc: + flags: + - "--format=emacs" + include: '**/*.foo' + YML + end + let(:hook_name) { 'FooLint' } + let(:applicable_files) { %w[file.foo] } + + before do + subject.stub(:applicable_files).and_return(applicable_files) + subject.stub(:execute).with(%w[foo lint --format=emacs], args: applicable_files). + and_return(result) + end + + context 'when command succeeds' do + let(:result) do + double(success?: true, stdout: '') + end + + it { should pass } + end + + context 'when command fails with empty stdout' do + let(:result) do + double(success?: false, stdout: '', stderr: '') + end + + it { should pass } + end + + context 'when command fails with some warning message' do + let(:result) do + double( + success?: false, + stdout: "A:1:warning...\n", + stderr: '' + ) + end + + it { should warn } + end + + context 'when command fails with some error message' do + let(:result) do + double( + success?: false, + stdout: "A:1:???\n", + stderr: '' + ) + end + + it { should fail_hook } + end + + describe '(using default pattern)' do + let(:hook_name) { 'FooLintDefault' } + + context 'when command fails with some warning message' do + let(:result) do + double( + success?: false, + stdout: <<-MSG, +B:1: warning: ??? + MSG + stderr: '' + ) + end + + it { should warn } + end + + context 'when command fails with some error message' do + let(:result) do + double( + success?: false, + stdout: <<-MSG, +A:1:80: error + MSG + stderr: '' + ) + end + + it { should fail_hook } + end + end + + describe '(using defaults)' do + let(:hook_name) { 'FooLintDefaultNoWarnings' } + + context 'when command fails with some messages' do + let(:result) do + double( + success?: false, + stdout: <<-MSG, +A:1:80: error +B:1: warning: ??? + MSG + stderr: '' + ) + end + + it { should fail_hook } + end + end + end end From ad88bf750b6fed0bba9921f51983888f03223a46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guillaume=20D=C3=A9flache?= Date: Fri, 16 Jul 2021 12:35:43 +0200 Subject: [PATCH 3/7] Flatten YAML configuration as per review comments --- README.md | 16 ++++++++----- lib/overcommit/hook_loader/base.rb | 23 +++++++++++++++---- .../hook_loader/plugin_hook_loader.rb | 2 +- .../hook_loader/plugin_hook_loader_spec.rb | 10 ++++---- 4 files changed, 33 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index d0404762..cb1cd430 100644 --- a/README.md +++ b/README.md @@ -683,7 +683,8 @@ with Overcommit without writing any Ruby code in a similar way as These special line-aware command hooks behave and are configured the same way as the Git ones, except only file arguments get passed to them. -Also they must have the `ad_hoc` option, so that, using the command output: +Also to enable the feature, they must use at least one of the following options, +so that, using the command output: - differentiating between warnings and errors becomes possible - modified lines can be detected and acted upon as defined by the `problem_on_unmodified_line`, `requires_files`, `include` and `exclude` @@ -691,13 +692,17 @@ Also they must have the `ad_hoc` option, so that, using the command output: **Warning**: Only the command's standard output stream is considered for now, *not* its standard error stream. +If you do not need to change the default values for any other option, +then the `extract_messages_from` option has to be specified. +Its value does not matter for now, but it should be set to `stdout` +to avoid problems in the future. To differentiate between warning and error messages, -the `warning_message_type_pattern` suboption may be specified: +the `warning_message_type_pattern` option may be specified: the `type` field of the `message_pattern` regexp below must then include the `warning_message_type_pattern` option's text. -The `message_pattern` suboption specifies the format of the command's messages. +The `message_pattern` option specifies the format of the command's messages. It is a optional [(Ruby) regexp][RubyRE], which if present must at least define a `file` [named capture group][RubyRENCG]. The only other allowed ones are `line` and `type`, which when specified @@ -714,9 +719,8 @@ PreCommit: CustomScript: enabled: true command: './bin/custom-script' - ad_hoc: - message_pattern: !ruby/regexp /^(?[^:]+):(?[0-9]+):(?[^ ]+)/ - warning_message_type_pattern: warning + message_pattern: !ruby/regexp /^(?[^:]+):(?[0-9]+):(?[^ ]+)/ + warning_message_type_pattern: warning ``` **Tip**: To get the syntax of the regexps right, a Ruby interpreter like `irb` diff --git a/lib/overcommit/hook_loader/base.rb b/lib/overcommit/hook_loader/base.rb index 0f501a82..3a6251fe 100644 --- a/lib/overcommit/hook_loader/base.rb +++ b/lib/overcommit/hook_loader/base.rb @@ -26,21 +26,34 @@ def load_hooks AD_HOC_HOOK_DEFAULT_MESSAGE_PATTERN = /^(?(?:\w:)?[^:]+):(?\d+):[^ ]* (?[^ ]+)/.freeze - def create_line_aware_command_hook_class(hook_base) + def is_hook_line_aware(hook_config) + hook_config['extract_messages_from'] || + hook_config['message_pattern'] || + hook_config['warning_message_type_pattern'] + end + + def create_line_aware_command_hook_class(hook_base) # rubocop:disable Metrics/MethodLength Class.new(hook_base) do + def line_aware_config + { + message_pattern: @config['message_pattern'], + warning_message_type_pattern: @config['warning_message_type_pattern'] + } + end + def run result = execute(command, args: applicable_files) return :pass if result.success? - extract_messages(@config['ad_hoc'], result) + extract_messages(line_aware_config, result) end - def extract_messages(ad_hoc_config, result) - warning_message_type_pattern = ad_hoc_config['warning_message_type_pattern'] + def extract_messages(line_aware_config, result) + warning_message_type_pattern = line_aware_config[:warning_message_type_pattern] Overcommit::Utils::MessagesUtils.extract_messages( result.stdout.split("\n"), - ad_hoc_config['message_pattern'] || + line_aware_config[:message_pattern] || AD_HOC_HOOK_DEFAULT_MESSAGE_PATTERN, Overcommit::Utils::MessagesUtils.create_type_categorizer( warning_message_type_pattern diff --git a/lib/overcommit/hook_loader/plugin_hook_loader.rb b/lib/overcommit/hook_loader/plugin_hook_loader.rb index 2c829854..dfa2e88c 100644 --- a/lib/overcommit/hook_loader/plugin_hook_loader.rb +++ b/lib/overcommit/hook_loader/plugin_hook_loader.rb @@ -95,7 +95,7 @@ def create_ad_hoc_hook(hook_name) hook_config = @config.for_hook(hook_name, @context.hook_class_name) hook_class = - if hook_config['ad_hoc'] + if is_hook_line_aware(hook_config) create_line_aware_command_hook_class(hook_base) else create_git_hook_class(hook_base) diff --git a/spec/overcommit/hook_loader/plugin_hook_loader_spec.rb b/spec/overcommit/hook_loader/plugin_hook_loader_spec.rb index dad1f28f..6c64232b 100644 --- a/spec/overcommit/hook_loader/plugin_hook_loader_spec.rb +++ b/spec/overcommit/hook_loader/plugin_hook_loader_spec.rb @@ -73,24 +73,22 @@ FooLint: enabled: true command: ["foo", "lint"] - ad_hoc: - message_pattern: !ruby/regexp /^(?[^:]+):(?[0-9]+):(?[^ ]+)/ - warning_message_type_pattern: warning + message_pattern: !ruby/regexp /^(?[^:]+):(?[0-9]+):(?[^ ]+)/ + warning_message_type_pattern: warning flags: - "--format=emacs" include: '**/*.foo' FooLintDefault: enabled: true command: ["foo", "lint"] - ad_hoc: - warning_message_type_pattern: warning + warning_message_type_pattern: warning flags: - "--format=emacs" include: '**/*.foo' FooLintDefaultNoWarnings: enabled: true command: ["foo", "lint"] - ad_hoc: + extract_messages_from: stdout flags: - "--format=emacs" include: '**/*.foo' From 9f1c8ba60fe6d67d2ddf606c213799bac5f65976 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guillaume=20D=C3=A9flache?= Date: Mon, 11 Oct 2021 19:27:10 +0200 Subject: [PATCH 4/7] Link to feature more + avoid "ad-hoc" term in docs --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cb1cd430..6174a87b 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,8 @@ In addition to supporting a wide variety of hooks that can be used across multiple repositories, you can also define hooks specific to a repository which are stored in source control. You can also easily -[add your existing hook scripts](#adding-existing-git-hooks) without writing +[add your existing hook scripts](#adding-existing-git-hooks) or +[use some of your existing line-oriented analysis tools](#adding-existing-line-aware-commands) without writing any Ruby code. * [Requirements](#requirements) @@ -41,6 +42,7 @@ any Ruby code. * [PreRebase](#prerebase) * [Repo-Specific Hooks](#repo-specific-hooks) * [Adding Existing Git Hooks](#adding-existing-git-hooks) + * [Adding Existing Line-Aware Commands](#adding-existing-line-aware-commands) * [Security](#security) * [Contributing](#contributing) * [Community](#community) @@ -240,7 +242,7 @@ Option | Description `install_command` | Command the user can run to install the `required_executable` (or alternately the specified `required_libraries`). This is intended for documentation purposes, as Overcommit does not install software on your behalf since there are too many edge cases where such behavior would result in incorrectly configured installations (e.g. installing a Python package in the global package space instead of in a virtual environment). `skip_file_checkout` | Whether to skip this hook for file checkouts (e.g. `git checkout some-ref -- file`). Only applicable to `PostCheckout` hooks. `skip_if` | Array of arguments to be executed to determine whether or not the hook should run. For example, setting this to a value of `['bash', '-c', '! which my-executable']` would allow you to skip running this hook if `my-executable` was not in the bin path. -`ad_hoc` | *["Ad-hoc" line-aware command hooks](#adding-existing-line-aware-commands) only.* +[...]`message_`[...] | *[Line-aware command hooks](#adding-existing-line-aware-commands) only.* In addition to the built-in configuration options, each hook can expose its own unique configuration options. The `AuthorEmail` hook, for example, allows From 3dc1d149b933e540e219640209a4526e6f160d2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guillaume=20D=C3=A9flache?= Date: Mon, 11 Oct 2021 20:14:47 +0200 Subject: [PATCH 5/7] Remove magic default value as per review comment --- README.md | 17 ++++++++--------- lib/overcommit/hook_loader/base.rb | 11 ++--------- .../hook_loader/plugin_hook_loader_spec.rb | 15 ++++++++------- 3 files changed, 18 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 6174a87b..7ca87a3f 100644 --- a/README.md +++ b/README.md @@ -685,8 +685,8 @@ with Overcommit without writing any Ruby code in a similar way as These special line-aware command hooks behave and are configured the same way as the Git ones, except only file arguments get passed to them. -Also to enable the feature, they must use at least one of the following options, -so that, using the command output: +Also to enable them and for optimal use, one must configure them as explained +below, so that, using the command output: - differentiating between warnings and errors becomes possible - modified lines can be detected and acted upon as defined by the `problem_on_unmodified_line`, `requires_files`, `include` and `exclude` @@ -694,10 +694,6 @@ so that, using the command output: **Warning**: Only the command's standard output stream is considered for now, *not* its standard error stream. -If you do not need to change the default values for any other option, -then the `extract_messages_from` option has to be specified. -Its value does not matter for now, but it should be set to `stdout` -to avoid problems in the future. To differentiate between warning and error messages, the `warning_message_type_pattern` option may be specified: @@ -705,13 +701,16 @@ the `type` field of the `message_pattern` regexp below must then include the `warning_message_type_pattern` option's text. The `message_pattern` option specifies the format of the command's messages. -It is a optional [(Ruby) regexp][RubyRE], which if present must at least define +It is mandatory, must be a [(Ruby) regexp][RubyRE], and must define at least a `file` [named capture group][RubyRENCG]. The only other allowed ones are `line` and `type`, which when specified enable detection of modified lines and warnings respectively. -**Note**: The default value for this option is often adequate: -it generalizes the quasi-standard [GNU/Emacs-style error format][GNUEerrf], +**Tip**: The following value for this option is often adequate: +```ruby +/^(?(?:\w:)?[^:]+):(?\d+):[^ ]* (?[^ ]+)/ +``` +It generalizes the quasi-standard [GNU/Emacs-style error format][GNUEerrf], adding the most frequently used warning syntax to it. For example: diff --git a/lib/overcommit/hook_loader/base.rb b/lib/overcommit/hook_loader/base.rb index 3a6251fe..612b436f 100644 --- a/lib/overcommit/hook_loader/base.rb +++ b/lib/overcommit/hook_loader/base.rb @@ -22,14 +22,8 @@ def load_hooks private - # GNU/Emacs-style error format: - AD_HOC_HOOK_DEFAULT_MESSAGE_PATTERN = - /^(?(?:\w:)?[^:]+):(?\d+):[^ ]* (?[^ ]+)/.freeze - def is_hook_line_aware(hook_config) - hook_config['extract_messages_from'] || - hook_config['message_pattern'] || - hook_config['warning_message_type_pattern'] + hook_config['message_pattern'] end def create_line_aware_command_hook_class(hook_base) # rubocop:disable Metrics/MethodLength @@ -53,8 +47,7 @@ def extract_messages(line_aware_config, result) warning_message_type_pattern = line_aware_config[:warning_message_type_pattern] Overcommit::Utils::MessagesUtils.extract_messages( result.stdout.split("\n"), - line_aware_config[:message_pattern] || - AD_HOC_HOOK_DEFAULT_MESSAGE_PATTERN, + line_aware_config[:message_pattern], Overcommit::Utils::MessagesUtils.create_type_categorizer( warning_message_type_pattern ) diff --git a/spec/overcommit/hook_loader/plugin_hook_loader_spec.rb b/spec/overcommit/hook_loader/plugin_hook_loader_spec.rb index 6c64232b..3dca7319 100644 --- a/spec/overcommit/hook_loader/plugin_hook_loader_spec.rb +++ b/spec/overcommit/hook_loader/plugin_hook_loader_spec.rb @@ -78,17 +78,18 @@ flags: - "--format=emacs" include: '**/*.foo' - FooLintDefault: + FooLintRecommendedPattern: enabled: true command: ["foo", "lint"] + message_pattern: !ruby/regexp /^(?(?:\w:)?[^:]+):(?\d+):[^ ]* (?[^ ]+)/ warning_message_type_pattern: warning flags: - "--format=emacs" include: '**/*.foo' - FooLintDefaultNoWarnings: + FooLintRecommendedPatternNoWarnings: enabled: true command: ["foo", "lint"] - extract_messages_from: stdout + message_pattern: !ruby/regexp /^(?(?:\w:)?[^:]+):(?\d+):[^ ]* (?[^ ]+)/ flags: - "--format=emacs" include: '**/*.foo' @@ -143,8 +144,8 @@ it { should fail_hook } end - describe '(using default pattern)' do - let(:hook_name) { 'FooLintDefault' } + describe '(using recommended pattern)' do + let(:hook_name) { 'FooLintRecommendedPattern' } context 'when command fails with some warning message' do let(:result) do @@ -175,8 +176,8 @@ end end - describe '(using defaults)' do - let(:hook_name) { 'FooLintDefaultNoWarnings' } + describe '(using recommended pattern w/o warnings)' do + let(:hook_name) { 'FooLintRecommendedPatternNoWarnings' } context 'when command fails with some messages' do let(:result) do From c9b308ab938538782fad6ac3042d8701ca8fa4aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guillaume=20D=C3=A9flache?= Date: Sat, 12 Jun 2021 07:14:12 +0200 Subject: [PATCH 6/7] Add Vale pre-commit hook to check spelling/style --- CHANGELOG.md | 3 ++- README.md | 1 + config/default.yml | 53 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 56 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a154d308..26a3746b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,8 @@ ## master (unreleased) * Add `--disable-pending-cops` as default flag to `RuboCop` pre-commit hook to ignore non-existent cops. Requires RuboCop `0.82.0` or newer. -* Add "ad-hoc" line-aware command hooks +* Add "ad-hoc" line-aware command hooks. +* Add `Vale` pre-commit hook to check spelling and style in text and source files. ## 0.58.0 diff --git a/README.md b/README.md index 7ca87a3f..13ac99e5 100644 --- a/README.md +++ b/README.md @@ -567,6 +567,7 @@ issue](https://github.com/sds/overcommit/issues/238) for more details. * [TrailingWhitespace](lib/overcommit/hook/pre_commit/trailing_whitespace.rb) * [TravisLint](lib/overcommit/hook/pre_commit/travis_lint.rb) * [TsLint](lib/overcommit/hook/pre_commit/ts_lint.rb) +* Vale * [Vint](lib/overcommit/hook/pre_commit/vint.rb) * [W3cCss](lib/overcommit/hook/pre_commit/w3c_css.rb) * [W3cHtml](lib/overcommit/hook/pre_commit/w3c_html.rb) diff --git a/config/default.yml b/config/default.yml index 51189348..576ce478 100644 --- a/config/default.yml +++ b/config/default.yml @@ -842,6 +842,59 @@ PreCommit: install_command: 'gem install travis' include: '.travis.yml' + Vale: + enabled: false + command: "vale" + ad_hoc: + message_pattern: !ruby/regexp /^(?[^:]+):(?[0-9]+):/ + flags: + - '--output=line' + include: + # All known extensions for all supported formats are included + # (see https://docs.errata.ai/vale/scoping#formats), even + # the non-built-in ones that require additional software and/or + # configuration: they can be disabled easily using 'exclude': + - '**/*.adoc' + - '**/*.bsh' + - '**/*.c' + - '**/*.cc' + - '**/*.cpp' + - '**/*.cs' + - '**/*.css' + - '**/*.csx' + - '**/*.cxx' + - '**/*.dita' + - '**/*.java' + - '**/*.js' + - '**/*.go' + - '**/*.h' + - '**/*.hpp' + - '**/*.hs' + - '**/*.html' + - '**/*.less' + - '**/*.lua' + - '**/*.md' + - '**/*.php' + - '**/*.pl' + - '**/*.pm' + - '**/*.pod' + - '**/*.py' + - '**/*.py3' + - '**/*.pyi' + - '**/*.pyw' + - '**/*.R' + - '**/*.r' + - '**/*.rb' + - '**/*.rpy' + - '**/*.rst' + - '**/*.sass' + - '**/*.sbt' + - '**/*.scala' + - '**/*.swift' + - '**/*.txt' + - '**/*.xhtml' + - '**/*.xml' + Vint: enabled: false description: 'Analyze with Vint' From dda409854c71e70e4528d7ad1b346aa3d4eaad50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guillaume=20D=C3=A9flache?= Date: Mon, 11 Oct 2021 20:52:53 +0200 Subject: [PATCH 7/7] Adapt to latest configuration format changes --- config/default.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/config/default.yml b/config/default.yml index 576ce478..66707911 100644 --- a/config/default.yml +++ b/config/default.yml @@ -845,8 +845,7 @@ PreCommit: Vale: enabled: false command: "vale" - ad_hoc: - message_pattern: !ruby/regexp /^(?[^:]+):(?[0-9]+):/ + message_pattern: !ruby/regexp /^(?[^:]+):(?[0-9]+):/ flags: - '--output=line' include: