Ok, thread has been hijacked.

I'd like to strongly vote against plugin.use(shell, 'git'). I think that shell.use is OK, I don't think it would cause problems. (See shell.config, shell.ShellString).

I'm not sure about the global namespace, adding tons of globals seems bad, but it is useful.

Here's an idea, which would make the non-global option easier: What if we renamed shell to $. Ex:

var $ = require('shelljs');
$.ls('foo');

@levithomason: As for what's happening with the Plugin/subcmd, here's a more annotated example (I was on mobile):

// git.js
var $ = require('shelljs');
var plugin = require('shelljs/plugin');

// WARNING: This is quite literally the first think I came up with in 30 seconds typing
// on an iPhone. It's totally not set in stone.

// plugin.Plugin is a class (or maybe a factory). It's the base class for all plugins.
// It's pretty self-contained, and does basically nothing.
// plugin.Command is a subclass of plugin.Plugin. It defines a plugin which can
// called as a function.
// In the future, we could add additional plugin types.
// In this example, `shell.git`, WOULD NOT be the Plugin instance, it would be
// something else.

// First, have the actual code.
function _checkout(file) {
    // ...
}

function _track(file) {
    // ...
} 

// Next, create the initial plugin instance. We export it so that we can `shell.use`
// it later.
var git = module.exports = plugin.Plugin('git', opts);

// Now create another plugin (in this case a command), for `git checkout`
var checkout = plugin.Command('checkout', _checkout, { idx: 1 });

// Now, mount `checkout` on `git`.
git.subcmd(checkout);

// Here's an example of a sub-sub-command: `git lfs track`  (It was the first thing
// I could think of, it's GitHub's solution for large files).

// First, create the plugin
var lfs = plugin.Plugin('lfs', opts); // Again, `git.lfs()` is invalid.

// Then, create the command.
var track = plugin.Command('track', _track, {idx: 0});

// Then, mount it.
lfs.subcmd(track);
git.subcmd(lfs);



// index.js
var $ = require('shelljs');
$.use('git') // shorthand for $.use(require('shelljs-plugin-git'))

$.git.checkout(opts, "foo");
$.git.lfs.track('bar');
$.git.lfs(); // TypeError
$.git(); // TypeError


// For global mode, nothing about the plugin changes.
// index-global.js
require('shelljs/global'); // This now defines global.$ = require('shelljs');
$.use('git'); // We don't define a global 'use', so nothing changes.

// Now we define global.git = global.$.git, so this works:
git.checkout('foo');
git.lfs.track('foo');
$.git.checkout('foo');
$.git.lfs.track('foo');
git.lfs(); // TypeError
git(); // TypeError

Plugin System. #391

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions