feat: add config path placeholder

Author: ldez

.golangci.next.reference.yml

@@ -335,6 +335,7 @@ linters:
           # List of file globs that will match this list of settings to compare against.
           # By default, if a path is relative, it is relative to the directory where the golangci-lint command is executed.
           # The placeholder '${base-path}' is substituted with a path relative to the mode defined with `run.relative-path-mode`.
+          # The placeholder '${config-path}' is substituted with a path relative to the configuration file.
           # Default: $all
           files:
             - "!**/*_a _file.go"
@@ -1161,6 +1162,7 @@ linters:
           # Comma-separated list of file paths containing ruleguard rules.
           # By default, if a path is relative, it is relative to the directory where the golangci-lint command is executed.
           # The placeholder '${base-path}' is substituted with a path relative to the mode defined with `run.relative-path-mode`.
+          # The placeholder '${config-path}' is substituted with a path relative to the configuration file.
           # Glob patterns such as 'rules-*.go' may be specified.
           # Default: ""
           rules: '${base-path}/ruleguard/rules-*.go,${base-path}/myrule1.go'
@@ -1256,6 +1258,7 @@ linters:
       # Useful if you need to load the template from a specific file.
       # By default, if a path is relative, it is relative to the directory where the golangci-lint command is executed.
       # The placeholder '${base-path}' is substituted with a path relative to the mode defined with `run.relative-path-mode`.
+      # The placeholder '${config-path}' is substituted with a path relative to the configuration file.
       # Default: ""
       template-path: /path/to/my/template.tmpl
 

pkg/config/placeholders.go

@@ -0,0 +1,18 @@
+package config
+
+import "strings"
+
+const (
+	// placeholderBasePath used inside linters to evaluate relative paths.
+	placeholderBasePath = "${base-path}"
+
+	// placeholderConfigPath used inside linters to paths relative to configuration.
+	placeholderConfigPath = "${config-path}"
+)
+
+func NewPlaceholderReplacer(cfg *Config) *strings.Replacer {
+	return strings.NewReplacer(
+		placeholderBasePath, cfg.GetBasePath(),
+		placeholderConfigPath, cfg.GetConfigDir(),
+	)
+}

pkg/golinters/depguard/depguard.go

@@ -8,18 +8,17 @@ import (
 
 	"github.com/golangci/golangci-lint/v2/pkg/config"
 	"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
-	"github.com/golangci/golangci-lint/v2/pkg/golinters/internal"
 	"github.com/golangci/golangci-lint/v2/pkg/lint/linter"
 )
 
-func New(settings *config.DepGuardSettings, basePath string) *goanalysis.Linter {
+func New(settings *config.DepGuardSettings, replacer *strings.Replacer) *goanalysis.Linter {
 	conf := depguard.LinterSettings{}
 
 	if settings != nil {
 		for s, rule := range settings.Rules {
 			var extendedPatterns []string
 			for _, file := range rule.Files {
-				extendedPatterns = append(extendedPatterns, strings.ReplaceAll(file, internal.PlaceholderBasePath, basePath))
+				extendedPatterns = append(extendedPatterns, replacer.Replace(file))
 			}
 
 			list := &depguard.List{

pkg/golinters/gocritic/gocritic.go

@@ -19,7 +19,6 @@ import (
 
 	"github.com/golangci/golangci-lint/v2/pkg/config"
 	"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
-	"github.com/golangci/golangci-lint/v2/pkg/golinters/internal"
 	"github.com/golangci/golangci-lint/v2/pkg/lint/linter"
 	"github.com/golangci/golangci-lint/v2/pkg/logutils"
 )
@@ -31,7 +30,7 @@ var (
 	isDebug = logutils.HaveDebugTag(logutils.DebugKeyGoCritic)
 )
 
-func New(settings *config.GoCriticSettings) *goanalysis.Linter {
+func New(settings *config.GoCriticSettings, replacer *strings.Replacer) *goanalysis.Linter {
 	wrapper := &goCriticWrapper{
 		sizes: types.SizesFor("gc", runtime.GOARCH),
 	}
@@ -58,9 +57,7 @@ Dynamic rules are written declaratively with AST patterns, filters, report messa
 		nil,
 	).
 		WithContextSetter(func(context *linter.Context) {
-			wrapper.replacer = strings.NewReplacer(
-				internal.PlaceholderBasePath, context.Cfg.GetBasePath(),
-			)
+			wrapper.replacer = replacer
 
 			wrapper.init(context.Log, settings)
 		}).

pkg/golinters/goheader/goheader.go

@@ -9,18 +9,17 @@ import (
 
 	"github.com/golangci/golangci-lint/v2/pkg/config"
 	"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
-	"github.com/golangci/golangci-lint/v2/pkg/golinters/internal"
 )
 
 const linterName = "goheader"
 
-func New(settings *config.GoHeaderSettings, basePath string) *goanalysis.Linter {
+func New(settings *config.GoHeaderSettings, replacer *strings.Replacer) *goanalysis.Linter {
 	conf := &goheader.Configuration{}
 	if settings != nil {
 		conf = &goheader.Configuration{
 			Values:       settings.Values,
 			Template:     settings.Template,
-			TemplatePath: strings.ReplaceAll(settings.TemplatePath, internal.PlaceholderBasePath, basePath),
+			TemplatePath: replacer.Replace(settings.TemplatePath),
 		}
 	}
 

pkg/golinters/internal/commons.go

@@ -4,6 +4,3 @@ import "github.com/golangci/golangci-lint/v2/pkg/logutils"
 
 // LinterLogger must be use only when the context logger is not available.
 var LinterLogger = logutils.NewStderrLog(logutils.DebugKeyLinter)
-
-// PlaceholderBasePath used inside linters to evaluate relative paths.
-const PlaceholderBasePath = "${base-path}"

pkg/lint/lintersdb/builder_linter.go

@@ -129,6 +129,8 @@ func (LinterBuilder) Build(cfg *config.Config) ([]*linter.Config, error) {
 		return nil, nil
 	}
 
+	placeholderReplacer := config.NewPlaceholderReplacer(cfg)
+
 	// The linters are sorted in the alphabetical order (case-insensitive).
 	// When a new linter is added the version in `WithSince(...)` must be the next minor version of golangci-lint.
 	return []*linter.Config{
@@ -180,7 +182,7 @@ func (LinterBuilder) Build(cfg *config.Config) ([]*linter.Config, error) {
 			WithSince("v1.44.0").
 			WithURL("https://gitlab.com/bosi/decorder"),
 
-		linter.NewConfig(depguard.New(&cfg.Linters.Settings.Depguard, cfg.GetBasePath())).
+		linter.NewConfig(depguard.New(&cfg.Linters.Settings.Depguard, placeholderReplacer)).
 			WithSince("v1.4.0").
 			WithURL("https://github.com/OpenPeeDeeP/depguard"),
 
@@ -300,7 +302,7 @@ func (LinterBuilder) Build(cfg *config.Config) ([]*linter.Config, error) {
 			WithSince("v1.0.0").
 			WithURL("https://github.com/jgautheron/goconst"),
 
-		linter.NewConfig(gocritic.New(&cfg.Linters.Settings.Gocritic)).
+		linter.NewConfig(gocritic.New(&cfg.Linters.Settings.Gocritic, placeholderReplacer)).
 			WithSince("v1.12.0").
 			WithLoadForGoAnalysis().
 			WithAutoFix().
@@ -340,7 +342,7 @@ func (LinterBuilder) Build(cfg *config.Config) ([]*linter.Config, error) {
 			WithAutoFix().
 			WithURL("https://github.com/segmentio/golines"),
 
-		linter.NewConfig(goheader.New(&cfg.Linters.Settings.Goheader, cfg.GetBasePath())).
+		linter.NewConfig(goheader.New(&cfg.Linters.Settings.Goheader, placeholderReplacer)).
 			WithSince("v1.28.0").
 			WithAutoFix().
 			WithURL("https://github.com/denis-tingaikin/go-header"),