https://github.com/barcek/glep
grep across repos | cross-repository inspection | command-line tool | AWK (Gawk)
https://github.com/barcek/glep
awk command-line-tool dx gawk git shell
Last synced: about 1 month ago
JSON representation
grep across repos | cross-repository inspection | command-line tool | AWK (Gawk)
- Host: GitHub
- URL: https://github.com/barcek/glep
- Owner: barcek
- License: mit
- Created: 2023-04-10T10:18:14.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-09T21:24:47.000Z (4 months ago)
- Last Synced: 2025-02-11T11:53:00.152Z (3 months ago)
- Topics: awk, command-line-tool, dx, gawk, git, shell
- Language: Awk
- Homepage:
- Size: 59.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# glep
Grep across multiple git repositories.
Returns matching commit log entries or diff lines, or a specific full diff, for all git repositories in the parent directory. Includes a preview option for the key shell commands generated and a self-test.
## Why?
For insight and consistency across projects more quickly and simply.
## How?
The `glep` command takes one or more arguments, the search terms:
```
glep [ ...]
```
The default root directory is the parent - `../` - which is set close to the top of the source file. The terms are sought for the root directory, if a git repo, and for each top-level git repo in the root.
The search is performed by default in the output of `git log` using `--branches=*`, `--oneline` and `--format="%S | %as %an | %h %s"`, with the matching log entries printed preceded by the path to the given git repo.
The git repositories to be included can be listed with the `=list` or `=l` flag (see [Options](#options) below).
### Overriding the root
One term may be an alternative root directory, preceded by the two characters '=/':
```
glep =/[ ...]
```
### Setting output format
One term may also be an alternative format string, preceded by the two characters '=%':
```
glep =%[ ...]
```
This will be passed to `git log` with the `--format` flag to set the structure of each line of output.
### Filtering by author
One term may also be all or part of the commit author name, preceded by the two characters '=@':
```
glep =@[ ...]
```
This will be passed to `git log` with the `--author` flag to filter the results.
### Displaying a diff
One term may instead be a seven-character hexadecimal commit object name, preceded by the two characters '=#':
```
glep =#[ ...]
```
If this is the sole search term provided, the entire diff for that commit is shown, per `git show`. With additional search terms, only the matching lines of the diff are printed.
### Prefixes
- `=/` - an alternative root directory ('../' by default); secondary prefix `=>` also available
- `=%` - an alternative format string ('%S | %as %an | %h %s' by default)
- `=@` - the commit author
- `=#` - a seven-character hexadecimal commit object name
## Source
The script invokes itself and is assumed in doing so to have been made both executable, via a command like `chmod +x glep`, and available from any directory, e.g. by placing it in the '/bin' or '/usr/bin' directory.
The hashbang at the top of the file assumes the presence of Gawk in '/usr/bin', the source code that Gawk, several other utils and Git itself are installed and can be invoked directly, e.g. Git with `git`. A list can be found close to the top of the file, as well as in the help text.
### Defaults
The following sets of core default values are defined in the `defaults_set` function close to the base of the source file:
- `settings`, for the root directory and format string for output, and at runtime user-provided values
- `variants`, for the specially formatted search terms (`t`) and option flags (`f`)
### Making changes
Running the self-test after making changes plus extending or adding test cases to cover new behaviour is recommended. The self-test is run with the `=test` or `=T` flag (see [Options](#options) below). The test cases are set in the `test_perform` function at the base of the file.
## Options
The following can be passed to `glep` as if a search term:
- `=regexp-extended` / `=e`, to use extended regular expressions in search terms
- `=preview` / `=p`, to show the command for the root directory then exit
- `=list` / `=l`, to list the git repositories included, not searching
- `=version` / `=v`, to show name and version number then exit
- `=help` / `=h`, to show help text, incl. terms and flags, then exit
- `=test` / `=T`, to perform the self-test then exit
Note for all flags the use of the leading character `=`. Flags using the more common `-`/`--` are interpreted as options for Gawk itself.
## Development plan
The following are the expected next steps in the development of the code base. The general medium-term aim is a more configurable, portable and robust implementation. Pull requests are welcome for these and other potential improvements.
- add a +/- number and pre-/post-date term for commit range
- revise help text generation for listing order and width
- add automatic dependency checking with notification
- extend argument handling for short flag clustering
- allow for an alternative executable name