refactor: code cleanup for the --negate flag

No change to logic. This is a small refactor/cleanup for the '--negate'
option added in PR #189.

This also adds documentation to the README.

Author: nfischer

README.md

@@ -60,7 +60,7 @@ $ shx rm -r sub                 # options work as well
 
 $ shx --silent ls fakeFileName  # silence error output
 
-$ shx --negate test -d dir      # Negate status code output for boolean conditions
+$ shx --negate test -d dir      # Negate status code output (e.g., failed commands will now have status 0)
 ```
 
 All commands internally call the ShellJS corresponding function, guaranteeing
@@ -149,6 +149,9 @@ supported options:
 | `-v` | `config.verbose = true` | `shx --verbose cd foo` | Log the command as it's run |
 | `-f` | `config.noglob = true` | `shx --noglob cat '*.txt'` | Don't expand wildcards |
 | N/A | `config.silent = true` | `shx --silent cd noexist` | Don't show error output |
+| N/A | N/A | `shx --help` | Show help text |
+| N/A | N/A | `shx --version` | Print the shx version |
+| N/A | N/A | `shx --negate test -d dir` | Runs the specified command but negates the exit status (failed command = status 0, successful command = status 1) |
 
 ## Team
 

test/specs/cli.js

@@ -145,12 +145,11 @@ describe('cli', () => {
 
     it('uses --negate to "NOT" a "0 output ', () => {
       const withoutNegate = cli('true');
-      // Sanity check
       withoutNegate.code.should.equal(0);
-      // Minifist opts.boolean always treat --* as boolean
-      // Thus only using "--negate true" will be interpreted as "--negate=true"
-      // without any actual command. Hence --negate true true
-      const withNegate = cli('--negate', 'true', 'true');
+      // We need an extra '--' otherwise Minimist will interprt this like `shx
+      // --negate=true` without invoking the actual 'true' subcommand. This is
+      // because of Minimist's opts.boolean option.
+      const withNegate = cli('--negate', '--', 'true');
       withNegate.stdout.should.equal('');
       withNegate.stderr.should.equal('');
       withNegate.code.should.equal(1);
@@ -160,8 +159,9 @@ describe('cli', () => {
       const output = cli('help');
       output.stderr.should.equal('');
       output.stdout.should.match(/Usage/); // make sure help is printed
-      output.stdout.should.match(/\* --verbose/);
+      output.stdout.should.match(/\* --negate/);
       output.stdout.should.match(/\* --silent/);
+      output.stdout.should.match(/\* --verbose/);
       output.stdout.should.match(/\* --version/);
     });
   });