Add initial support for phpcs and php lint (#507) · githubFeature/overcommit@09f0550 · GitHub
Skip to content

Commit 09f0550

Browse files
craig-davissds
craig-davis
authored and
sds
committed
Add initial support for phpcs and php lint (sds#507)
* Add initial support for phpcs and php lint Add two new linters: * PHP Lint via the 'php -l' command to check for valid php syntax and confirm that the file will compile * PHP Code Sniffer via 'phpcs' to check for style problems This can later be followed by other php tooling, but these are the most common and are a good starting point. * Rename phpcs hook to pass proper camelcase convention
1 parent 3de81fd commit 09f0550

6 files changed

Lines changed: 217 additions & 0 deletions

File tree

‎.gitignore‎

Lines changed: 1 addition & 0 deletions

‎config/default.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -448,6 +448,21 @@ PreCommit:
448448
install_command: 'pip install pep8'
449449
include: '**/*.py'
450450

451+
PhpLint:
452+
enabled: false
453+
description: 'Testing with PHP lint'
454+
required_executable: 'php'
455+
command: 'php'
456+
flags: ['-l']
457+
include: '**/*.php'
458+
459+
PhpCs:
460+
enabled: false
461+
description: 'Analyze with PHP_CodeSniffer'
462+
command: 'vendor/bin/phpcs'
463+
flags: ['--standard=PSR2', '--report=csv']
464+
include: '**/*.php'
465+
451466
Pronto:
452467
enabled: false
453468
description: 'Analyzing with pronto'

‎lib/overcommit/hook/pre_commit/php_cs.rb‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
module Overcommit::Hook::PreCommit
2+
# Runs `phpcs` against any modified PHP files.
3+
class PhpCs < Base
4+
# Parse `phpcs` csv mode output
5+
MESSAGE_REGEX = /^\"(?<file>.+)\",(?<line>\d+),\d+,(?<type>.+),\"(?<msg>.+)\"/
6+
MESSAGE_TYPE_CATEGORIZER = lambda do |type|
7+
'error'.include?(type) ? :error : :warning
8+
end
9+
10+
def run
11+
messages = []
12+
13+
applicable_files.each do |file|
14+
result = execute(command, args: [file])
15+
if result.status
16+
rows = result.stdout.split("\n")
17+
18+
# Discard the csv header
19+
rows.shift
20+
21+
# Push each of the errors in the particular file into the array
22+
rows.map do |row|
23+
messages << row
24+
end
25+
end
26+
end
27+
28+
return :pass if messages.empty?
29+
30+
parse_messages(messages)
31+
end
32+
33+
# Transform the CSV output into a tidy human readable message
34+
def parse_messages(messages)
35+
output = []
36+
37+
messages.map do |message|
38+
message.scan(MESSAGE_REGEX).map do |file, line, type, msg|
39+
type = MESSAGE_TYPE_CATEGORIZER.call(type)
40+
text = " #{file}:#{line}\n #{msg}"
41+
output << Overcommit::Hook::Message.new(type, file, line.to_i, text)
42+
end
43+
end
44+
45+
output
46+
end
47+
end
48+
end

‎lib/overcommit/hook/pre_commit/php_lint.rb‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
module Overcommit::Hook::PreCommit
2+
# Runs `php -l` against any modified PHP files.
3+
class PhpLint < Base
4+
# Sample String
5+
# rubocop:disable Metrics/LineLength
6+
# PHP Parse error: syntax error, unexpected 'require_once' (T_REQUIRE_ONCE) in site/sumo.php on line 12
7+
# rubocop:enable Metrics/LineLength
8+
MESSAGE_REGEX = /^(?<type>.+)\:\s+(?<message>.+) in (?<file>.+) on line (?<line>\d+)/
9+
10+
def run
11+
# A list of error messages
12+
messages = []
13+
14+
# Exit status for all of the runs. Should be zero!
15+
exit_status_sum = 0
16+
17+
# Run for each of our applicable files
18+
applicable_files.each do |file|
19+
result = execute(command, args: [file])
20+
output = result.stdout.chomp
21+
exit_status_sum += result.status
22+
if result.status
23+
# `php -l` returns with a leading newline, and we only need the first
24+
# line, there is usually some redundancy
25+
messages << output.lstrip.split("\n").first
26+
end
27+
end
28+
29+
# If the sum of all lint status is zero, then none had exit status
30+
return :pass if exit_status_sum == 0
31+
32+
# No messages is great news for us
33+
return :pass if messages.empty?
34+
35+
# Return the list of message objects
36+
extract_messages(
37+
messages,
38+
MESSAGE_REGEX
39+
)
40+
end
41+
end
42+
end

‎spec/overcommit/hook/pre_commit/php_lint_spec.rb‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
require 'spec_helper'
2+
3+
describe Overcommit::Hook::PreCommit::PhpLint do
4+
let(:config) { Overcommit::ConfigurationLoader.default_configuration }
5+
let(:context) { double('context') }
6+
subject { described_class.new(config, context) }
7+
8+
before do
9+
subject.stub(:applicable_files).and_return(['sample.php'])
10+
end
11+
12+
context 'when php lint exits successfully' do
13+
before do
14+
result = double('result')
15+
result.stub(:status).and_return(0)
16+
result.stub(:success?).and_return(true)
17+
result.stub(:stdout).and_return('No syntax errors detected in sample.php')
18+
subject.stub(:execute).and_return(result)
19+
end
20+
21+
it { should pass }
22+
end
23+
24+
context 'when php lint exits unsuccessfully' do
25+
before do
26+
# php -l prints the same to both stdout and stderr
27+
# rubocop:disable Metrics/LineLength
28+
sample_output = [
29+
'',
30+
"Parse error: syntax error, unexpected '0' (T_LNUMBER), expecting variable (T_VARIABLE) or '{' or '$' in sample.php on line 3 ",
31+
'Errors parsing invalid.php',
32+
].join("\n")
33+
# rubocop:enable Metrics/LineLength
34+
35+
result = double('result')
36+
result.stub(:status).and_return(255)
37+
result.stub(:success?).and_return(false)
38+
result.stub(:stdout).and_return(sample_output)
39+
result.stub(:stderr).and_return(sample_output)
40+
subject.stub(:execute).and_return(result)
41+
end
42+
43+
it { should fail_hook }
44+
end
45+
end

‎spec/overcommit/hook/pre_commit/phpcs_spec.rb‎

Lines changed: 66 additions & 0 deletions

0 commit comments

Comments
 (0)