goplus

command module
v0.0.0-...-df99a90 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 8, 2016 License: MIT Imports: 6 Imported by: 0

README

goplus License

License

The MIT License (MIT)

Install

go get github.com/mkideal/goplus

TODOs

  • More application template
  • Complete publish command

Getting started

goplus binds all commands of local go program. So you can use goplus instead of go , e.g.

goplus build
goplus install
goplus test
goplus run
goplus fmt
......

goplus has some new commands, e.g.

goplus new
goplus publish
......
new command

new command creates a protect. Following command will generate a dir hello at current dir. Dir hello contains one file: main.go.

$> goplus new hello
$> cd hello
$> cat -n main.go
     1	package main
     2	
     3	import (
     4		"github.com/mkideal/cli"
     5	)
     6	
     7	type argT struct {
     8		cli.Helper
     9	}
    10	
    11	func (argv *argT) Validate(ctx *cli.Context) error {
    12		//TODO: validate something or remove this function.
    13		return nil
    14	}
    15	
    16	func run(ctx *cli.Context, argv *argT) error {
    17		//TODO: do something here
    18		return nil
    19	}
    20	
    21	func main() {
    22		cli.Run(new(argT), func(ctx *cli.Context) error {
    23			argv := ctx.Argv().(*argT)
    24			if argv.Help {
    25				ctx.WriteUsage()
    26				return nil
    27			}
    28			return run(ctx, argv)
    29		})
    30	}

You can specify what type your application. The TYPE must be one of these:

basic
tree
http

default is basic.

Following command will generate a command tree application.

$> goplus new -t tree treesample
$> cd treesample
$> cat -n main.go
     1	package main
     2	
     3	import (
     4		"fmt"
     5		"os"
     6	
     7		"github.com/mkideal/cli"
     8	)
     9	
    10	func main() {
    11		if err := cli.Root(root,
    12			cli.Tree(help),
    13			cli.Tree(version),
    14		).Run(os.Args[1:]); err != nil {
    15			fmt.Fprintln(os.Stderr, err)
    16			os.Exit(1)
    17		}
    18	}
    19	
    20	//--------------
    21	// root command
    22	//--------------
    23	
    24	type rootT struct {
    25		cli.Helper
    26	}
    27	
    28	var root = &cli.Command{
    29		Name: os.Args[0],
    30		//Desc: "describe the app",
    31		Argv: func() interface{} { return new(rootT) },
    32	
    33		Fn: func(ctx *cli.Context) error {
    34			argv := ctx.Argv().(*rootT)
    35			if argv.Help || len(ctx.Args()) == 0 {
    36				ctx.WriteUsage()
    37				return nil
    38			}
    39	
    40			//TODO: do something
    41			return nil
    42		},
    43	}
    44	
    45	//--------------
    46	// help command
    47	//--------------
    48	
    49	var help = cli.HelpCommand("display help")
    50	
    51	//-----------------
    52	// version command
    53	//-----------------
    54	
    55	const appVersion = "v0.0.1"
    56	
    57	var version = &cli.Command{
    58		Name: "version",
    59		Desc: "display version",
    60	
    61		Fn: func(ctx *cli.Context) error {
    62			ctx.String(appVersion + "\n")
    63			return nil
    64		},
    65	}

Try

$> goplus new -t http httpserver
$> cd httpserver
$> go build
$> ./httpserver daemon
$> curl http://127.0.0.1:8080/help
Commands:
  help     display help
  daemon   startup app as daemon
  api      display all api
$> curl http://127.0.0.1:8080/api
Commands:
    ping
$> curl http://127.0.0.1:8080/api/ping
pong

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
api

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL