fix: linter

Author: dnitsch

.github/workflows/build.yml

@@ -14,6 +14,7 @@ permissions:
 
 jobs:
   set-version:
+    name: Set Version
     runs-on: ubuntu-latest
     container:
       image: mcr.microsoft.com/dotnet/sdk:10.0
@@ -44,6 +45,7 @@ jobs:
 
   test:
     runs-on: ubuntu-latest
+    name: Run Tests
     needs: set-version
     env:
       SEMVER: ${{ needs.set-version.outputs.semVer }}

.github/workflows/release.yml

@@ -14,6 +14,7 @@ permissions:
 
 jobs:
   set-version:
+    name: Set Version
     runs-on: ubuntu-latest
     if: ${{ github.event.workflow_run.head_branch == 'master' && github.event.workflow_run.conclusion == 'success' }}
     container:
@@ -39,6 +40,7 @@ jobs:
         id: gitversion
 
   release:
+    name: Release
     runs-on: ubuntu-latest
     needs: set-version
     env:

internal/lexer/lexer.go

@@ -17,14 +17,12 @@ var nonText = map[string]bool{
 	// this forces the lexer to not treat at as TEXT
 	// and enter the switch statement of the state machine
 	// NOTE: when a new implementation is added we should add it here
-	// AWS|AZure...
+	// AWS|AZure|GCP...
 	"A": true,
 	// VAULT (HashiCorp)
 	"V": true,
 	// GCP
 	"G": true,
-	// // Unknown
-	// "U": true,
 }
 
 type Source struct {
@@ -211,7 +209,7 @@ func (l *Lexer) setTextSeparatorToken() config.Token {
 	return tok
 }
 
-// peekIsBeginOfToken attempts to identify the gendoc keyword after 2 slashes
+// peekIsBeginOfToken attempts to identify the possible token
 func (l *Lexer) peekIsBeginOfToken(possibleBeginToken []config.ImplementationPrefix, charsRead string) (bool, string, config.ImplementationPrefix) {
 	for _, pbt := range possibleBeginToken {
 		configToken := ""
@@ -229,11 +227,6 @@ func (l *Lexer) peekIsBeginOfToken(possibleBeginToken []config.ImplementationPre
 	return false, "", ""
 }
 
-// peekIsEndOfToken
-func (l *Lexer) peekIsEndOfToken() bool {
-	return false
-}
-
 // resetAfterPeek will go back specified amount on the cursor
 func (l *Lexer) resetAfterPeek(back int) {
 	l.position = l.position - back

internal/strategy/strategy.go

@@ -1,6 +1,4 @@
-// Package strategy is a strategy pattern wrapper around the store implementations
-//
-// NOTE: this may be refactored out into the store package directly
+// Package strategy is a factory method wrapper around the backing store implementations
 package strategy
 
 import (
@@ -53,20 +51,17 @@ type strategyFnMap struct {
 	funcMap StrategyFuncMap
 }
 
-type RetrieveStrategy struct {
-	// mu              *sync.Mutex
-	implementation  store.Strategy
+type Strategy struct {
 	config          config.GenVarsConfig
 	strategyFuncMap strategyFnMap
 }
 
-type Opts func(*RetrieveStrategy)
+type Opts func(*Strategy)
 
 // New
-func New(config config.GenVarsConfig, logger log.ILogger, opts ...Opts) *RetrieveStrategy {
-	rs := &RetrieveStrategy{
-		config: config,
-		// mu:              &sync.Mutex{},
+func New(config config.GenVarsConfig, logger log.ILogger, opts ...Opts) *Strategy {
+	rs := &Strategy{
+		config:          config,
 		strategyFuncMap: strategyFnMap{mu: sync.Mutex{}, funcMap: defaultStrategyFuncMap(logger)},
 	}
 	// overwrite or add any options/defaults set above
@@ -82,7 +77,7 @@ func New(config config.GenVarsConfig, logger log.ILogger, opts ...Opts) *Retriev
 // Mainly used for testing
 // NOTE: this may lead to eventual optional configurations by users
 func WithStrategyFuncMap(funcMap StrategyFuncMap) Opts {
-	return func(rs *RetrieveStrategy) {
+	return func(rs *Strategy) {
 		rs.strategyFuncMap.mu.Lock()
 		defer rs.strategyFuncMap.mu.Unlock()
 		for prefix, implementation := range funcMap {
@@ -93,7 +88,7 @@ func WithStrategyFuncMap(funcMap StrategyFuncMap) Opts {
 
 // GetImplementation is a factory method returning the concrete implementation for the retrieval of the token value
 // i.e. facilitating the exchange of the supplied token for the underlying value
-func (rs *RetrieveStrategy) GetImplementation(ctx context.Context, token *config.ParsedTokenConfig) (store.Strategy, error) {
+func (rs *Strategy) GetImplementation(ctx context.Context, token *config.ParsedTokenConfig) (store.Strategy, error) {
 	if token == nil {
 		return nil, fmt.Errorf("unable to get prefix, %w", ErrTokenInvalid)
 	}
@@ -114,24 +109,6 @@ func ExchangeToken(s store.Strategy, token *config.ParsedTokenConfig) *TokenResp
 	return cr
 }
 
-// func (rs *RetrieveStrategy) setImplementation(strategy store.Strategy) {
-// 	rs.mu.Lock()
-// 	defer rs.mu.Unlock()
-// 	rs.implementation = strategy
-// }
-
-// func (rs *RetrieveStrategy) setTokenVal(s *config.ParsedTokenConfig) {
-// 	rs.mu.Lock()
-// 	defer rs.mu.Unlock()
-// 	rs.implementation.SetToken(s)
-// }
-
-// func (rs *RetrieveStrategy) getTokenValue() (string, error) {
-// 	rs.mu.Lock()
-// 	defer rs.mu.Unlock()
-// 	return rs.implementation.Token()
-// }
-
 type TokenResponse struct {
 	value string
 	key   *config.ParsedTokenConfig