feat: watching changed on configuration file

Co-Authored-By: Czékus Máté <[email protected]>

Author: 2 people

.gitignore

@@ -0,0 +1,27 @@
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# env file
+.env
+
+/bin

go.mod

@@ -7,6 +7,7 @@ require (
 	github.com/dop251/goja v0.0.0-20240828124009-016eb7256539
 	github.com/dop251/goja_nodejs v0.0.0-20240728170619-29b559befffc
 	github.com/dustin/go-humanize v1.0.1
+	github.com/fsnotify/fsnotify v1.7.0
 	github.com/ghodss/yaml v1.0.0
 	github.com/gizak/termui/v3 v3.1.0
 	github.com/json-iterator/go v1.1.12
@@ -38,7 +39,6 @@ require (
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/dlclark/regexp2 v1.11.4 // indirect
 	github.com/dprotaso/go-yit v0.0.0-20240618133044-5a0af90af097 // indirect
-	github.com/fsnotify/fsnotify v1.7.0 // indirect
 	github.com/go-sourcemap/sourcemap v2.1.4+incompatible // indirect
 	github.com/google/pprof v0.0.0-20240727154555-813a5fbdbec8 // indirect
 	github.com/google/uuid v1.6.0 // indirect

language-server/config.go

@@ -0,0 +1,70 @@
+package languageserver
+
+import (
+	"os"
+
+	"github.com/daveshanley/vacuum/plugin"
+	"github.com/daveshanley/vacuum/rulesets"
+	"github.com/fsnotify/fsnotify"
+	"github.com/spf13/viper"
+)
+
+func (s *ServerState) onConfigChange(e fsnotify.Event) {
+
+	// extract flags
+	rulesetFlag := viper.GetString("ruleset")
+	functionsFlag := viper.GetString("functions")
+	baseFlag := viper.GetString("base")
+	skipCheckFlag := viper.GetBool("skip-check")
+	remoteFlag := viper.GetBool("remote")
+	timeoutFlag := viper.GetInt("timeout")
+	hardModeFlag := viper.GetBool("hard-mode")
+	ignoreArrayCircleRef := viper.GetBool("ignore-array-circle-ref")
+	ignorePolymorphCircleRef := viper.GetBool("ignore-array-circle-ref")
+
+	defaultRuleSets := rulesets.BuildDefaultRuleSetsWithLogger(s.lintRequest.Logger)
+	selectedRS := defaultRuleSets.GenerateOpenAPIRecommendedRuleSet()
+	functions := s.lintRequest.Functions
+
+	// FUNCTIONS
+	if functionsFlag != "" {
+		pm, err := plugin.LoadFunctions(functionsFlag, true)
+		if err == nil {
+			functions = pm.GetCustomFunctions()
+		}
+	}
+
+	// HARD MODE
+	if hardModeFlag {
+		selectedRS = defaultRuleSets.GenerateOpenAPIDefaultRuleSet()
+
+		// extract all OWASP Rules
+		owaspRules := rulesets.GetAllOWASPRules()
+		allRules := selectedRS.Rules
+		for k, v := range owaspRules {
+			allRules[k] = v
+		}
+	}
+
+	// RULESET
+	if rulesetFlag != "" {
+		rsBytes, rsErr := os.ReadFile(rulesetFlag)
+		if rsErr == nil {
+			// load in our user supplied ruleset and try to validate it.
+			userRS, userErr := rulesets.CreateRuleSetFromData(rsBytes)
+			if userErr == nil {
+				selectedRS = defaultRuleSets.GenerateRuleSetFromSuppliedRuleSet(userRS)
+			}
+		}
+	}
+
+	s.lintRequest.BaseFlag = baseFlag
+	s.lintRequest.Remote = remoteFlag
+	s.lintRequest.SkipCheckFlag = skipCheckFlag
+	s.lintRequest.DefaultRuleSets = defaultRuleSets
+	s.lintRequest.SelectedRS = selectedRS
+	s.lintRequest.Functions = functions
+	s.lintRequest.TimeoutFlag = timeoutFlag
+	s.lintRequest.IgnoreArrayCircleRef = ignoreArrayCircleRef
+	s.lintRequest.IgnorePolymorphCircleRef = ignorePolymorphCircleRef
+}

language-server/server.go

@@ -17,15 +17,17 @@ package languageserver
 
 import (
 	"fmt"
+	"path/filepath"
+	"strings"
+	"time"
+
 	"github.com/daveshanley/vacuum/model"
 	"github.com/daveshanley/vacuum/motor"
 	"github.com/daveshanley/vacuum/utils"
+	"github.com/spf13/viper"
 	"github.com/tliron/glsp"
 	protocol "github.com/tliron/glsp/protocol_3_16"
 	glspserv "github.com/tliron/glsp/server"
-	"path/filepath"
-	"strings"
-	"time"
 )
 
 var serverName = "vacuum"
@@ -101,6 +103,8 @@ func NewServer(version string, lintRequest *utils.LintFileRequest) *ServerState
 }
 
 func (s *ServerState) Run() error {
+	viper.OnConfigChange(s.onConfigChange)
+	viper.WatchConfig()
 	return s.server.RunStdio()
 }