Skip to content

Feature: Expose Error Code #1036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 15, 2022
Merged

Feature: Expose Error Code #1036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
51de362
feat: expose error code
JessieFrance Jun 24, 2021
f4c9643
use errorCode() in a test
JessieFrance Jun 24, 2021
90e8c8c
test(errorCode): test for when code is 0
JessieFrance Jul 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -742,6 +742,11 @@ return value to be an error message. If you need the last error message, use
the `.stderr` attribute from the last command's return value instead.


### errorCode()

Returns the error code from the last command.


### ShellString(str)

Examples:
Expand Down
3 changes: 3 additions & 0 deletions shell.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ exports.exit = process.exit;
//@include ./src/error.js
exports.error = require('./src/error');

//@include ./src/errorCode.js
exports.errorCode = require('./src/errorCode');

//@include ./src/common.js
exports.ShellString = common.ShellString;

Expand Down
10 changes: 10 additions & 0 deletions src/errorCode.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
var common = require('./common');

//@
//@ ### errorCode()
//@
//@ Returns the error code from the last command.
function errorCode() {
return common.state.errorCode;
}
module.exports = errorCode;
1 change: 1 addition & 0 deletions test/grep.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ test('no args', t => {
const result = shell.grep();
t.truthy(shell.error());
t.is(result.code, 2);
t.is(shell.errorCode(), 2);
});

test('too few args', t => {
Expand Down
1 change: 1 addition & 0 deletions test/ls.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ test('it\'s ok to use no arguments', t => {
const result = shell.ls();
t.falsy(shell.error());
t.is(result.code, 0);
t.is(shell.errorCode(), 0);
});

test('root directory', t => {
Expand Down