snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)

tools/mattermost-govet/requestCtxNaming/requestCtxNaming.go

@@ -0,0 +1,64 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package requestCtxNaming
+
+import (
+	"go/ast"
+	"strings"
+
+	"golang.org/x/tools/go/analysis"
+)
+
+var Analyzer = &analysis.Analyzer{
+	Name: "requestCtxNaming",
+	Doc:  "check that request.CTX parameters are consistently named 'rctx'",
+	Run:  run,
+}
+
+func run(pass *analysis.Pass) (interface{}, error) {
+	for _, file := range pass.Files {
+		ast.Inspect(file, func(node ast.Node) bool {
+			switch funcDecl := node.(type) {
+			case *ast.FuncDecl:
+				if funcDecl.Type != nil && funcDecl.Type.Params != nil {
+					checkParameters(pass, funcDecl.Type.Params.List)
+				}
+			}
+			return true
+		})
+	}
+	return nil, nil
+}
+
+func checkParameters(pass *analysis.Pass, params []*ast.Field) {
+	for _, param := range params {
+		// Check if this parameter's type is request.CTX
+		if isRequestCtxType(param.Type) {
+			// Check each parameter name
+			for _, name := range param.Names {
+				if name.Name != "rctx" && !strings.HasPrefix(name.Name, "_") {
+					pass.Reportf(
+						name.Pos(),
+						"parameter of type request.CTX should be named 'rctx', got '%s'",
+						name.Name,
+					)
+				}
+			}
+		}
+	}
+}
+
+func isRequestCtxType(expr ast.Expr) bool {
+	switch t := expr.(type) {
+	case *ast.SelectorExpr:
+		// Handle request.CTX
+		if ident, ok := t.X.(*ast.Ident); ok {
+			return ident.Name == "request" && t.Sel.Name == "CTX"
+		}
+	case *ast.StarExpr:
+		// Handle *request.CTX (pointer to request.CTX)
+		return isRequestCtxType(t.X)
+	}
+	return false
+}

tools/mattermost-govet/requestCtxNaming/requestCtxNaming_test.go

@@ -0,0 +1,14 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package requestCtxNaming
+
+import (
+	"testing"
+
+	"golang.org/x/tools/go/analysis/analysistest"
+)
+
+func TestAll(t *testing.T) {
+	analysistest.Run(t, analysistest.TestData(), Analyzer, "valid", "invalid")
+}

tools/mattermost-govet/requestCtxNaming/testdata/src/invalid/invalid.go

@@ -0,0 +1,18 @@
+package invalid
+
+import "request"
+
+func InvalidFunction(ctx request.CTX) { // want "parameter of type request.CTX should be named 'rctx', got 'ctx'"
+}
+
+func InvalidShortName(c request.CTX) { // want "parameter of type request.CTX should be named 'rctx', got 'c'"
+}
+
+func InvalidFunctionWithTwoArguments(ctx request.CTX, id string) { // want "parameter of type request.CTX should be named 'rctx', got 'ctx'"
+}
+
+func InvalidPointerFunction(context *request.CTX, id string) { // want "parameter of type request.CTX should be named 'rctx', got 'context'"
+}
+
+func InvalidMultipleParams(ctx1 request.CTX, ctx2 request.CTX) { // want "parameter of type request.CTX should be named 'rctx', got 'ctx1'" "parameter of type request.CTX should be named 'rctx', got 'ctx2'"
+}

tools/mattermost-govet/requestCtxNaming/testdata/src/request/request.go

@@ -0,0 +1,5 @@
+package request
+
+type CTX struct {
+	// Mock request context type
+}

tools/mattermost-govet/requestCtxNaming/testdata/src/valid/valid.go

@@ -0,0 +1,19 @@
+package valid
+
+import "request"
+
+// Valid usage - parameter named rctx
+func ValidFunction(rctx request.CTX, id string) {
+}
+
+// Valid usage - pointer to request.CTX named rctx
+func ValidPointerFunction(rctx *request.CTX, id string) {
+}
+
+// Valid usage - underscore parameter (ignored)
+func ValidIgnoredFunction(_ request.CTX, id string) {
+}
+
+// Valid usage - multiple parameters with rctx
+func ValidMultipleParams(rctx request.CTX, name string, age int) {
+}