Add -B, -A, and -C options to grep by abluescarab · Pull Request #1206 · shelljs/shelljs

abluescarab · 2025-04-04T02:31:27Z

Adds the -B (before context) and -A (after context) options to grep. I may have gone overboard on tests but I wanted to make sure that most feasible configurations work (combined, separate, with space, without space).

Notes

Modifies globStart to accept a function with a parameter args. This allows -B and -A to be specified separately and a function to determine where the post-regex arguments begin.
Enforces these styles:
- .editorconfig: Single quotes in JavaScript files
- .eslintrc.json: radix option to off (don't require base for parseInt())
- package.json: Prettier arrowParens option to avoid (don't wrap single parameters in parentheses for arrow functions)

Usage

grep -B <num> [args...]
grep -A <num> [args...]

Examples

# show 3 lines before
grep -B3 string file1 file2 ...
grep -B 3 string file1 file2 ...

# show 2 lines after
grep -A2 string file1 file2 ...
grep -A 2 string file1 file2 ...

# show 3 lines before and 2 after
grep -B3A2 string file1 file2 ...
grep -B3 -A2 string file1 file2 ...

# show 3 lines before and after
grep -AB3 string file1 file2 ...
grep -AB 3 string file1 file2 ...

nfischer

Thanks for implementing this feature. I've provided some initial feedback that you can get started on now, but I'll need to spend more time reviewing this (expect more feedback later).

.editorconfig

package.json

src/common.js

test/grep.js

src/grep.js

codecov · 2025-04-05T03:42:32Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.46%. Comparing base (75d26de) to head (1fc99f6).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1206      +/-   ##
==========================================
+ Coverage   97.37%   97.46%   +0.08%     
==========================================
  Files          35       35              
  Lines        1410     1459      +49     
==========================================
+ Hits         1373     1422      +49     
  Misses         37       37

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

abluescarab · 2025-04-05T03:56:54Z

Sorry about the commit mess. I'm not sure why checks are failing on macos and ubuntu now.

nfischer · 2025-04-06T04:51:23Z

Sorry about the commit mess. I'm not sure why checks are failing on macos and ubuntu now.

Oh, this should be a simple fix. Can you run npm run gendocs in a terminal? This will regenerate README.md, then you can commit the README changes. That's probably the issue.

If that doesn't fix it, then try running the tests locally and run git status. It looks like there's some uncommitted file after the tests finish, and git status should tell you exactly what file that is.

abluescarab · 2025-04-06T05:02:35Z

Oh, this should be a simple fix. Can you run npm run gendocs in a terminal? This will regenerate README.md, then you can commit the README changes. That's probably the issue.

Hey, that worked, thanks! Hopefully everything looks good now.

src/grep.js

test/grep.js

src/grep.js

nfischer

LGTM, but with a few more suggestions.

Thanks for working on this feature!

test/grep.js

nfischer · 2025-05-09T19:20:18Z

Released in shelljs v0.10. Thanks for the contribution!

This adds support for shelljs/shelljs#1206. This requires special parsing logic on the shx side. Test: npm test Test: ./lib/cli.js grep -A 1 'foo' ~/foobartest.txt Test: cat ~/foobartest.txt | ./lib/cli.js grep -A 1 'foo'

abluescarab added 4 commits April 3, 2025 05:56

Enforce single quotes & avoid arrow parents; don't require radix

133b657

Allow function for globStart

7c748b0

Add -B and -A options to grep

bb55e73

Move args[0] === '--' to _getGlobStart()

b85d793

nfischer requested changes Apr 4, 2025

View reviewed changes

.editorconfig Show resolved Hide resolved

package.json Outdated Show resolved Hide resolved

src/common.js Outdated Show resolved Hide resolved

test/grep.js Outdated Show resolved Hide resolved

Removed single quote enforcement (separate PR)

01de423

nfischer reviewed Apr 5, 2025

View reviewed changes

src/grep.js Outdated Show resolved Hide resolved

Remove prettier options from package.json

923b1d1

abluescarab force-pushed the main branch from 85695e7 to 923b1d1 Compare April 5, 2025 03:41

abluescarab force-pushed the main branch from f155e36 to 923b1d1 Compare April 5, 2025 03:44

abluescarab added 5 commits April 4, 2025 20:44

REvert allowing function for globStart

3197a03

Simplify grep -B and -A tests

28ef136

Revert eslint changes

7ee8cd4

Parse grep options with default method

dfdf9b9

Removed contextOptions variable

1d304b2

abluescarab requested a review from nfischer April 5, 2025 06:13

Merge branch 'shelljs:main' into main

1b4f2fa

Added example to README

f7c4c8f

nfischer requested changes Apr 6, 2025

View reviewed changes

src/grep.js Show resolved Hide resolved

src/grep.js Show resolved Hide resolved

test/grep.js Outdated Show resolved Hide resolved

test/grep.js Outdated Show resolved Hide resolved

src/grep.js Show resolved Hide resolved

nfischer added feature bash compat Compatibility issues with bash or POSIX behavior labels Apr 6, 2025

abluescarab added 4 commits April 6, 2025 20:55

Add object-style grep -B example

53fd292

Add explanatory comment for context options

41a78c5

Combine overlapping matches; remove -AB in prep for -C

1f04d19

Add -C option to grep

d47ad62

abluescarab requested a review from nfischer April 8, 2025 00:15

nfischer approved these changes Apr 10, 2025

View reviewed changes

src/grep.js Show resolved Hide resolved

src/grep.js Show resolved Hide resolved

nfischer added this to the v0.10.0 milestone Apr 10, 2025

nfischer approved these changes Apr 13, 2025

View reviewed changes

test/grep.js Show resolved Hide resolved

test/grep.js Show resolved Hide resolved

abluescarab added 4 commits April 15, 2025 18:31

Move options.context populating out of loop

3f0f67b

Ensure -A/B/C 0 works; throw error on negative context values

ff762e0

Merge branch 'main' of https://github.com/shelljs/shelljs

bf56257

Fixed linting errors

1fc99f6

nfischer approved these changes Apr 19, 2025

View reviewed changes

nfischer merged commit bfd06fa into shelljs:main Apr 19, 2025
11 checks passed

nfischer changed the title ~~Add -B and -A options to grep~~ Add -B, -A, and -C options to grep Apr 19, 2025

nfischer mentioned this pull request May 9, 2025

feat: support option parsing for grep -C flag shelljs/shx#236

Merged

Conversation

abluescarab commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Notes

Usage

Examples

Uh oh!

nfischer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Apr 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

abluescarab commented Apr 5, 2025

Uh oh!

nfischer commented Apr 6, 2025

Uh oh!

abluescarab commented Apr 6, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nfischer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nfischer commented May 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

abluescarab commented Apr 4, 2025 •

edited

Loading

codecov bot commented Apr 5, 2025 •

edited

Loading