cmd.go

/*
 * Copyright 2025 - 2026 Zigflow authors <https://github.com/zigflow/schema/graphs/contributors>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package schema

import (
	_ "embed"
	"encoding/json"
	"fmt"
	"strings"

	"github.com/google/jsonschema-go/jsonschema"
	gh "github.com/mrsimonemms/golang-helpers"
	"github.com/rs/zerolog"
	"github.com/spf13/cobra"
	"github.com/spf13/viper"
	"sigs.k8s.io/yaml"
)

func NewSchemaCmd(version string) *cobra.Command {
	var opts struct {
		Output string
	}

	cmd := &cobra.Command{
		Use:   "schema",
		Short: "Output the Zigflow JSON schema.",
		Long: `Output the JSON Schema for the Zigflow workflow specification.

The schema can be used by editors, validation tools and AI code
generators to produce structurally valid Zigflow workflows. It defines
required fields, supported properties and constraints enforced by the
Zigflow CLI.

By exposing the schema programmatically, Zigflow enables reliable
validation, structured generation and automated tooling integration.`,
		RunE: func(cmd *cobra.Command, args []string) error {
			v := opts.Output

			var fn func(*jsonschema.Schema) ([]byte, error)

			switch v {
			case "json":
				fn = func(s *jsonschema.Schema) ([]byte, error) {
					return json.MarshalIndent(s, "", "  ")
				}
			case "yaml":
				fn = func(s *jsonschema.Schema) ([]byte, error) {
					return yaml.Marshal(s)
				}
			default:
				return gh.FatalError{
					Msg: "Invalid output",
					WithParams: func(l *zerolog.Event) *zerolog.Event {
						return l.Str("output", v)
					},
				}
			}

			// Build the schema
			schema, err := BuildSchema(version, v)
			if err != nil {
				return gh.FatalError{
					Cause: err,
					Msg:   "Error building Zigflow schema",
				}
			}

			res, err := fn(schema)
			if err != nil {
				return gh.FatalError{
					Cause: err,
					Msg:   "Error building the schema in the desired output",
				}
			}

			fmt.Println(strings.TrimSpace(string(res)))

			return nil
		},
	}

	viper.Set("output", "json")
	cmd.Flags().StringVarP(
		&opts.Output, "output", "o",
		viper.GetString("output"), "Output format. One of: (json, yaml)",
	)

	return cmd
}