Skip to main content

Go Library

The validator is available as a Go package. Embed validation in your own tools using the cli and finder packages.

Go Reference

Install​

go get github.com/Boeing/config-file-validator/v3
note

The cli package imports all validators, which pulls in dependencies for every supported file type. If you only need specific validators, import pkg/validator directly and use individual validators like validator.JSONValidator{} or validator.YAMLValidator{}.

Default configuration​

Validates all supported config files in the current directory and prints results to stdout:

package main

import (
	"os"
	"log"

	"github.com/Boeing/config-file-validator/v3/pkg/cli"
)

func main() {
	cfv := cli.Init()
	exitStatus, err := cfv.Run()
	if err != nil {
		log.Printf("Errors occurred during execution: %v", err)
	}
	os.Exit(exitStatus)
}

Custom search paths​

fileSystemFinder := finder.FileSystemFinderInit(
	finder.WithPathRoots("/path/to/search", "/another/path"),
)

cfv := cli.Init(
	cli.WithFinder(fileSystemFinder),
)

Custom reporter​

Output JSON to stdout:

jsonReporter := reporter.NewJSONReporter("", false)

cfv := cli.Init(
	cli.WithFinder(fileSystemFinder),
	cli.WithReporters(jsonReporter),
)

The first argument is the output path (empty string for stdout). The second controls quiet mode.

Finder options​

fileSystemFinder := finder.FileSystemFinderInit(
	finder.WithPathRoots("."),
	finder.WithExcludeDirs([]string{"node_modules", "vendor"}),
	finder.WithExcludeFileTypes([]string{"csv"}),
	finder.WithDepth(3),
)

CLI options​

cfv := cli.Init(
	cli.WithFinder(fileSystemFinder),
	cli.WithReporters(jsonReporter),
	cli.WithQuiet(true),
	cli.WithGroupOutput([]string{"pass-fail"}),
	cli.WithRequireSchema(true),
	cli.WithNoSchema(false),
	cli.WithSchemaMap([]cli.SchemaMapping{
		{Pattern: "**/package.json", SchemaPath: "schemas/package.schema.json"},
	}),
)

SchemaStore​

Enable automatic schema lookup:

import "github.com/Boeing/config-file-validator/v3/pkg/schemastore"

store, err := schemastore.OpenEmbedded()
if err != nil {
	log.Fatal(err)
}

cfv := cli.Init(
	cli.WithSchemaStore(store),
)

For offline or restricted environments, use a local SchemaStore clone:

store, err := schemastore.Open("/path/to/schemastore")
if err != nil {
	log.Fatal(err)
}

cfv := cli.Init(
	cli.WithSchemaStore(store),
)

Full API reference​

See the Go package documentation for all exported types and functions.