add initial template cmds to cli

demo/rules.yaml

@@ -0,0 +1,8 @@
+features:
+  - name: api
+    scopes:
+      - match: module
+        documents:
+          - source: api.go.tpl
+            target: "{{snake .Module.Name}}.go"
+

demo/templates/api.go.tpl

@@ -0,0 +1,53 @@
+package {{snake .Module.ShortName}}
+
+
+{{- range .Module.Externs }}
+// extern {{.Name}}
+{{ $import := .Meta.GetString "go.module" }}
+{{- if $import }}
+import "{{$import}}"
+{{- end }}
+{{- end }}
+
+{{- range .Module.Enums }}
+
+type {{Camel .Name}} int
+
+{{ $enum := . }}
+const (
+{{- range .Members }}
+    {{Camel $enum.Name}}{{Camel .Name}} = iota
+{{- end }}
+)
+{{- end }}
+
+
+
+{{- range .Module.Structs }}
+
+type {{Camel .Name}} struct {
+{{- range .Fields }}
+  {{Camel .Name}} {{goType "" .}} `json:"{{snake .Name}}" yaml:"{{snake .Name}}"`
+{{- end }}
+};
+{{- end }}
+
+{{- range .Module.Interfaces }}
+
+{{- range .Properties }}
+var {{Camel .Name}} = {{goDefault "" .}}
+{{- end }}
+
+type I{{Camel .Name }} interface {
+{{- range .Properties }}
+  // {{.Name}}
+  Set{{Camel .Name}}({{goParam "" .}})
+  Get{{Camel .Name}}() {{goReturn "" . }}
+  On{{Camel .Name}}(cb func({{goType "" .}}))
+{{- end }}
+{{- range .Operations }}
+  // {{.Name}}
+  {{Camel .Name}}({{goParams "" .Params}}) {{goReturn "" .Return}}
+{{- end }}
+};
+{{- end }}

go.mod

@@ -1,8 +1,9 @@
 module github.com/apigear-io/cli
 
-go 1.22
+go 1.22.2
 
 require (
+	github.com/apigear-io/apigear-by-example v0.1.0
 	github.com/spf13/cobra v1.8.1
 	github.com/spf13/viper v1.19.0
 	github.com/stretchr/testify v1.9.0

pkg/cmd/root.go

@@ -11,6 +11,7 @@ import (
 	"github.com/apigear-io/cli/pkg/cmd/registry"
 	"github.com/apigear-io/cli/pkg/cmd/sim"
 	"github.com/apigear-io/cli/pkg/cmd/spec"
+	"github.com/apigear-io/cli/pkg/cmd/tpl"
 	"github.com/apigear-io/cli/pkg/cmd/x"
 
 	"github.com/spf13/cobra"
@@ -26,7 +27,7 @@ func NewRootCommand() *cobra.Command {
 		Long:  `ApiGear allows you to describe interfaces and generate instrumented SDKs out of the descriptions.`,
 	}
 	cmd.SilenceErrors = false
-	cmd.SilenceUsage = true
+	cmd.SilenceUsage = false
 	cmd.AddCommand(gen.NewRootCommand())
 	cmd.AddCommand(mon.NewRootCommand())
 	cmd.AddCommand(cfg.NewRootCommand())
@@ -38,5 +39,6 @@ func NewRootCommand() *cobra.Command {
 	cmd.AddCommand(x.NewRootCommand())
 	cmd.AddCommand(NewUpdateCommand())
 	cmd.AddCommand(NewVersionCommand())
+	cmd.AddCommand(tpl.NewRootCommand())
 	return cmd
 }

pkg/cmd/tpl/info.go

@@ -0,0 +1,34 @@
+package tpl
+
+import (
+	"github.com/apigear-io/cli/pkg/tpl"
+	"github.com/spf13/cobra"
+)
+
+func NewInfoCommand() *cobra.Command {
+	var dir string
+	var cmd = &cobra.Command{
+		Use:   "info",
+		Short: "Display template information",
+		Long:  `Display template information`,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			info, err := tpl.Info(dir)
+			if err != nil {
+				return err
+			}
+			cmd.Println("# template info")
+			cmd.Println()
+			cmd.Println("## rules document")
+			cmd.Println()
+			cmd.Println(info.Rules)
+			cmd.Println("## template files")
+			cmd.Println()
+			for _, file := range info.Files {
+				cmd.Printf("- %s\n", file)
+			}
+			return nil
+		},
+	}
+	cmd.Flags().StringVarP(&dir, "dir", "d", ".", "template directory")
+	return cmd
+}

pkg/cmd/tpl/init.go

@@ -0,0 +1,25 @@
+package tpl
+
+import (
+	"github.com/apigear-io/cli/pkg/tpl"
+	"github.com/spf13/cobra"
+)
+
+func NewInitCommand() *cobra.Command {
+	var dir string
+	var lang string
+	var cmd = &cobra.Command{
+		Use:   "init",
+		Short: "Initialize a template",
+		Long:  `Initialize a template`,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.Printf("initializing template %s using language %s\n", dir, lang)
+			return tpl.InitTemplate(dir, lang)
+		},
+	}
+	cmd.Flags().StringVarP(&dir, "dir", "d", ".", "template directory to init")
+	cmd.MarkFlagRequired("dir")
+	cmd.Flags().StringVarP(&lang, "lang", "l", "cpp", "language to init [cpp, go, py, rs, ts, ue]")
+	cmd.MarkFlagRequired("lang")
+	return cmd
+}

pkg/cmd/tpl/lint.go

@@ -0,0 +1,34 @@
+package tpl
+
+import (
+	"github.com/apigear-io/cli/pkg/gen"
+	"github.com/apigear-io/cli/pkg/model"
+	"github.com/spf13/cobra"
+)
+
+func NewLintCommand() *cobra.Command {
+	var dir string
+	var cmd = &cobra.Command{
+		Use:   "lint",
+		Short: "Lint a template directory",
+		Long:  `Lint a template directory, it will fail if the templates can not be compiled`,
+		Run: func(cmd *cobra.Command, args []string) {
+			// trying to create a generator, it will fail
+			// if the templates in the dir are not valid
+			_, err := gen.New(gen.Options{
+				TemplatesDir: dir,
+				System:       model.NewSystem("test"),
+				Features:     []string{"all"},
+				Force:        true,
+			})
+			if err != nil {
+				cmd.Printf("template dir '%s' is not valid: %s\n", dir, err)
+			} else {
+				cmd.Printf("template dir '%s' is valid\n", dir)
+			}
+		},
+	}
+	cmd.Flags().StringVarP(&dir, "dir", "d", ".", "template directory")
+	cmd.MarkFlagRequired("dir")
+	return cmd
+}

pkg/cmd/tpl/publish.go

@@ -0,0 +1,22 @@
+package tpl
+
+import (
+	"github.com/apigear-io/cli/pkg/tpl"
+	"github.com/spf13/cobra"
+)
+
+func NewPublishCommand() *cobra.Command {
+	var dir string
+	var cmd = &cobra.Command{
+		Use:   "publish",
+		Short: "Publish a template to a market place",
+		Long:  `Publish a template to a market place. The template needs to be a public github repository.`,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.Printf("publishing template %s\n", dir)
+			return tpl.PublishTemplate(dir)
+		},
+	}
+	cmd.Flags().StringVarP(&dir, "dir", "d", ".", "template directory")
+	cmd.MarkFlagRequired("dir")
+	return cmd
+}

pkg/cmd/tpl/root.go

@@ -0,0 +1,18 @@
+package tpl
+
+import "github.com/spf13/cobra"
+
+func NewRootCommand() *cobra.Command {
+	// cmd represents the tpl command
+	cmd := &cobra.Command{
+		Use:     "template",
+		Aliases: []string{"tpl", "t"},
+		Short:   "template management",
+		Long:    `template management`,
+	}
+	cmd.AddCommand(NewInitCommand())
+	cmd.AddCommand(NewLintCommand())
+	cmd.AddCommand(NewInfoCommand())
+	cmd.AddCommand(NewPublishCommand())
+	return cmd
+}

pkg/tpl/info.go

@@ -0,0 +1,31 @@
+package tpl
+
+import (
+	"os"
+
+	"github.com/apigear-io/cli/pkg/helper"
+)
+
+type TemplateInfo struct {
+	Rules string
+	Files []string
+}
+
+func Info(dir string) (*TemplateInfo, error) {
+	info := &TemplateInfo{}
+	// read rules.yaml
+	rules, err := os.ReadFile(helper.Join(dir, "rules.yaml"))
+	if err != nil {
+		return nil, err
+	}
+	info.Rules = string(rules)
+	// read files
+	files, err := os.ReadDir(helper.Join(dir, "templates"))
+	if err != nil {
+		return nil, err
+	}
+	for _, file := range files {
+		info.Files = append(info.Files, file.Name())
+	}
+	return info, nil
+}

pkg/tpl/init.go

@@ -0,0 +1,65 @@
+package tpl
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/apigear-io/apigear-by-example/tplcpp"
+	"github.com/apigear-io/apigear-by-example/tplgo"
+	"github.com/apigear-io/apigear-by-example/tplpy"
+	"github.com/apigear-io/apigear-by-example/tplrs"
+	"github.com/apigear-io/apigear-by-example/tplts"
+	"github.com/apigear-io/apigear-by-example/tplue"
+	"github.com/apigear-io/cli/pkg/helper"
+)
+
+func InitTemplate(dir string, lang string) error {
+	var rules []byte
+	var apiTpl []byte
+	var apiTplName string
+	switch lang {
+	case "cpp":
+		rules = tplcpp.RulesYaml
+		apiTpl = tplcpp.ApiTpl
+		apiTplName = tplcpp.ApiTplName
+	case "go":
+		rules = tplgo.RulesYaml
+		apiTpl = tplgo.ApiTpl
+		apiTplName = tplgo.ApiTplName
+	case "py":
+		rules = tplpy.RulesYaml
+		apiTpl = tplpy.ApiTpl
+		apiTplName = tplpy.ApiTplName
+	case "ts":
+		rules = tplts.RulesYaml
+		apiTpl = tplts.ApiTpl
+		apiTplName = tplts.ApiTplName
+	case "rs":
+		rules = tplrs.RulesYaml
+		apiTpl = tplrs.ApiTpl
+		apiTplName = tplrs.ApiTplName
+	case "ue":
+		rules = tplue.RulesYaml
+		apiTpl = tplue.ApiTpl
+		apiTplName = tplue.ApiTplName
+	default:
+		return fmt.Errorf("unsupported language: %s", lang)
+	}
+	log.Info().Msgf("init template %s", dir)
+	os.MkdirAll(dir, 0755)
+	target := helper.Join(dir, "rules.yaml")
+	log.Info().Msgf("write %s", target)
+	err := os.WriteFile(target, rules, 0644)
+	if err != nil {
+		return err
+	}
+	target = helper.Join(dir, "templates")
+	os.MkdirAll(target, 0755)
+	target = helper.Join(target, apiTplName)
+	log.Info().Msgf("write %s", target)
+	err = os.WriteFile(target, apiTpl, 0644)
+	if err != nil {
+		return err
+	}
+	return nil
+}

pkg/tpl/log.go

@@ -0,0 +1,7 @@
+package tpl
+
+import (
+	zlog "github.com/apigear-io/cli/pkg/log"
+)
+
+var log = zlog.Topic("tpl")

pkg/tpl/publish.go

@@ -0,0 +1,6 @@
+package tpl
+
+func PublishTemplate(dir string) error {
+	log.Info().Msgf("publishing template %s. Not implemented yet", dir)
+	return nil
+}