git

A git mock app built on top of switchit

This command attempts to implement a mock version of git to demonstrate how it could be built on top of switchit.

Showcased features

• Optional and required switches (See pull.js)
• Nested command hierarchy (Available command containers: remote, submodule. See index.js)
• Custom aliases (Try running node git.js ?)
• Default container sub-command (Try running node git.js remote, see remote/index.js)
• Built-in help command

How to run this example

Use ../git.js:

$ node git.js  
 Git: the simple content tracker
 Syntax
   git [command]           Executes a command
 
 Available commands (»: has sub-commands):
   · commit                  Commits current changes
   · fetch                   Fetches changes from a remote
   · pull                    Pulls changes from a remote branch
   · remote »                Commands to manage remote references
   · submodule »             Initialize, update or inspect submodules
 
 Run git Help [command] for more information on a command.

How it works

../git.js includes the Git class from index.js and starts the example:

const Git = require('./git/index.js');
const git = new Git();

// This will catch any errors and only log the error message
// (instead of dumping the whole object to the console)
git.run().catch(err => {
    console.error(err.message);
    process.exit(1);
});

The Git class (located at index.js) requires all available commands as well as the built-in Help command, then defines itself as a subclass of Container.

const {
    Container,
    Help
} = require('../../index.js');

const Commit = require('./commit');
const Fetch = require('./fetch');
const Pull = require('./pull');
const Remote = require('./remote');

class Git extends Container {
    //
}

Git.define({
    title: 'git',
    help: 'the simple content tracker',
    commands: {
        '?': 'help',
        help: Help,
        commit: Commit,
        fetch: Fetch,
        pull: Pull,
        remote: Remote,
        submodule: Submodule
    }
});

module.exports = Git;