gospectral

type AfterModule = func(name string, runtime *goja.Runtime, registry *noderequire.Registry, requireModule *noderequire.RequireModule) error

type BeforeModule = func(enable Enable, runtime *goja.Runtime, registry *noderequire.Registry, requireModule *noderequire.RequireModule) (func(runtime *goja.Runtime, registry *noderequire.Registry, requireModule *noderequire.RequireModule), error)

type Config struct {
	// Dist is the source JS file exporting
	// 1) function: formatOutput
	// 2) promise: lint output using global variables lintDocuments and lintRuleset
	//
	// See the index.js for more details
	Dist []byte

	// Script that evaluates the Dist, i.e. by the default
	// by using the output of the lint promise and wrapping
	// it in a formatOutput promise
	Script []byte

	// FS to use when loading document(s) and ruleset. If set, when a file is loaded (e.g. an OpenAPI document or
	// a ruleset) it is first searched in the FS *without* the WorkingDirectory reference. If the file is not found
	// in the FS, continue the search relative to the WorkingDirectory. This mechanism allows to bundle static files
	// (e.g. rulesets) and also have a runtime component.
	FS fs.FS

	// Printer used for console output
	Printer console.Printer

	// WorkingDirectory, defaults to os.Getcwd() if ""
	WorkingDirectory string

	// BeforeModule hook to customize behavior before (or instead of) enabling a module
	BeforeModule BeforeModule

	// AfterModule hook to customize runtime or registry state
	AfterModule AfterModule
}

type Enable struct {
	// Name of the Module to Enable
	Name string

	// Fn to Enable Module
	Fn func(runtime *goja.Runtime, registry *noderequire.Registry, requireModule *noderequire.RequireModule)
}

type EvaluateError struct {
	Err error
}

type LogrusPrinter struct {
	// contains filtered or unexported fields
}

type Option func(config *Config) error

type Output []Rule

type Rule struct {
	Source   string   `json:"source"`
	Code     string   `json:"code"`
	Path     []string `json:"path"`
	Message  string   `json:"message"`
	Severity int      `json:"severity"`
	Range    struct {
		Start struct {
			Line      int `json:"line"`
			Character int `json:"character"`
		} `json:"start"`
		End struct {
			Line      int `json:"line"`
			Character int `json:"character"`
		} `json:"end"`
	}
}