Skip to content
Syntax-aware grep for PHP code
Go
Branch: master
Clone or download
Latest commit 220d897 Aug 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmd/phpgrep cmd/phpgrep: add -memprofile and -cpuprofile flags Aug 15, 2019
.travis.yml
LICENSE Create LICENSE Jun 28, 2019
README.md Update README.md Aug 17, 2019
compile.go add "func" meta node Aug 15, 2019
doc.go add more missing matcher ops Jul 26, 2019
filters.go implement '=', '!=', '~' and '!~' filters Jul 25, 2019
go.mod provide AST-based operations Jul 30, 2019
go.sum provide AST-based operations Jul 30, 2019
matcher.go add "func" meta node Aug 15, 2019
matcher_test.go add "func" meta node Aug 15, 2019
meta_nodes.go add "func" meta node Aug 15, 2019
pattern_language.md add "func" meta node Aug 15, 2019
phpgrep.go speedup phpgrep with concurrent workers Aug 14, 2019
utils.go fix more nil derefs (due to nil positions) Aug 15, 2019

README.md

phpgrep

Go Report Card GoDoc Build Status

Syntax-aware grep for PHP code.

This repository is used for the library and command-line tool development. A good source for additional utilities and ready-to-run recipes is phpgrep-contrib repository.

Overview

phpgrep is both a library and a command-line tool.

Library can be used to perform syntax-aware PHP code matching inside Go programs while binary utility can be used from your favorite text editor or terminal emulator.

It's very close to structural search and replace in PhpStorm, but better suited for standalone usage.

In many ways, inspired by github.com/mvdan/gogrep/.

NOTE: this software in active development phase. Many major things are not implemented yet.

See also: "phpgrep: syntax aware code search".

Quick start

To install phpgrep binary under your $(go env GOPATH)/bin:

go get -v github.com/quasilyte/phpgrep/cmd/phpgrep

If $GOPATH/bin is under your system $PATH, phpgrep command should be available after that.
This should print the help message:

$ phpgrep -help
Usage: phpgrep [flags...] target pattern [filters...]
Where:
  flags are command-line flags that are listed in -help (see below)
  target is a file or directory name where search is performed
  pattern is a string that describes what is being matched
  filters are optional arguments bound to the pattern

Examples:
  # Find f calls with a single varible argument.
  phpgrep file.php 'f(${"var"})'
  # Like previous example, but searches inside entire
  # directory recursively and variable names are restricted
  # to $id, $uid and $gid.
  # Also uses -v flag that makes phpgrep output more info.
  phpgrep -v ~/code/php 'f(${"x:var"})' 'x=id,uid,gid'

Exit status:
  0 if something is matched
  1 if nothing is matched
  2 if error occured

# ... rest of output

Create a test file hello.php:

<?php
function f(...$xs) {}
f(10);
f(20);
f(30);
f($x);
f();

Run phpgrep over that file:

# phpgrep hello.php 'f(${"x:int"})' 'x!=20'
hello.php:3: f(10)
hello.php:5: f(30)

We found all f calls with a single argument x that is int literal not equal to 20.

Next thing to learn is ${"*"} matcher.

Suppose you need to match all foo function calls that have null argument.
foo is variadic, so it's unknown where that argument can be located.

This pattern will match null arguments at any position: foo(${"*"}, null, ${"*"}).

Read pattern language docs to learn more about how to write search patterns.

Recipes

This section contains ready-to-use phpgrep patterns.

srcdir is a target source directory (can also be a single filename).

Useful recipes

# Find arrays with at least 1 duplicated key.
$ phpgrep srcdir '[${"*"}, $k => $_, ${"*"}, $k => $_, ${"*"}]'

# Find where ?: can be applied.
$ phpgrep srcdir '$x ? $x : $y' # Use `$x ?: $y` instead

# Find potential operator precedence issues.
$ phpgrep srcdir '$x & $mask == $y' # Should be ($x & $mask) == $y
$ phpgrep srcdir '$x & $mask != $y' # Should be ($x & $mask) != $y

# Find calls where func args are misplaced.
$ phpgrep srcdir 'stripos(${"str"}, $_)'
$ phpgrep srcdir 'explode($_, ${"str"}, ${"*"})

# Find new calls without parentheses.
$ phpgrep srcdir 'new $t'

# Find all if statements with a body without {}.
$ phpgrep srcdir 'if ($cond) $x' 'x!~^\{'
# Or without regexp.
$ phpgrep srcdir 'if ($code) ${"expr"}'

# Find all error-supress operator usages.
$ phpgrep srcdir '@$_'

Miscellaneous recipes

# Find all function calls that have at least one var-argument that has _id suffix.
$ phpgrep srcdir '$f(${"*"}, ${"x:var"}, ${"*"})' 'x~.*_id$'
You can’t perform that action at this time.