refactor: clean up cmd execution

Author: jdkato

internal/lint/adoc.go

@@ -1,10 +1,8 @@
 package lint
 
 import (
-	"bytes"
 	"errors"
 	"fmt"
-	"os/exec"
 	"regexp"
 	"strings"
 
@@ -28,6 +26,14 @@ var adocSanitizer = strings.NewReplacer(
 var reSource = regexp.MustCompile(`\[source,.+\]`)
 var reComment = regexp.MustCompile(`// .+`)
 
+var adocArgs = []string{
+	"-s",
+	"-a",
+	"notitle!",
+	"-a",
+	"attribute-missing=drop",
+}
+
 func (l *Linter) lintADoc(f *core.File) error {
 	var html string
 	var err error
@@ -43,7 +49,7 @@ func (l *Linter) lintADoc(f *core.File) error {
 	}
 	s = adocSanitizer.Replace(s)
 
-	html, err = callAdoc(f, s, exe, l.Manager.Config.Asciidoctor)
+	html, err = callAdoc(s, exe, l.Manager.Config.Asciidoctor)
 	if err != nil {
 		return core.NewE100(f.Path, err)
 	}
@@ -82,31 +88,10 @@ func (l *Linter) lintADoc(f *core.File) error {
 	return l.lintHTMLTokens(f, []byte(html), 0)
 }
 
-func callAdoc(_ *core.File, text, exe string, attrs map[string]string) (string, error) {
-	var out bytes.Buffer
-	var eut bytes.Buffer
-
-	var adocArgs = []string{
-		"-s",
-		"-a",
-		"notitle!",
-		"-a",
-		"attribute-missing=drop",
-	}
-
+func callAdoc(text, exe string, attrs map[string]string) (string, error) {
 	adocArgs = append(adocArgs, parseAttributes(attrs)...)
 	adocArgs = append(adocArgs, []string{"--safe-mode", "secure", "-"}...)
-
-	cmd := exec.Command(exe, adocArgs...)
-	cmd.Stdin = strings.NewReader(text)
-	cmd.Stdout = &out
-	cmd.Stderr = &eut
-
-	if err := cmd.Run(); err != nil {
-		return "", errors.New(eut.String())
-	}
-
-	return out.String(), nil
+	return system.ExecuteWithInput(exe, text, adocArgs...)
 }
 
 func parseAttributes(attrs map[string]string) []string {

internal/lint/md.go

@@ -45,12 +45,17 @@ func (l Linter) lintMarkdown(f *core.File) error {
 		return core.NewE100(f.Path, err)
 	}
 
+	f.Content = prepMarkdown(f.Content)
+	return l.lintHTMLTokens(f, buf.Bytes(), 0)
+}
+
+func prepMarkdown(content string) string {
 	// NOTE: This is required to avoid finding matches inside info strings. For
 	// example, if we're looking for 'json' we many incorrectly report the
 	// location as being in an infostring like '```json'.
 	//
 	// See https://github.com/errata-ai/vale/v2/issues/248.
-	body := reExInfo.ReplaceAllStringFunc(f.Content, func(m string) string {
+	body := reExInfo.ReplaceAllStringFunc(content, func(m string) string {
 		parts := strings.Split(m, "`")
 
 		// This ensures that we respect the number of opening backticks, which
@@ -76,6 +81,5 @@ func (l Linter) lintMarkdown(f *core.File) error {
 		return strings.Repeat("*", nlp.StrLen(m))
 	})
 
-	f.Content = body
-	return l.lintHTMLTokens(f, buf.Bytes(), 0)
+	return body
 }

internal/lint/mdx.go

@@ -1,13 +1,9 @@
 package lint
 
 import (
-	"bytes"
 	"errors"
-	"os/exec"
-	"strings"
 
 	"github.com/errata-ai/vale/v3/internal/core"
-	"github.com/errata-ai/vale/v3/internal/nlp"
 	"github.com/errata-ai/vale/v3/internal/system"
 )
 
@@ -25,58 +21,11 @@ func (l Linter) lintMDX(f *core.File) error {
 		return err
 	}
 
-	html, err = callVast(f, s, exe)
+	html, err = system.ExecuteWithInput(exe, s)
 	if err != nil {
 		return core.NewE100(f.Path, err)
 	}
 
-	// NOTE: This is required to avoid finding matches inside info strings. For
-	// example, if we're looking for 'json' we many incorrectly report the
-	// location as being in an infostring like '```json'.
-	//
-	// See https://github.com/errata-ai/vale/v2/issues/248.
-	body := reExInfo.ReplaceAllStringFunc(f.Content, func(m string) string {
-		parts := strings.Split(m, "`")
-
-		// This ensures that we respect the number of opening backticks, which
-		// could be more than 3.
-		//
-		// See https://github.com/errata-ai/vale/v2/issues/271.
-		tags := strings.Repeat("`", len(parts)-1)
-		span := strings.Repeat("*", nlp.StrLen(parts[len(parts)-1]))
-
-		return tags + span
-	})
-
-	// NOTE: This is required to avoid finding matches inside link references.
-	body = reLinkRef.ReplaceAllStringFunc(body, func(m string) string {
-		return "][" + strings.Repeat("*", nlp.StrLen(m)-3) + "]"
-	})
-	body = reLinkDef.ReplaceAllStringFunc(body, func(m string) string {
-		return "[" + strings.Repeat("*", nlp.StrLen(m)-3) + "]:"
-	})
-
-	// NOTE: This is required to avoid finding matches inside ordered lists.
-	body = reNumericList.ReplaceAllStringFunc(body, func(m string) string {
-		return strings.Repeat("*", nlp.StrLen(m))
-	})
-
-	f.Content = body
+	f.Content = prepMarkdown(f.Content)
 	return l.lintHTMLTokens(f, []byte(html), 0)
 }
-
-func callVast(_ *core.File, text, exe string) (string, error) {
-	var out bytes.Buffer
-	var eut bytes.Buffer
-
-	cmd := exec.Command(exe)
-	cmd.Stdin = strings.NewReader(text)
-	cmd.Stdout = &out
-	cmd.Stderr = &eut
-
-	if err := cmd.Run(); err != nil {
-		return "", errors.New(eut.String())
-	}
-
-	return out.String(), nil
-}

internal/lint/rst.go

@@ -1,9 +1,7 @@
 package lint
 
 import (
-	"bytes"
 	"errors"
-	"os/exec"
 	"regexp"
 	"strings"
 
@@ -61,17 +59,10 @@ func (l *Linter) lintRST(f *core.File) error {
 }
 
 func callRst(text, lib, _ string) (string, error) {
-	var out bytes.Buffer
-
-	cmd := exec.Command(lib, rstArgs...)
-	cmd.Stdin = strings.NewReader(text)
-	cmd.Stdout = &out
-
-	if err := cmd.Run(); err != nil {
+	html, err := system.ExecuteWithInput(lib, text, rstArgs...)
+	if err != nil {
 		return "", err
 	}
-
-	html := out.String()
 	html = strings.ReplaceAll(html, "\r", "")
 
 	bodyStart := strings.Index(html, "<body>\n")

internal/system/cmd.go

@@ -0,0 +1,25 @@
+package system
+
+import (
+	"bytes"
+	"errors"
+	"os/exec"
+	"strings"
+)
+
+// ExecuteWithInput runs a command with the given text as input.
+func ExecuteWithInput(exe, text string, args ...string) (string, error) {
+	var out bytes.Buffer
+	var eut bytes.Buffer
+
+	cmd := exec.Command(exe, args...)
+	cmd.Stdin = strings.NewReader(text)
+	cmd.Stdout = &out
+	cmd.Stderr = &eut
+
+	if err := cmd.Run(); err != nil {
+		return "", errors.New(eut.String())
+	}
+
+	return out.String(), nil
+}