From 28169ee87ec91389d9ba89cd24055dc43fd842ea Mon Sep 17 00:00:00 2001
From: Shaunak Kashyap <ycombinator@gmail.com>
Date: Thu, 3 Oct 2024 11:12:32 -0700
Subject: [PATCH] Add linting for the `replace` directive in `go.mod` (#41086)

* Forbid local replaces in go.mod

* Restrict replaced dependencies in go.mod to an allowlist
---
 .golangci.yml | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/.golangci.yml b/.golangci.yml
index 53624aca3b1..074f985f479 100755
--- a/.golangci.yml
+++ b/.golangci.yml
@@ -66,6 +66,7 @@ linters:
     - wastedassign # wastedassign finds wasted assignment statements.
     - gomodguard # check for blocked dependencies
     - depguard
+    - gomoddirectives
 
 # all available settings of specific linters
 linters-settings:
@@ -127,6 +128,25 @@ linters-settings:
               - github.com/gofrs/uuid/v5
             reason: "Use one uuid library consistently across the codebase"
 
+  gomoddirectives:
+    # Forbid local `replace` directives
+    replace-local: false
+
+    # Forbid any `replace` directives that are intended temporarily only during
+    # development. The modules listed below are intended to be replaced permanently.
+    replace-allow-list:
+      - github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/consumption/armconsumption
+      - github.com/Shopify/sarama
+      - github.com/apoydence/eachers
+      - github.com/dop251/goja
+      - github.com/dop251/goja_nodejs
+      - github.com/fsnotify/fsevents
+      - github.com/fsnotify/fsnotify
+      - github.com/google/gopacket
+      - github.com/insomniacslk/dhcp
+      - github.com/meraki/dashboard-api-go/v3
+      - github.com/snowflakedb/gosnowflake
+
   gosimple:
     # Select the Go version to target. The default is '1.13'.
     go: "1.22.7"