refactor: only fetch library when needed

jdkato · jdkato · commit df4a93489ad4 · 2024-12-25T08:12:06.000-07:00
#932 WIP
diff --git a/cmd/vale/library.go b/cmd/vale/library.go
@@ -0,0 +1,33 @@
+package main
+
+import "encoding/json"
+
+var library = "https://raw.githubusercontent.com/errata-ai/styles/master/library.json"
+
+func getLibrary(_ string) ([]Style, error) {
+	styles := []Style{}
+
+	resp, err := fetchJSON(library)
+	if err != nil {
+		return styles, err
+	} else if err = json.Unmarshal(resp, &styles); err != nil {
+		return styles, err
+	}
+
+	return styles, err
+}
+
+func inLibrary(name, path string) string {
+	lookup, err := getLibrary(path)
+	if err != nil {
+		return ""
+	}
+
+	for _, entry := range lookup {
+		if name == entry.Name {
+			return entry.URL
+		}
+	}
+
+	return ""
+}
diff --git a/cmd/vale/sync.go b/cmd/vale/sync.go
@@ -1,7 +1,6 @@
 package main
 
 import (
-	"encoding/json"
 	"fmt"
 	"os"
 	"path/filepath"
@@ -13,8 +12,6 @@ import (
 	"github.com/errata-ai/vale/v3/internal/core"
 )
 
-var library = "https://raw.githubusercontent.com/errata-ai/styles/master/library.json"
-
 func initPath(cfg *core.Config) error {
 	// The first entry is always the default `StylesPath`.
 	stylesPath := cfg.StylesPath()
@@ -36,29 +33,13 @@ func initPath(cfg *core.Config) error {
 }
 
 func readPkg(pkg, path string, idx int) error {
-	lookup, err := getLibrary(path)
-	if err != nil {
-		return err
-	}
-
-	found := false
-	for _, entry := range lookup {
-		if pkg == entry.Name {
-			found = true
-			if err = download(pkg, entry.URL, path, idx); err != nil {
-				return err
-			}
+	if core.IsPhrase(pkg) && !core.IsDir(pkg) {
+		entry := inLibrary(pkg, path)
+		if entry != "" {
+			return download(pkg, entry, path, idx)
 		}
 	}
-
-	if !found {
-		name := fileNameWithoutExt(pkg)
-		if err = loadPkg(name, pkg, path, idx); err != nil {
-			return err
-		}
-	}
-
-	return nil
+	return loadPkg(fileNameWithoutExt(pkg), pkg, path, idx)
 }
 
 func loadPkg(name, urlOrPath, styles string, index int) error {
@@ -96,7 +77,7 @@ func download(name, url, styles string, index int) error {
 
 	if err = fetch(url, dir); err != nil {
 		if strings.Contains(err.Error(), "unsupported protocol scheme") {
-			err = fmt.Errorf("'%s' is not a valid URL or the local file doesn't exist", url)
+			err = fmt.Errorf("'%s' is not a valid URL or the directory doesn't exist", url)
 		}
 		return core.NewE100("download", err)
 	}
@@ -194,16 +175,3 @@ func moveAsset(name, old, new string) error { //nolint:predeclared
 
 	return cp.Copy(src, dst)
 }
-
-func getLibrary(_ string) ([]Style, error) {
-	styles := []Style{}
-
-	resp, err := fetchJSON(library)
-	if err != nil {
-		return styles, err
-	} else if err = json.Unmarshal(resp, &styles); err != nil {
-		return styles, err
-	}
-
-	return styles, err
-}
diff --git a/internal/core/util_test.go b/internal/core/util_test.go
@@ -38,8 +38,12 @@ func TestPrepText(t *testing.T) {
 
 func TestPhrase(t *testing.T) {
 	rawToPrepped := map[string]bool{
-		"test suite":    true,
-		"test[ ]?suite": false,
+		"test suite":               true,
+		"test[ ]?suite":            false,
+		"Google":                   true,
+		"write-good":               true,
+		"https://vale.sh/explorer": false,
+		"Google.zip":               false,
 	}
 	for input, output := range rawToPrepped {
 		result := IsPhrase(input)
