diff --git a/README.md b/README.md index e1c3911b..ab023c7e 100644 --- a/README.md +++ b/README.md @@ -498,6 +498,7 @@ issue](https://github.com/sds/overcommit/issues/238) for more details. * [CoffeeLint](lib/overcommit/hook/pre_commit/coffee_lint.rb) * [Credo](lib/overcommit/hook/pre_commit/credo.rb) * [CssLint](lib/overcommit/hook/pre_commit/css_lint.rb) +* [DartAnalyzer](lib/overcommit/hook/pre_commit/dart_analyzer.rb) * [Dogma](lib/overcommit/hook/pre_commit/dogma.rb) * [ErbLint](lib/overcommit/hook/pre_commit/erb_lint.rb) * [EsLint](lib/overcommit/hook/pre_commit/es_lint.rb) diff --git a/config/default.yml b/config/default.yml index 748476e8..7207ade6 100644 --- a/config/default.yml +++ b/config/default.yml @@ -266,6 +266,14 @@ PreCommit: install_command: 'npm install -g csslint' include: '**/*.css' + DartAnalyzer: + enabled: false + description: 'Analyze with dartanalyzer' + required_executable: 'dartanalyzer' + flags: [] + include: + - '**/*.dart' + Dogma: enabled: false description: 'Analyze with dogma' diff --git a/lib/overcommit/hook/pre_commit/dart_analyzer.rb b/lib/overcommit/hook/pre_commit/dart_analyzer.rb new file mode 100644 index 00000000..a1c99448 --- /dev/null +++ b/lib/overcommit/hook/pre_commit/dart_analyzer.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module Overcommit::Hook::PreCommit + # Runs `dartanalyzer` against modified Dart files. + # @see https://dart.dev/tools/dartanalyzer + class DartAnalyzer < Base + MESSAGE_REGEX = /(?.*)•\ (?[^•]+)•\ (?[^:]+):(?\d+):(\d+)\.*/ + + def run + result = execute(command, args: applicable_files) + return :pass if result.success? + + extract_messages( + result.stdout.split("\n").grep(MESSAGE_REGEX), + MESSAGE_REGEX, + lambda do |type| + type.include?('error') ? :error : :warning + end + ) + end + end +end diff --git a/spec/overcommit/hook/pre_commit/dart_analyzer_spec.rb b/spec/overcommit/hook/pre_commit/dart_analyzer_spec.rb new file mode 100644 index 00000000..1013c503 --- /dev/null +++ b/spec/overcommit/hook/pre_commit/dart_analyzer_spec.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe Overcommit::Hook::PreCommit::DartAnalyzer do + let(:config) { Overcommit::ConfigurationLoader.default_configuration } + let(:context) { double('context') } + subject { described_class.new(config, context) } + + before do + subject.stub(:applicable_files).and_return(%w[file1.dart file2.dart]) + end + + context 'when dartanalyzer exits successfully' do + before do + result = double('result') + result.stub(:success?).and_return(true) + subject.stub(:execute).and_return(result) + end + + it { should pass } + end + + context 'when dartanalyzer exits unsucessfully' do + let(:result) { double('result') } + + before do + result.stub(:success?).and_return(false) + subject.stub(:execute).and_return(result) + end + + context 'and it reports an error' do + before do + result.stub(:stdout).and_return([ + 'Analyzing file1.dart...', + 'error • message_ommitted • lib/file1.dart:35:3 • rule', + 'Analyzing file2.dart...', + 'hint • message_ommitted • lib/file2.dart:100:13 • rule', + 'info • message_ommitted • lib/file2.dart:113:16 • rule', + '3 lints found.' + ].join("\n")) + end + + it { should fail_hook } + end + end +end