example_test.go

package verbs_test

import (
	"fmt"
	"os"

	"github.com/revl/verbs"
)

const programDescription = "" +
	"LightForge CLI is a command-line interface designed to control " +
	"architectural lighting systems in large installations such as " +
	"museums, hotels, and plazas. It allows lighting designers and " +
	"technicians to manage zones, colors, intensity, and automation " +
	"scenes directly from a terminal."

var tutorialText = programDescription + "\n\n" +
	"Connecting to a Lighting Controller\n" +
	"===================================\n\n" +
	"Before issuing control commands, connect to the central controller " +
	"on your network:\n\n" +
	"    $ lightforge connect 192.168.1.15:5020\n\n" +
	"Adjusting Lighting Settings\n" +
	"===========================\n\n" +
	"Zones are the basic units of lighting control. Each zone can be " +
	"assigned a color, intensity, and automation scene. To list " +
	"available zones, use the `list` command:\n\n" +
	"    $ lightforge zones list\n\n" +
	"To set the intensity of the \"Lobby\" zone to 75% and the color " +
	"to red:\n\n" +
	"    $ lightforge zone set Lobby --intensity 75 --color red\n\n" +
	"Creating and Running Scenes\n" +
	"===========================\n\n" +
	"Scenes store multiple settings for quick recall:\n\n" +
	"    $ lightforge scene create \"Evening Ambience\" \\\n" +
	"          --zone Lobby --zone Gallery \\\n" +
	"          --intensity 60 --color 220,180,150\n\n" +
	"To activate it later:\n\n" +
	"    $ lightforge scene activate \"Evening Ambience\"\n\n" +
	"For more information, run `lightforge help COMMAND` or\n" +
	"`lightforge COMMAND --help`."

type Args map[string][]string

var connectCommand = &verbs.Command{
	Name:    "connect",
	Summary: "Connect to a lighting system controller",
	Description: "Connect to the lighting system controller " +
		"using the provided host and port",
	Args: []*verbs.Arg{{Name: "ADDRESS"}},
	Tag: func(args Args) {
		fmt.Printf("Connecting to %s...\n", args["ADDRESS"][0])
	},
}

var zoneListCommand = &verbs.Command{
	Name:    "list",
	Summary: "List available zones",
	Description: "This command lists all zones registered " +
		"with the controller",
	Tag: func(_ Args) { fmt.Println("Listing zones...") },
}

var intensityOption = &verbs.Option{
	Name:        "i|intensity",
	Param:       "PERCENTAGE",
	Description: "The brightness of the zone",
	Tag:         "intensity",
}

var colorOption = &verbs.Option{
	Name:        "c|color",
	Param:       "COLOR",
	Description: "The color of the zone",
	Tag:         "color",
}

var zoneSetCommand = &verbs.Command{
	Name:        "set",
	Summary:     "Change zone settings",
	Description: "This command sets one or more properties of a zone",
	Options: []*verbs.Option{
		intensityOption,
		colorOption,
	},
	Args: []*verbs.Arg{{Name: "ZONE"}},
	Tag: func(args Args) {
		fmt.Printf("Changing zone settings... %s\n", args["ZONE"][0])
	},
}

var sceneCreateCommand = &verbs.Command{
	Name:    "create",
	Summary: "Create a new scene",
	Description: "This command creates a new scene with the given " +
		"name and settings",
	Options: []*verbs.Option{
		{
			Name:  "zones|zone",
			Param: "ZONE",
			Description: "The zone to create the scene for. " +
				"Multiple zones can be specified " +
				"by repeating the option.",
			Tag: "zone",
		},
		intensityOption,
		colorOption,
	},
	Args: []*verbs.Arg{{Name: "NAME"}},
	Tag: func(args Args) {
		fmt.Printf("Creating scene %s...\n", args["NAME"][0])
		fmt.Println("Zones:", args["zone"])
	},
}

var sceneActivateCommand = &verbs.Command{
	Name:        "activate",
	Summary:     "Activate a scene",
	Description: "This command activates a scene with the given name",
	Args:        []*verbs.Arg{{Name: "NAME"}},
	Tag: func(args Args) {
		fmt.Printf("Activating scene %s...\n", args["NAME"][0])
	},
}

var lightforgeCLI = &verbs.CLI{
	ProgramName: "lightforge",
	Summary:     "LightForge remote light management CLI",
	Description: programDescription,
	Version:     "1.0.0",
	Namespaces: []*verbs.Namespace{
		{
			Name:    "zones|zone",
			Summary: "Zone management",
			Commands: []*verbs.Command{
				zoneListCommand,
				zoneSetCommand,
			},
		},
		{
			Name:    "scenes|scene",
			Summary: "Scene management",
			Commands: []*verbs.Command{
				sceneCreateCommand,
				sceneActivateCommand,
			},
		},
	},
	Commands: []*verbs.Command{connectCommand},
	HelpTopics: []*verbs.HelpTopic{
		{Keyword: "tutorial", Text: tutorialText},
	},
}

func Example() {
	result := verbs.NewParser(lightforgeCLI).Parse(os.Args)

	args := make(Args)
	for _, arg := range result.OptsAndArgs {
		args[arg.Tag.(string)] = append(args[arg.Tag.(string)],
			arg.Value)
	}

	(result.Command.Tag).(func(Args))(args)
}