Skip to content

fix: Exit 1 with empty string if no match#901

Merged
nfischer merged 1 commit intoshelljs:masterfrom
wyardley:wyardley-issue_900_grep
Nov 13, 2018
Merged

fix: Exit 1 with empty string if no match#901
nfischer merged 1 commit intoshelljs:masterfrom
wyardley:wyardley-issue_900_grep

Conversation

@wyardley
Copy link
Copy Markdown
Contributor

@wyardley wyardley commented Nov 8, 2018 •
edited
Loading

Resolve an issue where grep returned 0 (with a \n as the output), even when the regex doesn't match.

Fixes #900

@wyardley
Copy link
Copy Markdown
Contributor Author

wyardley commented Nov 8, 2018 •
edited
Loading

@nfischer
The failure is on those other two test cases on line 39 and 48; seems to be returning both the original error, and the new one, even with that explicit return.

   38:   t.truthy(shell.error());                                          
   39:   t.is(result.stderr, 'grep: no such file or directory: /asdfasdf');
   40:   t.is(result.code, 2);                                             

  Difference:

  - `grep: no such file or directory: /asdfasdf␊
  - grep: `
  + `grep: no such file or directory: /asdfasdf

@nfischer
Copy link
Copy Markdown
Member

nfischer commented Nov 8, 2018

@wyardley can you add "Fixes #900" to the PR description?

nfischer
nfischer requested changes Nov 8, 2018
View reviewed changes
Copy link
Copy Markdown
Member

@nfischer nfischer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks pretty close so far. Let me know if explanations make sense, since we don't have much documentation on these common APIs.

Comment thread src/grep.js Outdated
Comment thread src/grep.js Outdated
Comment thread src/grep.js Outdated
@wyardley wyardley changed the title fix: Exit 1 with empty string if no match (#900) fix: Exit 1 with empty string if no match Nov 8, 2018
wyardley
wyardley commented Nov 8, 2018
View reviewed changes
Comment thread test/grep.js
t.is(result.toString(), 'this line ends in.js\nlllllllllllllllll.js\n');
});

test("one file, pattern doesn't match", t => {
Copy link
Copy Markdown
Contributor Author

@wyardley wyardley Nov 8, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want this under 'valids' or 'invalids?
Even though it's a non-0 exit code, I would personally consider testing for the absence of something to be a "valid" use case, but I'm happy to move it.

Copy link
Copy Markdown
Member

@nfischer nfischer Nov 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This spot LGTM

@wyardley
Copy link
Copy Markdown
Contributor Author

wyardley commented Nov 8, 2018 •
edited
Loading

@nfischer Ok, how's that look. I added another test case for the specific case where there are two files, one which dne and the other of which doesn't match. I can move this to the "Invalids" section if you think that's better (see above)...

@codecov-io
Copy link
Copy Markdown

codecov-io commented Nov 8, 2018 •
edited
Loading

Codecov Report

Merging #901 into master will increase coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #901      +/-   ##
==========================================
+ Coverage   97.32%   97.32%   +<.01%     
==========================================
  Files          34       34              
  Lines        1269     1271       +2     
==========================================
+ Hits         1235     1237       +2     
  Misses         34       34
Impacted Files Coverage Δ
src/grep.js 100% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6b3c7b1...163e049. Read the comment docs.

nfischer
nfischer approved these changes Nov 9, 2018
View reviewed changes
Copy link
Copy Markdown
Member

@nfischer nfischer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM % suggestions

Comment thread test/grep.js Outdated
Comment thread test/grep.js
t.is(result.toString(), 'this line ends in.js\nlllllllllllllllll.js\n');
});

test("one file, pattern doesn't match", t => {
Copy link
Copy Markdown
Member

@nfischer nfischer Nov 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This spot LGTM

Comment thread test/grep.js
@wyardley
fix: Exit 1 with no output if no match (#900)
163e049 
When we can read all files, but none match, exit 1 and return no output. This
matches the behavior of grep more closely.

Fixes #900
@wyardley
Copy link
Copy Markdown
Contributor Author

wyardley commented Nov 9, 2018

@nfischer applied your suggestions and squashed

@nfischer nfischer added the fix Bug/defect, or a fix for such a problem label Nov 9, 2018
@nfischer
Copy link
Copy Markdown
Member

nfischer commented Nov 13, 2018

Thanks. I'll merge this after I push a release (this probably constitutes a breaking change).

@nfischer nfischer merged commit 5da1dda into shelljs:master Nov 13, 2018
@wyardley wyardley deleted the wyardley-issue_900_grep branch November 13, 2018 05:37
@nfischer nfischer mentioned this pull request Dec 2, 2018
Merged
@Nel75
Copy link
Copy Markdown

Nel75 commented Apr 6, 2021 •
edited
Loading

Hi. This fix is still not available on the latest release v0.8.4, despite being on the master branch (https://github.com/shelljs/shelljs/blob/master/src/grep.js#L72-L75). What is its status? Was there an issue with its packaging? This fix is really needed, as the current grep implementation is broken - I would argue it's a fixing change rather than a breaking one, as anyone relying on exit code 1 to detect the absence of matches is currently broken. Thanks.

@nfischer nfischer added this to the v0.9.0 milestone Apr 6, 2021
@nfischer nfischer added the breaking Breaking change label Apr 6, 2021
@nfischer
Copy link
Copy Markdown
Member

nfischer commented Apr 6, 2021

I think this landed after v0.8.3 went out. v0.8.4 was a small patch release for a specific bug, which is why this didn't make it in that release either.

I've updated the milestone field to clarify this is expected to be part of v0.9.0. I haven't had time to figure out what needs to make it in that release and what should be punted to the next release.

@Nel75
Copy link
Copy Markdown

Nel75 commented Apr 9, 2021

@nfischer Thanks for the quick reply. Any idea when v0.9.0 might be released? It's been over 2 years now since this fix, so I'll have to use another script in the mean time.

@renovate renovate bot mentioned this pull request Apr 7, 2025
Open
1 task
@renovate renovate bot mentioned this pull request Jun 18, 2025
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nfischer nfischer nfischer approved these changes

Assignees

No one assigned

Labels

breaking Breaking change fix Bug/defect, or a fix for such a problem

Projects

None yet

Milestone

v0.9.0

Development

Successfully merging this pull request may close these issues.

grep exit status and extra newlines

4 participants

@wyardley @nfischer @codecov-io @Nel75