feat: Actually use interface for logger

Author: yhakbar

internal/logger/logger.go

@@ -7,24 +7,33 @@ import (
 	"os"
 )
 
-// Logger is a wrapper around slog.Logger that provides additional methods
-type Logger struct {
+var _ Logger = &slogLogger{}
+
+// slogLogger is a wrapper around slog.Logger that provides additional methods
+type slogLogger struct {
 	*slog.Logger
 	closer io.Closer
 }
 
+type Logger interface {
+	Close() error
+	Debug(msg string, args ...interface{})
+	Info(msg string, args ...interface{})
+	Error(msg string, args ...interface{})
+}
+
 // NewLogger builds the standard logger for terragrunt-ls.
 //
 // When supplied with a filename, it'll create a new file and write logs to it.
 // Otherwise, it'll write logs to stderr.
-func NewLogger(filename string) *Logger {
+func NewLogger(filename string) *slogLogger {
 	if filename == "" {
-		handler := slog.NewJSONHandler(os.Stderr, &slog.HandlerOptions{
+		handler := slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{
 			Level: slog.LevelInfo,
 		})
 		logger := slog.New(handler)
 
-		return &Logger{
+		return &slogLogger{
 			Logger: logger,
 		}
 	}
@@ -42,14 +51,14 @@ func NewLogger(filename string) *Logger {
 	})
 	logger := slog.New(handler)
 
-	return &Logger{
+	return &slogLogger{
 		Logger: logger,
 		closer: file,
 	}
 }
 
 // Close closes the logger
-func (l *Logger) Close() error {
+func (l *slogLogger) Close() error {
 	if l.closer != nil {
 		return l.closer.Close()
 	}
@@ -58,16 +67,16 @@ func (l *Logger) Close() error {
 }
 
 // Debug logs a debug message
-func (l *Logger) Debug(msg string, args ...interface{}) {
+func (l *slogLogger) Debug(msg string, args ...interface{}) {
 	l.Logger.Debug(msg, args...)
 }
 
 // Info logs an info message
-func (l *Logger) Info(msg string, args ...interface{}) {
+func (l *slogLogger) Info(msg string, args ...interface{}) {
 	l.Logger.Info(msg, args...)
 }
 
 // Error logs an error message
-func (l *Logger) Error(msg string, args ...interface{}) {
+func (l *slogLogger) Error(msg string, args ...interface{}) {
 	l.Logger.Error(msg, args...)
 }

internal/testutils/testutils.go

@@ -2,14 +2,23 @@
 package testutils
 
 import (
+	"io"
 	"log/slog"
 	"os"
 	"path/filepath"
 	"terragrunt-ls/internal/logger"
 	"testing"
 )
 
-func NewTestLogger(t *testing.T) *logger.Logger {
+var _ logger.Logger = &testLogger{}
+
+// Logger is a wrapper around slog.Logger that provides additional methods
+type testLogger struct {
+	*slog.Logger
+	closer io.Closer
+}
+
+func NewTestLogger(t *testing.T) *testLogger {
 	t.Helper()
 
 	// Create a test logger that writes to the test log
@@ -20,7 +29,7 @@ func NewTestLogger(t *testing.T) *logger.Logger {
 	slogger := slog.New(handler)
 
 	// Create a new logger with the test writer
-	return &logger.Logger{
+	return &testLogger{
 		Logger: slogger,
 	}
 }
@@ -54,3 +63,27 @@ func CreateFileWithMode(dir, name, content string, mode os.FileMode) (string, er
 
 	return path, nil
 }
+
+// Close closes the logger
+func (l *testLogger) Close() error {
+	if l.closer != nil {
+		return l.closer.Close()
+	}
+
+	return nil
+}
+
+// Debug logs a debug message
+func (l *testLogger) Debug(msg string, args ...interface{}) {
+	l.Logger.Debug(msg, args...)
+}
+
+// Info logs an info message
+func (l *testLogger) Info(msg string, args ...interface{}) {
+	l.Logger.Info(msg, args...)
+}
+
+// Error logs an error message
+func (l *testLogger) Error(msg string, args ...interface{}) {
+	l.Logger.Error(msg, args...)
+}

internal/tg/completion/completion.go

@@ -10,7 +10,7 @@ import (
 	"go.lsp.dev/protocol"
 )
 
-func GetCompletions(l *logger.Logger, store store.Store, position protocol.Position) []protocol.CompletionItem {
+func GetCompletions(l logger.Logger, store store.Store, position protocol.Position) []protocol.CompletionItem {
 	cursorWord := text.GetCursorWord(store.Document, position)
 	completions := []protocol.CompletionItem{}
 

internal/tg/definition/definition.go

@@ -21,7 +21,7 @@ const (
 	DefinitionContextNull = "null"
 )
 
-func GetDefinitionTargetWithContext(l *logger.Logger, store store.Store, position protocol.Position) (string, string) {
+func GetDefinitionTargetWithContext(l logger.Logger, store store.Store, position protocol.Position) (string, string) {
 	document := store.Document
 
 	scanner := bufio.NewScanner(strings.NewReader(document))

internal/tg/hover/hover.go

@@ -20,7 +20,7 @@ const (
 	HoverContextNull = "null"
 )
 
-func GetHoverTargetWithContext(l *logger.Logger, store store.Store, position protocol.Position) (string, string) {
+func GetHoverTargetWithContext(l logger.Logger, store store.Store, position protocol.Position) (string, string) {
 	word := text.GetCursorWord(store.Document, position)
 	if len(word) == 0 {
 		l.Debug(

internal/tg/state.go

@@ -25,7 +25,7 @@ func NewState() State {
 	return State{Configs: map[string]store.Store{}}
 }
 
-func (s *State) OpenDocument(l *logger.Logger, docURI protocol.DocumentURI, text string) []protocol.Diagnostic {
+func (s *State) OpenDocument(l logger.Logger, docURI protocol.DocumentURI, text string) []protocol.Diagnostic {
 	l.Debug(
 		"Opening document",
 		"uri", docURI,
@@ -35,7 +35,7 @@ func (s *State) OpenDocument(l *logger.Logger, docURI protocol.DocumentURI, text
 	return s.updateState(l, docURI, text)
 }
 
-func (s *State) UpdateDocument(l *logger.Logger, docURI protocol.DocumentURI, text string) []protocol.Diagnostic {
+func (s *State) UpdateDocument(l logger.Logger, docURI protocol.DocumentURI, text string) []protocol.Diagnostic {
 	l.Debug(
 		"Updating document",
 		"uri", docURI,
@@ -45,7 +45,7 @@ func (s *State) UpdateDocument(l *logger.Logger, docURI protocol.DocumentURI, te
 	return s.updateState(l, docURI, text)
 }
 
-func (s *State) updateState(l *logger.Logger, docURI protocol.DocumentURI, text string) []protocol.Diagnostic {
+func (s *State) updateState(l logger.Logger, docURI protocol.DocumentURI, text string) []protocol.Diagnostic {
 	cfg, diags := parseTerragruntBuffer(docURI.Filename(), text)
 
 	l.Debug(
@@ -71,7 +71,7 @@ func (s *State) updateState(l *logger.Logger, docURI protocol.DocumentURI, text
 	return diags
 }
 
-func (s *State) Hover(l *logger.Logger, id int, docURI protocol.DocumentURI, position protocol.Position) lsp.HoverResponse {
+func (s *State) Hover(l logger.Logger, id int, docURI protocol.DocumentURI, position protocol.Position) lsp.HoverResponse {
 	store := s.Configs[docURI.Filename()]
 
 	l.Debug(
@@ -150,7 +150,7 @@ func wrapAsHCLCodeFence(s string) string {
 	return "```hcl\n" + s + "\n```"
 }
 
-func (s *State) Definition(l *logger.Logger, id int, docURI protocol.DocumentURI, position protocol.Position) lsp.DefinitionResponse {
+func (s *State) Definition(l logger.Logger, id int, docURI protocol.DocumentURI, position protocol.Position) lsp.DefinitionResponse {
 	store := s.Configs[docURI.Filename()]
 
 	l.Debug(
@@ -244,7 +244,7 @@ func buildEmptyDefinitionResponse(id int, docURI protocol.DocumentURI, position
 	}
 }
 
-func (s *State) TextDocumentCompletion(l *logger.Logger, id int, docURI protocol.DocumentURI, position protocol.Position) lsp.CompletionResponse {
+func (s *State) TextDocumentCompletion(l logger.Logger, id int, docURI protocol.DocumentURI, position protocol.Position) lsp.CompletionResponse {
 	items := completion.GetCompletions(l, s.Configs[docURI.Filename()], position)
 
 	response := lsp.CompletionResponse{

main.go

@@ -45,7 +45,7 @@ func main() {
 	}
 }
 
-func handleMessage(l *logger.Logger, writer io.Writer, state tg.State, method string, contents []byte) {
+func handleMessage(l logger.Logger, writer io.Writer, state tg.State, method string, contents []byte) {
 	l.Debug("Received msg", "method", method, "contents", string(contents))
 
 	switch method {
@@ -207,7 +207,7 @@ func handleMessage(l *logger.Logger, writer io.Writer, state tg.State, method st
 	}
 }
 
-func writeResponse(l *logger.Logger, writer io.Writer, msg any) {
+func writeResponse(l logger.Logger, writer io.Writer, msg any) {
 	reply := rpc.EncodeMessage(msg)
 
 	_, err := writer.Write([]byte(reply))