MAJOR: allow reading allowed list from a remote json file

Author: oktalz

.aspell.yml

@@ -30,3 +30,6 @@ allowed:
   - devel
   - ioutil
   - defaultconf
+  - json
+  - req
+  - nallowed

aspell/aspell.go

@@ -14,12 +14,19 @@ import (
 	"github.com/fatih/camelcase"
 )
 
+type RemoteFile struct {
+	URL             string `yaml:"url"`
+	HeaderFromENV   string `yaml:"header_from_env"`
+	AllowedItemsKey string `yaml:"allowed_items_key"`
+}
+
 type Aspell struct {
-	Mode         mode     `yaml:"mode"`
-	MinLength    int      `yaml:"min_length"`
-	IgnoreFiles  []string `yaml:"ignore_files"`
-	AllowedWords []string `yaml:"allowed"`
-	HelpText     string   `yaml:"-"`
+	Mode         mode       `yaml:"mode"`
+	RemoteFile   RemoteFile `yaml:"remote_file"`
+	MinLength    int        `yaml:"min_length"`
+	IgnoreFiles  []string   `yaml:"ignore_files"`
+	AllowedWords []string   `yaml:"allowed"`
+	HelpText     string     `yaml:"-"`
 }
 
 var (

aspell/new.go

@@ -24,9 +24,20 @@ func New(filename string) (Aspell, error) {
 		return Aspell{}, err
 	}
 
+	var extraAllowedWords []string
+	if aspell.RemoteFile.URL != "" {
+		extraAllowedWords, err = fetchRemoteFile(aspell)
+		if err != nil {
+			return Aspell{}, err
+		}
+	}
+
 	for i, word := range aspell.AllowedWords {
 		aspell.AllowedWords[i] = strings.ToLower(word)
 	}
+	for _, word := range extraAllowedWords {
+		aspell.AllowedWords = append(aspell.AllowedWords, strings.ToLower(word))
+	}
 
 	if aspell.MinLength < 1 {
 		aspell.MinLength = 3
@@ -59,6 +70,9 @@ allowed:
   - config
 `
 	}
+	if aspell.RemoteFile.URL != "" {
+		aspell.HelpText += fmt.Sprintf("\n\nallowed words can be added to remote file:\n  url: %s\n", aspell.RemoteFile.URL)
+	}
 
 	ignoreFiles := []string{"go.mod", "go.sum"}
 	for _, file := range ignoreFiles {

aspell/remote.go

@@ -0,0 +1,68 @@
+package aspell
+
+import (
+	"encoding/json"
+	"net/http"
+	"os"
+	"strings"
+
+	"gopkg.in/yaml.v3"
+)
+
+func fetchRemoteFile(aspell Aspell) ([]string, error) {
+	url := aspell.RemoteFile.URL
+	if url == "" {
+		return []string{}, nil
+	}
+
+	req, err := http.NewRequest("GET", url, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	if aspell.RemoteFile.HeaderFromENV != "" {
+		envValue := os.Getenv(aspell.RemoteFile.HeaderFromENV)
+		req.Header.Set(aspell.RemoteFile.HeaderFromENV, envValue)
+	}
+
+	client := &http.Client{}
+	resp, err := client.Do(req)
+	if err != nil {
+		return nil, err
+	}
+
+	defer resp.Body.Close()
+
+	var data map[string]interface{}
+	err = json.NewDecoder(resp.Body).Decode(&data)
+	if err != nil {
+		return nil, err
+	}
+
+	var allowedWords []string
+
+	items, ok := data[aspell.RemoteFile.AllowedItemsKey].([]interface{})
+	if !ok {
+		content, ok := data[aspell.RemoteFile.AllowedItemsKey].(string)
+		if !ok {
+			return nil, nil
+		}
+		if strings.HasPrefix(content, "```yaml\n") && strings.HasSuffix(content, "\n```") {
+			content = strings.TrimPrefix(content, "```yaml\n")
+			content = strings.TrimSuffix(content, "\n```")
+			err = yaml.Unmarshal([]byte(content), &allowedWords)
+			if err != nil {
+				return nil, err
+			}
+
+			return allowedWords, nil
+		}
+		allowedWords = strings.Split(content, "\n")
+	}
+
+	for _, item := range items {
+		allowedWords = append(allowedWords, item.(string))
+	}
+
+	return allowedWords, nil
+}

go.mod

@@ -5,6 +5,7 @@ go 1.24.0
 require (
 	github.com/fatih/camelcase v1.0.0
 	github.com/google/go-github/v56 v56.0.0
+	github.com/joho/godotenv v1.5.1
 	github.com/xanzy/go-gitlab v0.115.0
 	golang.org/x/oauth2 v0.26.0
 	gopkg.in/src-d/go-git.v4 v4.13.1

go.sum

@@ -38,6 +38,8 @@ github.com/hashicorp/go-retryablehttp v0.7.7/go.mod h1:pkQpWZeYWskR+D1tR2O5OcBFO
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A=
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo=
 github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
+github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0=
+github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
 github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM=
 github.com/kevinburke/ssh_config v1.2.0 h1:x584FjTGwHzMwvHx18PXxbBVzfnxogHaAReU4gf13a4=
 github.com/kevinburke/ssh_config v1.2.0/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM=

main.go

@@ -8,9 +8,11 @@ import (
 
 	"github.com/haproxytech/check-commit/v5/aspell"
 	"github.com/haproxytech/check-commit/v5/version"
+	"github.com/joho/godotenv"
 )
 
 func main() {
+	_ = godotenv.Load(".env")
 	err := version.Set()
 	if err != nil {
 		log.Fatal(err)