Merge pull request #833 from devlights/add-flag-subcommand-example

Author: devlights

examples/basic/flags/README.md

@@ -2,14 +2,15 @@
 
 このディレクトリには以下のサンプルがあります。
 
-| file        | example name   | note                                                              |
-| ----------- | -------------- | ----------------------------------------------------------------- |
-| flagset.go  | flags_flagset  | flag.Flagset のサンプルです                                       |
-| var.go      | flags_var      | flag.Var() のサンプルです                                         |
-| int.go      | flags_int      | flag.Int(), flag.IntVar() のサンプルです                          |
-| bool.go     | flags_bool     | flag.Bool(), flag.BoolVar() のサンプルです                        |
-| string.go   | flags_string   | flag.String(), flag.StringVar() のサンプルです                    |
-| duration.go | flags_duration | flag.Duration(), flag.DurationVar() のサンプルです                |
-| func.go     | flags_func     | flag.Func() のサンプルです                                        |
-| textvar.go  | flags_textvar  | flag.TextVar() のサンプルです                                     |
-| nargs.go    | flags_nargs    | flag.Arg(), flag.Args(), flag.NArg(), flag.NFlag() のサンプルです |
+| file          | example name     | note                                                              |
+| ------------- | ---------------- | ----------------------------------------------------------------- |
+| flagset.go    | flags_flagset    | flag.Flagset のサンプルです                                       |
+| var.go        | flags_var        | flag.Var() のサンプルです                                         |
+| int.go        | flags_int        | flag.Int(), flag.IntVar() のサンプルです                          |
+| bool.go       | flags_bool       | flag.Bool(), flag.BoolVar() のサンプルです                        |
+| string.go     | flags_string     | flag.String(), flag.StringVar() のサンプルです                    |
+| duration.go   | flags_duration   | flag.Duration(), flag.DurationVar() のサンプルです                |
+| func.go       | flags_func       | flag.Func() のサンプルです                                        |
+| textvar.go    | flags_textvar    | flag.TextVar() のサンプルです                                     |
+| nargs.go      | flags_nargs      | flag.Arg(), flag.Args(), flag.NArg(), flag.NFlag() のサンプルです |
+| subcommand.go | flags_subcommand | flagパッケージを使ってサブコマンドを実現するサンプルです          |

examples/basic/flags/examples.go

@@ -22,4 +22,5 @@ func (r *register) Regist(m mapping.ExampleMapping) {
 	m["flags_func"] = Func
 	m["flags_textvar"] = TextVar
 	m["flags_nargs"] = Nargs
+	m["flags_subcommand"] = Subcommand
 }

examples/basic/flags/subcommand.go

@@ -0,0 +1,74 @@
+package flags
+
+import (
+	"flag"
+	"fmt"
+)
+
+// Subcommand は、flagパッケージを使ってサブコマンドを実現するサンプルです.
+//
+// flagパッケージを使って、サブコマンドを実現する場合は
+// flag.FlagSetでそれぞれのサブコマンドを表現する。
+//
+// サブコマンドの数が多い場合や細かな制御などをしたい場合は
+// [flaggy](https://github.com/integrii/flaggy) などの外部ライブラリを利用する方が楽。
+//
+// flaggyのサンプルについては [try-golang-extlib](https://github.com/devlights/try-golang-extlib/tree/main/examples/singleapp/flaggy) を参照。
+//
+// # REFERENCES
+//   - https://oohira.github.io/gobyexample-jp/command-line-subcommands.html
+//   - https://pkg.go.dev/flag
+//   - https://github.com/integrii/flaggy
+func Subcommand() error {
+	var (
+		sub1 = flag.NewFlagSet("sub1", flag.ExitOnError) // サブコマンド
+		sub2 = flag.NewFlagSet("sub2", flag.ExitOnError) // サブコマンド
+
+		sub1BoolVal bool
+		sub2IntVal  int
+	)
+	sub1.BoolVar(&sub1BoolVal, "enable", false, "bool flag")
+	sub2.IntVar(&sub2IntVal, "value", 0, "int flag")
+
+	//
+	// 引数の１つ目がサブコマンドとなるので、それで振り分け
+	//
+	var (
+		argsList = [][]string{
+			{"sub1"},
+			{"sub2"},
+			{"sub1", "-enable"},
+			{"sub2", "-value", "100"},
+		}
+	)
+	for _, args := range argsList {
+		switch args[0] {
+		case "sub1":
+			sub1.Parse(args[1:])
+			fmt.Printf("[sub1] enable=%v\n", sub1BoolVal)
+		case "sub2":
+			sub2.Parse(args[1:])
+			fmt.Printf("[sub2] value=%v\n", sub2IntVal)
+		}
+	}
+
+	return nil
+
+	/*
+	   $ task
+	   task: [build] go build .
+	   task: [run] ./try-golang -onetime
+
+	   ENTER EXAMPLE NAME: flags_subcommand
+
+	   [Name] "flags_subcommand"
+	   [sub1] enable=false
+	   [sub2] value=0
+	   [sub1] enable=true
+	   [sub2] value=100
+
+
+	   [Elapsed] 37.48µs
+	*/
+
+}