Merge pull request #823 from devlights/add-flags-example

Author: devlights

examples/basic/examples.go

@@ -22,6 +22,7 @@ import (
 	"github.com/devlights/try-golang/examples/basic/errs"
 	"github.com/devlights/try-golang/examples/basic/fileio"
 	"github.com/devlights/try-golang/examples/basic/filepaths"
+	"github.com/devlights/try-golang/examples/basic/flags"
 	"github.com/devlights/try-golang/examples/basic/floatop"
 	"github.com/devlights/try-golang/examples/basic/formatting"
 	"github.com/devlights/try-golang/examples/basic/functions"
@@ -110,6 +111,7 @@ func (r *register) Regist(m mapping.ExampleMapping) {
 	errs.NewRegister().Regist(m)
 	fileio.NewRegister().Regist(m)
 	filepaths.NewRegister().Regist(m)
+	flags.NewRegister().Regist(m)
 	floatop.NewRegister().Regist(m)
 	formatting.NewRegister().Regist(m)
 	functions.NewRegister().Regist(m)

examples/basic/flags/README.md

@@ -0,0 +1,8 @@
+# サンプルリスト
+
+このディレクトリには以下のサンプルがあります。
+
+| file       | example name  | note                         |
+| ---------- | ------------- | ---------------------------- |
+| flagset.go | flags_flagset | flag.Flagset のサンプルです. |
+|            |               |                              |

examples/basic/flags/doc.go

@@ -0,0 +1,4 @@
+/*
+Package flags -- flag パッケージに関するサンプルが配置されているパッケージです。
+*/
+package flags

examples/basic/flags/examples.go

@@ -0,0 +1,17 @@
+package flags
+
+import "github.com/devlights/try-golang/mapping"
+
+type (
+	register struct{}
+)
+
+// NewRegister -- このパッケージ用のサンプルを登録する mapping.Register を生成します。
+func NewRegister() mapping.Register {
+	return &register{}
+}
+
+// Regist -- 登録します.
+func (r *register) Regist(m mapping.ExampleMapping) {
+	m["flags_flagset"] = Flagset
+}

examples/basic/flags/flagset.go

@@ -0,0 +1,46 @@
+package flags
+
+import (
+	"flag"
+
+	"github.com/devlights/gomy/output"
+)
+
+// Flagset は、flag.Flagsetのサンプルです。
+//
+// 通常、flagパッケージはアプリケーションの引数を扱うものであるが
+// flag.Flagsetを利用することで、外から引数を指定してパースすることが可能となる。
+// ユニットテストと相性が良い。
+//
+// # REFERENCES
+//   - https://pkg.go.dev/flag@go1.22.4#FlagSet
+func Flagset() error {
+	var (
+		fs       = flag.NewFlagSet("", flag.ExitOnError)
+		intValue = fs.Int("intvalue", 0, "int value")
+		strValue = fs.String("strvalue", "", "string value")
+	)
+
+	// Flagsetは自分でParse()を呼ぶ必要がある
+	// アプリケーション引数を渡す場合は os.Args[1:] となる
+	fs.Parse([]string{"-intvalue", "100", "-stvalue", "hello world"})
+
+	output.Stdoutl("[intValue]", *intValue)
+	output.Stdoutl("[intValue]", *strValue)
+
+	return nil
+
+	/*
+	   $ task
+	   task: [build] go build .
+	   task: [run] ./try-golang -onetime
+
+	   ENTER EXAMPLE NAME: flags_flagset
+
+	   [Name] "flags_flagset"
+	   [intValue]           100
+	   [intValue]           hello world
+
+	   [Elapsed] 43.41µs
+	*/
+}