Update for new Plugin changes

Author: nfischer

index.js

@@ -3,17 +3,11 @@ var plugin = require('shelljs/src/common');
 
 // Require whatever modules you need for your project
 var child = require('child_process');
-var shell = require('shelljs');
 var fs = require('fs');
 
 // Implement your command in a function, which takes an options string as the
 // first parameter
 function open(options, fileName) {
-  // Use the plugin utils to parse the options to only those options that are
-  // available (in this case, there are no available options
-  options = plugin.parseOptions(options, {
-  });
-
   var URL_REGEX = /^https?:\/\/.*/;
 
   if (!fs.existsSync(fileName) && !fileName.match(URL_REGEX)) {
@@ -30,11 +24,15 @@ function open(options, fileName) {
     // assume it's Mac OS X, which uses `open()`
     child.exec('open ' + JSON.stringify(fileName));
   }
-  return new shell.ShellString('', '', 0);
+  return '';
 }
 
 // Register the new plugin as a ShellJS command
-plugin.register('open', open, { globStart: 1 });
+plugin.register('open', open, {
+  globStart: 1,     // Start globbing at the first non-option argument
+  cmdOptions: {},   // No supported options
+  wrapOutput: true, // Wrap the output in a ShellString
+});
 
 // Optionally, you can export the implementation of the command like so:
 exports.open = open;

package.json

@@ -28,12 +28,12 @@
     "eslint-config-airbnb-base": "^4.0.2",
     "eslint-plugin-import": "^1.11.1",
     "mocha": "^2.5.3",
-    "shelljs": "0.7.1",
+    "shelljs": "0.7.2",
     "shelljs-changelog": "^0.2.2",
     "shelljs-release": "^0.2.0",
     "should": "^10.0.0"
   },
   "peerDependencies": {
-    "shelljs": "0.7.1"
+    "shelljs": "0.7.2"
   }
 }

test/test.js

@@ -1,28 +1,75 @@
 /* globals describe, it */
 
-// Steps for using a plugin:
-// First, you must load in ShellJS:
-var shell = require('shelljs');
-// After that, you can load the plugin:
-var pluginOpen = require('..');
 /*
+ * Using ShellJS Plugins:
+ *
+ * To learn how to use a ShellJS plugin, look for the comments following the
+ * slash-star/star-slash syntax.
+ */
+
+/*
+ * Load all your plugins first:
  * You can load a plugin with either of the following syntaxes:
  * `require('shelljs-plugin-open');` or
  * `var pluginOpen = require('shelljs-plugin-open');`
-*/
+ *
+ * Here, we've opted to save it in a variable, allowing us the option to use the
+ * bare function in addition to shell.open() (which includes helpful ShellJS
+ * features)
+ */
+var pluginOpen = require('..');
+// If we were using additional plugins, we could load them here
+
+/*
+ * After that, you must load in ShellJS itself, either locally (recommended) or
+ * globally (which still supported). For the purposes of testing this plugin,
+ * we're actually testing both ways of importing ShellJS (but you would never
+ * want to use ShellJS like this normally):
+ */
+var shell = require('shelljs'); // recommended
+require('shelljs/global');      // not recommended
 
-// Now, require whichever other modules you want to require:
+/*
+ * Now, require whichever other modules you want to require:
+ */
 require('should');
+var assert = require('assert');
 
 // override console.error() to cover up common.error() calls
 console.error = function () { };
 
 describe('plugin-open', function () {
   it('gets added to the shelljs instance', function () {
+    /*
+     * Plugins automatically add new commands to the ShellJS instance, such as
+     * shell.open()
+     */
     (typeof shell.open).should.equal('function');
   });
 
+  it('gets added to the global namespace for shelljs/global', function () {
+    /*
+     * Plugins are also compatible with using require('shelljs/global');
+     */
+    (typeof global.open).should.equal('function');
+    global.open.should.equal(shell.open);
+  });
+
+  it('does not override other commands or methods', function () {
+    /*
+     * Plugins shouldn't interfere with existing commands
+     */
+    (typeof shell.cp).should.equal('function');
+    (typeof shell.mv).should.equal('function');
+    shell.ls().should.have.property('toEnd');
+    shell.ls().should.have.property('grep');
+    shell.ls().should.have.property('sed');
+  });
+
   it('exports the plugin implementation', function () {
+    /*
+     * A plugin author can also export the implementation of their commands
+     */
     (typeof pluginOpen).should.equal('object');
     pluginOpen.should.have.property('open');
     (typeof pluginOpen.open).should.equal('function');
@@ -38,7 +85,7 @@ describe('plugin-open', function () {
   it('opens URLs', function () {
     var ret = shell.open('https://www.google.com');
     ret.code.should.equal(0);
-    ret.stderr.should.equal('');
+    assert.ok(!ret.stderr);
   });
 
   it('opens files asynchronously', function () {
@@ -47,13 +94,17 @@ describe('plugin-open', function () {
     // if this gets to this point, it must have been asynchronous
     ret.code.should.equal(0);
     ret.stdout.should.equal('');
-    ret.stderr.should.equal('');
+    assert.ok(!ret.stderr);
   });
 
   it('handles glob characters', function () {
+    /*
+     * Plugins can easily take advantage of ShellJS's built-in glob expansion.
+     * This is indicated by the globStart option
+     */
     var ret = shell.open('te?t/*st.js');
     ret.code.should.equal(0);
     ret.stdout.should.equal('');
-    ret.stderr.should.equal('');
+    assert.ok(!ret.stderr);
   });
 });