feat: add support for JSON, YAML, and TOML

Author: jdkato

go.mod

@@ -20,15 +20,17 @@ require (
 	github.com/niklasfasching/go-org v1.6.6
 	github.com/olekukonko/tablewriter v0.0.4
 	github.com/otiai10/copy v1.7.0
+	github.com/pelletier/go-toml/v2 v2.2.3
 	github.com/pterm/pterm v0.12.76
 	github.com/remeh/sizedwaitgroup v1.0.0
 	github.com/smacker/go-tree-sitter v0.0.0-20240514083259-c5d1f3f5f99e
 	github.com/spf13/pflag v1.0.5
-	github.com/stretchr/testify v1.8.4
+	github.com/stretchr/testify v1.9.0
+	github.com/tomwright/dasel/v2 v2.8.1
 	github.com/yuin/goldmark v1.5.6
 	golang.org/x/exp v0.0.0-20231006140011-7918f672742d
-	golang.org/x/net v0.23.0
-	golang.org/x/sys v0.18.0
+	golang.org/x/net v0.25.0
+	golang.org/x/sys v0.20.0
 	gopkg.in/yaml.v2 v2.4.0
 )
 
@@ -64,9 +66,9 @@ require (
 	github.com/ulikunitz/xz v0.5.10 // indirect
 	github.com/xi2/xz v0.0.0-20171230120015-48954b6210f8 // indirect
 	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
-	golang.org/x/crypto v0.21.0 // indirect
-	golang.org/x/term v0.18.0 // indirect
-	golang.org/x/text v0.14.0 // indirect
+	golang.org/x/crypto v0.23.0 // indirect
+	golang.org/x/term v0.20.0 // indirect
+	golang.org/x/text v0.15.0 // indirect
 	gopkg.in/neurosnap/sentences.v1 v1.0.7 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -119,6 +119,8 @@ github.com/otiai10/curr v1.0.0/go.mod h1:LskTG5wDwr8Rs+nNQ+1LlxRjAtTZZjtJW4rMXl6
 github.com/otiai10/mint v1.3.0/go.mod h1:F5AjcsTsWUqX+Na9fpHb52P8pcRX2CI6A3ctIT91xUo=
 github.com/otiai10/mint v1.3.3 h1:7JgpsBaN0uMkyju4tbYHu0mnM55hNKVYLsXmwr15NQI=
 github.com/otiai10/mint v1.3.3/go.mod h1:/yxELlJQ0ufhjUwhshSj+wFjZ78CnZ48/1wtmBH1OTc=
+github.com/pelletier/go-toml/v2 v2.2.3 h1:YmeHyLY8mFWbdkNWwpr+qIL2bEqT0o95WSdkNHvL12M=
+github.com/pelletier/go-toml/v2 v2.2.3/go.mod h1:MfCQTFTvCcUyyvvwm1+G6H/jORL20Xlb6rzQu9GuUkc=
 github.com/pierrec/lz4/v4 v4.1.2 h1:qvY3YFXRQE/XB8MlLzJH7mSzBs74eA2gg52YTk6jUPM=
 github.com/pierrec/lz4/v4 v4.1.2/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
@@ -159,8 +161,10 @@ github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
 github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.4/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
-github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
-github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/tomwright/dasel/v2 v2.8.1 h1:mo5SlL0V2d3a0uPsD9Rrndn0cHWpbNDheB4+Fm++z8k=
+github.com/tomwright/dasel/v2 v2.8.1/go.mod h1:6bNDNAnmGEtGpuIvksuQwiNcAgQ87pmzndynsqTNglc=
 github.com/ulikunitz/xz v0.5.8/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
 github.com/ulikunitz/xz v0.5.9/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
 github.com/ulikunitz/xz v0.5.10 h1:t92gobL9l3HE202wg3rlk19F6X+JOxl9BBrCCMYEYd8=
@@ -176,8 +180,8 @@ github.com/yuin/goldmark v1.5.6/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5ta
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
 golang.org/x/crypto v0.3.0/go.mod h1:hebNnKkNXi2UzZN1eVRvBB7co0a+JxK6XbPiWVs/3J4=
-golang.org/x/crypto v0.21.0 h1:X31++rzVUdKhX5sWmSOFZxx8UW/ldWx55cbf08iNAMA=
-golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs=
+golang.org/x/crypto v0.23.0 h1:dIJU/v2J8Mdglj/8rJ6UUOM3Zc9zLZxVZwwxMooUSAI=
+golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8=
 golang.org/x/exp v0.0.0-20231006140011-7918f672742d h1:jtJma62tbqLibJ5sFQz8bKtEM8rJBtfilJ2qTU199MI=
 golang.org/x/exp v0.0.0-20231006140011-7918f672742d/go.mod h1:ldy0pHrwJyGW56pPQzzkH36rKxoZW1tw7ZJpeKx+hdo=
 golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
@@ -187,8 +191,8 @@ golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v
 golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
 golang.org/x/net v0.2.0/go.mod h1:KqCZLdyyvdV855qA2rE3GC2aiw5xGR5TEjj8smXukLY=
 golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
-golang.org/x/net v0.23.0 h1:7EYJ93RZ9vYSZAIb2x3lnuvqO5zneoD6IvWjuhfxjTs=
-golang.org/x/net v0.23.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg=
+golang.org/x/net v0.25.0 h1:d/OCCoBEUq33pjydKrGQhw7IlUPI2Oylr+8qLx49kac=
+golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
@@ -204,24 +208,24 @@ golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
-golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.20.0 h1:Od9JTbYCk261bKm4M/mw7AklTlFYIa0bIp9BgSm1S8Y=
+golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210220032956-6a3ed077a48d/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc=
 golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
-golang.org/x/term v0.18.0 h1:FcHjZXDMxI8mM3nwhX9HlKop4C0YQvCVCdwYl2wOtE8=
-golang.org/x/term v0.18.0/go.mod h1:ILwASektA3OnRv7amZ1xhE/KTR+u50pbXfZ03+6Nx58=
+golang.org/x/term v0.20.0 h1:VnkxpohqXaOBYJtBmEppKUG6mXpi+4O6purfc2+sMhw=
+golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
 golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
 golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
-golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
-golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
+golang.org/x/text v0.15.0 h1:h1V/4gjBv8v9cjcR6+AR5+/cIYK5N/WAgiv4xlsEtAk=
+golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
 golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=

internal/core/blueprint.go

@@ -0,0 +1,124 @@
+package core
+
+import (
+	"encoding/json"
+	"errors"
+	"fmt"
+	"os"
+
+	"github.com/pelletier/go-toml/v2"
+	"github.com/tomwright/dasel/v2"
+	"gopkg.in/yaml.v2"
+)
+
+type DaselValue = map[string]any
+
+var blueprintEngines = []string{"tree-sitter", "dasel", "command"}
+
+// A Query is a single query that we want to run against a document.
+//
+// The result of the query is optionally assigned the given scope.
+type Query struct {
+	Scope     string `yaml:"scope"`
+	Operation string `yaml:"operation"`
+}
+
+// A Blueprint is a set of queries that we want to run against a document.
+//
+// The supported engines are:
+//
+// - `tree-sitter`
+// - `dasel`
+// - `command`
+type Blueprint struct {
+	Engine string  `yaml:"engine"`
+	Steps  []Query `yaml:"steps"`
+}
+
+// A ScopedValues is a value that has been assigned a scope.
+type ScopedValues struct {
+	Scope  string
+	Values []string
+}
+
+// NewBlueprint creates a new blueprint from the given path.
+func NewBlueprint(path string) (*Blueprint, error) {
+	var blueprint Blueprint
+
+	data, err := os.ReadFile(path)
+	if err != nil {
+		return nil, err
+	}
+
+	err = yaml.Unmarshal(data, &blueprint)
+	if err != nil {
+		return nil, err
+	}
+
+	if blueprint.Engine == "" {
+		return nil, fmt.Errorf("missing parser")
+	} else if !StringInSlice(blueprint.Engine, blueprintEngines) {
+		return nil, fmt.Errorf("unsupported parser: %s", blueprint.Engine)
+	}
+
+	if len(blueprint.Steps) == 0 {
+		return nil, fmt.Errorf("missing queries")
+	}
+
+	return &blueprint, nil
+}
+
+func (b *Blueprint) Apply(f *File) ([]ScopedValues, error) {
+	found := []ScopedValues{}
+
+	value, err := fileToValue(f)
+	if err != nil {
+		return nil, NewE100(f.Path, err)
+	}
+
+	for _, s := range b.Steps {
+		selected, err := dasel.Select(value, s.Operation)
+		if err != nil {
+			return found, err
+		}
+
+		values := []string{}
+		for _, v := range selected {
+			values = append(values, v.String())
+		}
+
+		found = append(found, ScopedValues{
+			Scope:  s.Scope,
+			Values: values,
+		})
+	}
+
+	return found, nil
+}
+
+func fileToValue(f *File) (DaselValue, error) {
+	var value DaselValue
+
+	contents := []byte(f.Content)
+	switch f.RealExt {
+	case ".json":
+		err := json.Unmarshal(contents, &value)
+		if err != nil {
+			return nil, err
+		}
+	case ".yml":
+		err := yaml.Unmarshal(contents, &value)
+		if err != nil {
+			return nil, err
+		}
+	case ".toml":
+		err := toml.Unmarshal(contents, &value)
+		if err != nil {
+			return nil, err
+		}
+	default:
+		return nil, errors.New("unsupported file type")
+	}
+
+	return value, nil
+}

internal/core/config.go

@@ -33,13 +33,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")
+	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")
 )
 
 // ConfigDirs is a list of all directories that contain user-defined, non-style
@@ -52,6 +53,7 @@ var ConfigDirs = []string{
 	ActionDir,
 	ScriptDir,
 	FilterDir,
+	BlueprintsDir,
 }
 
 // ConfigVars is a list of all supported environment variables.
@@ -210,9 +212,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:"-"`
+	FallbackPath string                `json:"-"`
+	SecToPat     map[string]glob.Glob  `json:"-"`
+	Styles       []string              `json:"-"`
+	Blueprints   map[string]*Blueprint `json:"-"`
 
 	NLPEndpoint string // An external API to call for NLP-related work.
 
@@ -241,6 +244,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.Paths = []string{}
 	cfg.ConfigFiles = []string{}
 

internal/core/file.go

@@ -92,10 +92,11 @@ func NewFile(src string, config *Config) (*File, error) {
 	baseStyles := config.GBaseStyles
 	checks := make(map[string]bool)
 
+	names := []string{}
 	for _, fp := range filepaths {
 		for _, sec := range config.StyleKeys {
 			if pat, found := config.SecToPat[sec]; found && pat.Match(fp) {
-				baseStyles = config.SBaseStyles[sec]
+				names = append(names, config.SBaseStyles[sec]...)
 			}
 		}
 
@@ -108,6 +109,10 @@ func NewFile(src string, config *Config) (*File, error) {
 		}
 	}
 
+	if len(names) > 0 {
+		baseStyles = UniqueStrings(names)
+	}
+
 	lang := "en"
 	for syntax, code := range config.FormatToLang {
 		sec, err := glob.Compile(syntax)

internal/core/format.go

@@ -88,7 +88,9 @@ var FormatByExtension = map[string][]string{
 	`\.(?:ts|tsx)$`:    {".ts", "code"},
 	`\.(?:txt)$`:       {".txt", "text"},
 	`\.(?:xml)$`:       {".xml", "markup"},
-	`\.(?:yaml|yml)$`:  {".yml", "code"},
+	`\.(?:yaml|yml)$`:  {".yml", "data"},
+	`\.(?:json)$`:      {".json", "data"},
+	`\.(?:toml)$`:      {".toml", "data"},
 }
 
 // FormatFromExt takes a file extension and returns its [normExt, format]
@@ -101,6 +103,12 @@ func FormatFromExt(path string, mapping map[string]string) (string, string) {
 		if kind == "code" && getFormat("."+format) == "markup" {
 			// NOTE: This is a special case of embedded markup within code.
 			return "." + format, "fragment"
+		} else if kind == "data" && getFormat("."+format) == "markup" {
+			// NOTE: This is a special case of embedded markup within data.
+			//
+			// Unlike code, data formats are *always* linted as a fragment with
+			// the default format as plain text.
+			return "." + format, "data"
 		}
 		base = format
 	}

internal/core/ini.go

@@ -138,6 +138,22 @@ 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 { //nolint:unparam
+		name := sec.Key("Blueprint").String()
+
+		path := FindConfigAsset(cfg, name+".yml", BlueprintsDir)
+		if path == "" {
+			return fmt.Errorf("blueprint '%s' not found", name)
+		}
+
+		blueprint, err := NewBlueprint(path)
+		if err != nil {
+			return err
+		}
+
+		cfg.Blueprints[label] = blueprint
+		return nil
+	},
 }
 
 var globalOpts = map[string]func(*ini.Section, *Config){

internal/core/util.go

@@ -349,3 +349,18 @@ func FindProcess(pid int) *os.Process {
 
 	return p
 }
+
+// UniqueStrings returns a new slice with all duplicate strings removed.
+func UniqueStrings(slice []string) []string {
+	keys := make(map[string]bool)
+	list := []string{}
+
+	for _, entry := range slice {
+		if _, value := keys[entry]; !value {
+			keys[entry] = true
+			list = append(list, entry)
+		}
+	}
+
+	return list
+}

internal/lint/ast.go

@@ -150,14 +150,14 @@ func (l *Linter) lintScope(f *core.File, state *walker, txt string) error {
 			f.Metrics[strings.TrimPrefix(scope, "text.")]++
 
 			txt = strings.TrimLeft(txt, " ")
-			b := state.block(txt, scope+f.RealExt)
+			b := state.block(txt, scope+l.metaScope+f.RealExt)
 			return l.lintBlock(f, b, state.lines, 0, false)
 		}
 	}
 
 	f.Summary.WriteString(txt + "\n\n")
 
-	b := state.block(txt, "txt")
+	b := state.block(txt, "text"+l.metaScope+f.RealExt)
 	return l.lintProse(f, b, state.lines)
 }