nailsapp/module-console

This is the "Console" module for Nails.

Console Module for Nails

This is the "Console" module for nails, it provides a centralsied touchpoint for command line based actions., _(*1)

http://nailsapp.co.uk/modules/console, _(*2)

This tool is simply a wrapper for the excellent Console Component provided by Symfony. It looks for valid Console compatible classes in each installed module's src/Console/Command directory and loads them into the main application., _(*3)

Defining Console Applications

Your module must be PSR-4 ready in order for the class to be loaded correctly. You should do this in the module's composer.json file. In addition you must also specify the module's root namespace in composer.json. Example:, _(*4)

{
    "name": "my-vendor/my-module",
    "homepage": "http://example.com",
    "description": "This is my excellent module for Nails",
    "autoload":
    {
        "psr-4": {"MyVendor\\MyModule\\": "src/"}
    },
    "extra":
    {
        "nails" :
        {
            "moduleName": "mymodule",
            "type": "module",
            "namespace": "MyVendor\\MyModule\\"
        }
    }
}

Example directory structure:, _(*5)

myvendor
|__ mymodule
|____ src
|______ Console
|________ Command
|__________ MyCommand.php
|__________ MyOtherCommand.php

Example Class (MyCommand.php), _(*6)

<?php

namespace MyVendor\MyModule\Console\Command;

class MyCommand
{
    protected function configure()
    {
        $this->setName('mymodule-mycommand');
        $this->setDescription('Does something exciting');
    }

    // --------------------------------------------------------------------------

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $output->writeln('Did something!');
    }
}

Note the definition of the command, try and make it something which won't likely clash with another installed module. Also note the namespace - the console wrapper will automatically append \Console\Command when loading the class., _(*7)

Roadmap

• [ ] Prevent or detect command collisions