CHANGELOG.md

 
+<a name="v1.4.0"></a>
+## [v1.4.0] - 2022-10-09
+### Add Features
+- feat new Execute() Method for the automatic execution of command
+- feat new function GetDefaults()
+
+
 <a name="v1.3.1"></a>
 ## [v1.3.1] - 2022-10-08
 ### Bug Fixes
@@ -52,6 +59,7 @@
 <a name="v1.0.0"></a>
 ## v1.0.0 - 2022-10-04
 
+[v1.4.0]: https://gitlab.schukai.com/oss/libraries/go/application/xflags/compare/v1.3.1...v1.4.0
 [v1.3.1]: https://gitlab.schukai.com/oss/libraries/go/application/xflags/compare/v1.3.0...v1.3.1
 [v1.3.0]: https://gitlab.schukai.com/oss/libraries/go/application/xflags/compare/v1.2.3...v1.3.0
 [v1.2.3]: https://gitlab.schukai.com/oss/libraries/go/application/xflags/compare/v1.2.2...v1.2.3

api.go

@@ -6,10 +6,52 @@ package xflags
 import (
 	"bytes"
 	"flag"
+	"fmt"
 	"io"
+	"os"
 	"reflect"
 )
 
+// Execute executes the command line arguments and calls the functions.
+func Execute[C any, D any](cmd C, cnf D) *Settings[C] {
+	return execute(cmd, cnf, os.Args[0], os.Args[1:])
+}
+
+func (s *Settings[C]) PrintFlagOutput() {
+	fmt.Println(s.command.flagSet.Output())
+}
+
+// execute is the internal implementation of Execute.
+func execute[C any, D any](cmd C, cnf D, name string, args []string) *Settings[C] {
+	instance := New(name, cmd)
+	if instance.HasErrors() {
+		return instance
+	}
+
+	instance.SetShadow(cnf)
+	if instance.HasErrors() {
+		return instance
+	}
+
+	instance.Parse(args)
+	if instance.HelpRequested() {
+		for i, err := range instance.errors {
+			if err == flag.ErrHelp {
+				instance.errors = append(instance.errors[:i], instance.errors[i+1:]...)
+			}
+		}
+		instance.PrintFlagOutput()
+		return instance
+	}
+
+	if instance.HasErrors() {
+		return instance
+	}
+
+	instance.Execute()
+	return instance
+}
+
 // New creates a new instance of the settings.
 // name should be the name of the command and comes from the first argument of the command line.
 // os.Args[0] is a good choice.
@@ -43,3 +85,13 @@ func (s *Settings[C]) Output() string {
 func (s *Settings[C]) Args() []string {
 	return s.args
 }
+
+// GetDefaults returns the default values of the settings.
+func (s *Settings[C]) GetDefaults() string {
+	mem := s.flagOutput
+	s.flagOutput.(*bytes.Buffer).Reset()
+	s.command.flagSet.PrintDefaults()
+	r := s.flagOutput.(*bytes.Buffer).String()
+	s.flagOutput = mem
+	return r
+}

api_test.go

@@ -8,22 +8,31 @@ import (
 	"testing"
 )
 
-//func TestUsage(t *testing.T) {
-//
-//	commands := New("root", CmdTest1{})
-//	args := []string{"-h"}
-//
-//	commands.Parse(args)
-//
-//	assert.False(t, commands.HasErrors())
-//	if commands.HasErrors() {
-//		t.Log(commands.Errors())
-//	}
-//
-//	usage := commands.Usage()
-//	assert.NotEmpty(t, usage)
-//
-//}
+func TestUsage(t *testing.T) {
+
+	commands := New("root", CmdTest1{})
+	args := []string{"-h"}
+
+	commands.Parse(args)
+
+	assert.True(t, commands.HelpRequested())
+
+	usage := commands.GetDefaults()
+	assert.Equal(t, "  -a\tMessage A\n  -x int\n    \tMessage X\n", usage)
+
+}
+func TestExecute(t *testing.T) {
+	instance := execute("root", CmdTest1{}, "test", []string{"-a", "hello", "-x", "1"})
+	assert.NotNil(t, instance)
+}
+
+func TestExecuteHelp(t *testing.T) {
+	cnf := struct {
+	}{}
+	instance := execute(CmdTest1{}, &cnf, "test", []string{"-h"})
+	assert.False(t, instance.HasErrors())
+
+}
 
 func TestNewIntWithError(t *testing.T) {
 
@@ -47,17 +56,17 @@ func TestNew(t *testing.T) {
 }
 
 type CmdTest1 struct {
-	A    bool `short:"a"`
+	A    bool `short:"a" description:"Message A"`
 	Sub1 struct {
-		B    bool `short:"b"`
+		B    bool `short:"b" description:"Message B"`
 		Sub2 struct {
-			C    bool `short:"c"`
+			C    bool `short:"c" description:"Message C"`
 			Sub3 struct {
-				D bool `short:"d"`
+				D bool `short:"d" description:"Message D"`
 			} `command:"sub3"`
 		} `command:"sub2"`
 	} `command:"sub1"`
-	aa int `short:"x"`
+	aa int `short:"x" description:"Message X"`
 }
 
 func TestCommand2(t *testing.T) {

parse.go

@@ -3,7 +3,10 @@
 
 package xflags
 
-import "os"
+import (
+	"flag"
+	"os"
+)
 
 // ParseOsArgs parses the os.Args.
 func (s *Settings[C]) ParseOsArgs() *Settings[C] {
@@ -38,3 +41,14 @@ func (s *Settings[C]) Parse(args []string) *Settings[C] {
 
 	return s
 }
+
+func (s *Settings[C]) HelpRequested() bool {
+
+	for _, err := range s.errors {
+		if err == flag.ErrHelp {
+			return true
+		}
+	}
+	
+	return false
+}

release.json

-{"version":"1.3.1"}
+{"version":"1.4.0"}