feat: more linting and code gen for JSON schema

.gitignore

@@ -21,4 +21,4 @@
 /schema/ignore
 /scm-engine
 /scm-engine.exe
-/scm-engine.schema.json
+scm-engine.schema.json

Taskfile.yml

@@ -43,7 +43,7 @@ tasks:
       - go run . gitlab -h > docs/gitlab/_partials/cmd-gitlab.md
       - go run . gitlab evaluate -h > docs/gitlab/_partials/cmd-gitlab-evaluate.md
       - go run . gitlab server -h > docs/gitlab/_partials/cmd-gitlab-server.md
-      - go run . jsonschema > docs/scm-engine.schema.json
+      - cp pkg/generated/resources/scm-engine.schema.json docs/scm-engine.schema.json
 
   docs:server:
     desc: Run Docs dev server with live preview

cmd/gitlab.go

@@ -44,8 +44,8 @@ var GitLab = &cli.Command{
 			Flags: []cli.Flag{
 				&cli.StringFlag{
 					Name:  "schema",
-					Usage: "The HTTP/HTTPS URL or file path to the scm-engine schema file",
-					Value: "https://jippi.github.io/scm-engine/scm-engine.schema.json",
+					Usage: "Where to find the JSON Schema file. Can load the file from either the embedded version (default), http://, https://, or a file:// URI",
+					Value: "embed://",
 				},
 			},
 		},

cmd/gitlab_lint.go

@@ -4,9 +4,11 @@ import (
 	"fmt"
 	"net/http"
 	"os"
+	"strings"
 	"time"
 
 	"github.com/jippi/scm-engine/pkg/config"
+	"github.com/jippi/scm-engine/pkg/generated/resources"
 	"github.com/jippi/scm-engine/pkg/scm/gitlab"
 	"github.com/jippi/scm-engine/pkg/state"
 	"github.com/santhosh-tekuri/jsonschema/v6"
@@ -19,15 +21,6 @@ func Lint(cCtx *cli.Context) error {
 	ctx := cCtx.Context
 	ctx = state.WithConfigFilePath(ctx, cCtx.String(FlagConfigFile))
 
-	cfg, err := config.LoadFile(state.ConfigFilePath(ctx))
-	if err != nil {
-		return err
-	}
-
-	if len(cfg.Includes) != 0 {
-		slogctx.Warn(ctx, "Configuration file contains 'include' settings, those are currently unsupported by 'lint' command and will be ignored")
-	}
-
 	// Read raw YAML file
 	raw, err := os.ReadFile(state.ConfigFilePath(ctx))
 	if err != nil {
@@ -45,6 +38,7 @@ func Lint(cCtx *cli.Context) error {
 		"file":  jsonschema.FileLoader{},
 		"http":  newHTTPURLLoader(),
 		"https": newHTTPURLLoader(),
+		"embed": &EmbedLoader{},
 	}
 
 	// Create json schema compiler
@@ -62,10 +56,26 @@ func Lint(cCtx *cli.Context) error {
 		return err
 	}
 
+	// Load the configuration file via our Go struct
+	cfg, err := config.LoadFile(state.ConfigFilePath(ctx))
+	if err != nil {
+		return err
+	}
+
+	if len(cfg.Includes) != 0 {
+		slogctx.Warn(ctx, "Configuration file contains 'include' settings, those are currently unsupported by 'lint' command and will be ignored")
+	}
+
 	// To scm-engine specific linting last
 	return cfg.Lint(ctx, &gitlab.Context{})
 }
 
+type EmbedLoader struct{}
+
+func (l *EmbedLoader) Load(url string) (any, error) {
+	return jsonschema.UnmarshalJSON(strings.NewReader(resources.JSONSchema))
+}
+
 type HTTPURLLoader http.Client
 
 func (l *HTTPURLLoader) Load(url string) (any, error) {

generate.go

@@ -0,0 +1,3 @@
+package main
+
+//go:generate go run ./pkg/generated/main.go

main.go

@@ -1,16 +1,16 @@
+//go:build !generate
+// +build !generate
+
 package main
 
 import (
-	"encoding/json"
 	"fmt"
 	"io"
 	"log"
 	"os"
 
 	"github.com/davecgh/go-spew/spew"
-	"github.com/invopop/jsonschema"
 	"github.com/jippi/scm-engine/cmd"
-	"github.com/jippi/scm-engine/pkg/config"
 	"github.com/jippi/scm-engine/pkg/state"
 	"github.com/jippi/scm-engine/pkg/tui"
 	"github.com/urfave/cli/v2"
@@ -72,26 +72,7 @@ func main() {
 		Commands: []*cli.Command{
 			cmd.GitLab,
 			cmd.GitHub,
-			{
-				Name: "jsonschema",
-				Action: func(ctx *cli.Context) error {
-					r := new(jsonschema.Reflector)
-					if err := r.AddGoComments("github.com/jippi/scm-engine", "./"); err != nil {
-						return err
-					}
-
-					schema := r.Reflect(&config.Config{})
-
-					data, err := json.MarshalIndent(schema, "", "  ")
-					if err != nil {
-						panic(err.Error())
-					}
 
-					fmt.Println(string(data))
-
-					return os.WriteFile("scm-engine.schema.json", data, 0o600)
-				},
-			},
 			// DEPRECATED COMMANDS
 			{
 				Name:      "evaluate",

pkg/generated/main.go

@@ -0,0 +1,35 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+
+	"github.com/invopop/jsonschema"
+	"github.com/jippi/scm-engine/pkg/config"
+)
+
+func main() {
+	r := new(jsonschema.Reflector)
+	if err := r.AddGoComments("github.com/jippi/scm-engine", "./pkg"); err != nil {
+		panic(err)
+	}
+
+	schema := r.Reflect(&config.Config{})
+
+	data, err := json.MarshalIndent(schema, "", "  ")
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(string(data))
+
+	dir, err := os.Getwd()
+	if err != nil {
+		panic(err)
+	}
+
+	if err := os.WriteFile(dir+"/pkg/generated/resources/scm-engine.schema.json", data, 0o600); err != nil {
+		panic(err)
+	}
+}

pkg/generated/resources/file.go

@@ -0,0 +1,6 @@
+package resources
+
+import _ "embed"
+
+//go:embed scm-engine.schema.json
+var JSONSchema string