refactor: validate scope

errata-ai · Jul 6, 2023 · 4711b32 · 4711b32
1 parent 9174696
commit 4711b32
Show file tree

Hide file tree

Showing 10 changed files with 76 additions and 0 deletions.
diff --git a/internal/check/capitalization.go b/internal/check/capitalization.go
@@ -40,6 +40,11 @@ func NewCapitalization(cfg *core.Config, generic baseCheck, path string) (Capita
  return rule, readStructureError(err, path)
  }
 
+ err = checkScopes(rule.Scope, path)
+ if err != nil {
+ return rule, err
+ }
+
  re, err := updateExceptions(rule.Exceptions, cfg.AcceptedTokens)
  if err != nil {
  return rule, core.NewE201FromPosition(err.Error(), path, 1)

diff --git a/internal/check/conditional.go b/internal/check/conditional.go
@@ -27,6 +27,11 @@ func NewConditional(cfg *core.Config, generic baseCheck, path string) (Condition
  return rule, readStructureError(err, path)
  }
 
+ err = checkScopes(rule.Scope, path)
+ if err != nil {
+ return rule, err
+ }
+
  re, err := updateExceptions(rule.Exceptions, cfg.AcceptedTokens)
  if err != nil {
  return rule, core.NewE201FromPosition(err.Error(), path, 1)

diff --git a/internal/check/consistency.go b/internal/check/consistency.go
@@ -40,6 +40,11 @@ func NewConsistency(cfg *core.Config, generic baseCheck, path string) (Consisten
  return rule, readStructureError(err, path)
  }
 
+ err = checkScopes(rule.Scope, path)
+ if err != nil {
+ return rule, err
+ }
+
  regex := makeRegexp(
  cfg.WordTemplate,
  rule.Ignorecase,

diff --git a/internal/check/definition.go b/internal/check/definition.go
@@ -357,3 +357,17 @@ func decodeRule(input interface{}, output interface{}) error {
 
  return decoder.Decode(input)
 }
+
+func checkScopes(scopes []string, path string) error {
+ for _, scope := range scopes {
+ // Negation ...
+ scope = strings.TrimPrefix(scope, "~")
+ if !core.StringInSlice(scope, allowedScopes) {
+ return core.NewE201FromTarget(
+ fmt.Sprintf("'scope' must be one of %v", allowedScopes),
+ "scope",
+ path)
+ }
+ }
+ return nil
+}
diff --git a/internal/check/existence.go b/internal/check/existence.go
@@ -32,6 +32,11 @@ func NewExistence(cfg *core.Config, generic baseCheck, path string) (Existence,
  return rule, readStructureError(err, path)
  }
 
+ err = checkScopes(rule.Scope, path)
+ if err != nil {
+ return rule, err
+ }
+
  re, err := updateExceptions(rule.Exceptions, cfg.AcceptedTokens)
  if err != nil {
  return rule, core.NewE201FromPosition(err.Error(), path, 1)

diff --git a/internal/check/occurrence.go b/internal/check/occurrence.go
@@ -25,6 +25,11 @@ func NewOccurrence(cfg *core.Config, generic baseCheck, path string) (Occurrence
  return rule, readStructureError(err, path)
  }
 
+ err = checkScopes(rule.Scope, path)
+ if err != nil {
+ return rule, err
+ }
+
  regex := ""
  if rule.Ignorecase {
  regex += ignoreCase

diff --git a/internal/check/repetition.go b/internal/check/repetition.go
@@ -27,6 +27,11 @@ func NewRepetition(cfg *core.Config, generic baseCheck, path string) (Repetition
  return rule, readStructureError(err, path)
  }
 
+ err = checkScopes(rule.Scope, path)
+ if err != nil {
+ return rule, err
+ }
+
  regex := ""
  if rule.Ignorecase {
  regex += ignoreCase

diff --git a/internal/check/scope.go b/internal/check/scope.go
@@ -7,6 +7,28 @@ import (
  "github.com/errata-ai/vale/v2/internal/nlp"
 )
 
+var allowedScopes = []string{
+ "text",
+ "heading",
+ "heading.h1",
+ "heading.h2",
+ "heading.h3",
+ "heading.h4",
+ "heading.h5",
+ "heading.h6",
+ "table.header",
+ "table.cell",
+ "table.caption",
+ "figure.caption",
+ "list",
+ "paragraph",
+ "sentence",
+ "alt",
+ "blockquote",
+ "summary",
+ "raw",
+}
+
 // A Selector represents a named section of text.
 type Selector struct {
  Value []string // e.g., text.comment.line.py

diff --git a/internal/check/sequence.go b/internal/check/sequence.go
@@ -47,6 +47,11 @@ func NewSequence(cfg *core.Config, generic baseCheck, path string) (Sequence, er
  return rule, readStructureError(err, path)
  }
 
+ err = checkScopes(rule.Scope, path)
+ if err != nil {
+ return rule, err
+ }
+
  for i, token := range rule.Tokens {
  if !rule.needsTagging && token.Tag != "" {
  rule.needsTagging = true

diff --git a/internal/check/substitution.go b/internal/check/substitution.go
@@ -30,6 +30,11 @@ func NewSubstitution(cfg *core.Config, generic baseCheck, path string) (Substitu
  if err != nil {
  return rule, readStructureError(err, path)
  }
+
+ err = checkScopes(rule.Scope, path)
+ if err != nil {
+ return rule, err
+ }
  tokens := ""
 
  re, err := updateExceptions(rule.Exceptions, cfg.AcceptedTokens)