refactor: blueprint -> view

Signed-off-by: Joseph Kato <joseph@jdkato.io>

Author: jdkato

internal/core/config.go

@@ -34,14 +34,14 @@ var (
 	// PipeDir is the default location for Vale's configuration pipeline.
 	PipeDir = ".vale-config"
 
-	VocabDir      = filepath.Join(ConfigDir, "vocabularies")
-	DictDir       = filepath.Join(ConfigDir, "dictionaries")
-	TmplDir       = filepath.Join(ConfigDir, "templates")
-	IgnoreDir     = filepath.Join(ConfigDir, "ignore")
-	ActionDir     = filepath.Join(ConfigDir, "actions")
-	FilterDir     = filepath.Join(ConfigDir, "filters")
-	ScriptDir     = filepath.Join(ConfigDir, "scripts")
-	BlueprintsDir = filepath.Join(ConfigDir, "blueprints")
+	VocabDir  = filepath.Join(ConfigDir, "vocabularies")
+	DictDir   = filepath.Join(ConfigDir, "dictionaries")
+	TmplDir   = filepath.Join(ConfigDir, "templates")
+	IgnoreDir = filepath.Join(ConfigDir, "ignore")
+	ActionDir = filepath.Join(ConfigDir, "actions")
+	FilterDir = filepath.Join(ConfigDir, "filters")
+	ScriptDir = filepath.Join(ConfigDir, "scripts")
+	ViewDir   = filepath.Join(ConfigDir, "views")
 )
 
 // ConfigDirs is a list of all directories that contain user-defined, non-style
@@ -54,7 +54,7 @@ var ConfigDirs = []string{
 	ActionDir,
 	ScriptDir,
 	FilterDir,
-	BlueprintsDir,
+	ViewDir,
 }
 
 // ConfigVars is a list of all supported environment variables.
@@ -213,10 +213,10 @@ type Config struct {
 	AcceptedTokens []string `json:"-"` // Project-specific vocabulary (okay)
 	RejectedTokens []string `json:"-"` // Project-specific vocabulary (avoid)
 
-	FallbackPath string                `json:"-"`
-	SecToPat     map[string]glob.Glob  `json:"-"`
-	Styles       []string              `json:"-"`
-	Blueprints   map[string]*Blueprint `json:"-"`
+	FallbackPath string               `json:"-"`
+	SecToPat     map[string]glob.Glob `json:"-"`
+	Styles       []string             `json:"-"`
+	Views        map[string]*View     `json:"-"`
 
 	NLPEndpoint string // An external API to call for NLP-related work.
 
@@ -245,7 +245,7 @@ func NewConfig(flags *CLIFlags) (*Config, error) {
 	cfg.TokenIgnores = make(map[string][]string)
 	cfg.CommentDelimiters = make(map[string][2]string)
 	cfg.FormatToLang = make(map[string]string)
-	cfg.Blueprints = make(map[string]*Blueprint)
+	cfg.Views = make(map[string]*View)
 	cfg.Paths = []string{}
 	cfg.ConfigFiles = []string{}
 

internal/core/ini.go

@@ -122,20 +122,20 @@ var syntaxOpts = map[string]func(string, *ini.Section, *Config) error{
 		cfg.FormatToLang[label] = sec.Key("Lang").String()
 		return nil
 	},
-	"Blueprint": func(label string, sec *ini.Section, cfg *Config) error {
-		name := sec.Key("Blueprint").String()
+	"View": func(label string, sec *ini.Section, cfg *Config) error {
+		name := sec.Key("View").String()
 
-		path := FindConfigAsset(cfg, name+".yml", BlueprintsDir)
+		path := FindConfigAsset(cfg, name+".yml", ViewDir)
 		if path == "" {
-			return fmt.Errorf("blueprint '%s' not found", name)
+			return fmt.Errorf("view '%s' not found", name)
 		}
 
-		blueprint, err := NewBlueprint(path)
+		view, err := NewView(path)
 		if err != nil {
 			return err
 		}
 
-		cfg.Blueprints[label] = blueprint
+		cfg.Views[label] = view
 		return nil
 	},
 }

internal/core/blueprint.go internal/core/view.gointernal/core/blueprint.go renamed to internal/core/view.go

@@ -15,7 +15,7 @@ import (
 type DaselValue = map[string]any
 
 var blockChompingRegex = regexp.MustCompile(`(\w: )>(-?\s*)`)
-var blueprintEngines = []string{"tree-sitter", "dasel"}
+var viewEngines = []string{"tree-sitter", "dasel"}
 
 // A Scope is a single query that we want to run against a document.
 type Scope struct {
@@ -24,14 +24,16 @@ type Scope struct {
 	Type string `yaml:"type"`
 }
 
-// A Blueprint is a set of queries that we want to run against a document.
+// A View is a named, virtual representation of a subset of a file's
+// structured content. It is defined by a set of queries that can be
+// used to extract specific information from the file.
 //
 // The supported engines are:
 //
 // - `tree-sitter`
 // - `dasel`
 // - `command`
-type Blueprint struct {
+type View struct {
 	Engine string  `yaml:"engine"`
 	Scopes []Scope `yaml:"scopes"`
 }
@@ -43,34 +45,34 @@ type ScopedValues struct {
 	Values []string
 }
 
-// NewBlueprint creates a new blueprint from the given path.
-func NewBlueprint(path string) (*Blueprint, error) {
-	var blueprint Blueprint
+// NewView creates a new blueprint from the given path.
+func NewView(path string) (*View, error) {
+	var view View
 
 	data, err := os.ReadFile(path)
 	if err != nil {
 		return nil, err
 	}
 
-	err = yaml.Unmarshal(data, &blueprint)
+	err = yaml.Unmarshal(data, &view)
 	if err != nil {
 		return nil, err
 	}
 
-	if blueprint.Engine == "" {
+	if view.Engine == "" {
 		return nil, fmt.Errorf("missing parser")
-	} else if !StringInSlice(blueprint.Engine, blueprintEngines) {
-		return nil, fmt.Errorf("unsupported parser: %s", blueprint.Engine)
+	} else if !StringInSlice(view.Engine, viewEngines) {
+		return nil, fmt.Errorf("unsupported parser: %s", view.Engine)
 	}
 
-	if len(blueprint.Scopes) == 0 {
+	if len(view.Scopes) == 0 {
 		return nil, fmt.Errorf("missing queries")
 	}
 
-	return &blueprint, nil
+	return &view, nil
 }
 
-func (b *Blueprint) Apply(f *File) ([]ScopedValues, error) {
+func (b *View) Apply(f *File) ([]ScopedValues, error) {
 	found := []ScopedValues{}
 
 	value, err := fileToValue(f)

internal/lint/code.go

@@ -13,15 +13,15 @@ import (
 	"github.com/errata-ai/vale/v3/internal/nlp"
 )
 
-func updateQueries(f *core.File, blueprints map[string]*core.Blueprint) ([]core.Scope, error) {
+func updateQueries(f *core.File, views map[string]*core.View) ([]core.Scope, error) {
 	var found []core.Scope
 
-	for syntax, blueprint := range blueprints {
+	for syntax, view := range views {
 		sec, err := glob.Compile(syntax)
 		if err != nil {
 			return nil, err
 		} else if sec.Match(f.Path) {
-			found = blueprint.Scopes
+			found = view.Scopes
 		}
 	}
 
@@ -36,7 +36,7 @@ func (l *Linter) lintCode(f *core.File) error {
 	}
 	ignored := l.Manager.Config.IgnoredScopes
 
-	found, err := updateQueries(f, l.Manager.Config.Blueprints)
+	found, err := updateQueries(f, l.Manager.Config.Views)
 	if err != nil {
 		return err
 	} else if len(found) > 0 {

internal/lint/data.go

@@ -9,16 +9,16 @@ import (
 )
 
 func (l *Linter) lintData(f *core.File) error {
-	for syntax, blueprint := range l.Manager.Config.Blueprints {
+	for syntax, view := range l.Manager.Config.Views {
 		sec, err := glob.Compile(syntax)
 		if err != nil {
 			return err
 		} else if sec.Match(f.Path) {
-			found, berr := blueprint.Apply(f)
+			found, berr := view.Apply(f)
 			if berr != nil {
 				return core.NewE201FromTarget(
 					berr.Error(),
-					fmt.Sprintf("Blueprint = %s", blueprint),
+					fmt.Sprintf("View = %s", view),
 					l.Manager.Config.RootINI,
 				)
 			}

internal/lint/fragment.go

@@ -58,7 +58,7 @@ func (l *Linter) lintFragments(f *core.File) error {
 		return err
 	}
 
-	found, err := updateQueries(f, l.Manager.Config.Blueprints)
+	found, err := updateQueries(f, l.Manager.Config.Views)
 	if err != nil {
 		return err
 	} else if len(found) > 0 {

internal/lint/lint.go

@@ -184,8 +184,8 @@ func (l *Linter) lintFile(src string) lintResult {
 	simple := l.Manager.Config.Flags.Simple
 
 	// NOTE: This is a sanity check to ensure that we don't run any checks that
-	// we actually have a blueprint to apply.
-	hasBlueprints := len(l.Manager.Config.Blueprints) > 0
+	// we actually have a View to apply.
+	hasViews := len(l.Manager.Config.Views) > 0
 
 	if file.Format == "markup" && !simple { //nolint:gocritic
 		switch file.NormedExt {
@@ -206,7 +206,7 @@ func (l *Linter) lintFile(src string) lintResult {
 		case ".org":
 			err = l.lintOrg(file)
 		}
-	} else if file.Format == "data" && !simple && hasBlueprints {
+	} else if file.Format == "data" && !simple && hasViews {
 		err = l.lintData(file)
 	} else if file.Format == "code" && !simple {
 		err = l.lintCode(file)

testdata/features/blueprints.feature

@@ -1,6 +1,6 @@
-Feature: Blueprints
+Feature: Views
     Scenario: YAML
-        When I test "blueprints"
+        When I test "views"
         Then the output should contain exactly:
             """
             API.yml:3:10:Scopes.Titles:'sample API' should be capitalized

testdata/fixtures/blueprints/.vale.ini testdata/fixtures/views/.vale.initestdata/fixtures/blueprints/.vale.ini renamed to testdata/fixtures/views/.vale.ini

@@ -7,21 +7,21 @@ py = md
 [*.json]
 BasedOnStyles = Vale
 
-Blueprint = GitHubActions
+View = GitHubActions
 
 [*.py]
 vale.Annotations = YES
 
-Blueprint = Python
+View = Python
 
 [*.{yml,yaml}]
 BasedOnStyles = Vale, Scopes
 
 [API.yml]
-Blueprint = OpenAPI
+View = OpenAPI
 
 [Petstore.yaml]
-Blueprint = Petstore
+View = Petstore
 
 [Rule.yml]
-Blueprint = Vale
+View = Vale