From 2e2a95d7d6d8e70b1aeb81779370628770ae99bc Mon Sep 17 00:00:00 2001 From: Felipe Martin Date: Mon, 14 Jul 2025 22:16:41 +0200 Subject: [PATCH] Add GoModule support to template context and update gitignore MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add GoModule struct with Module and Version fields - Parse go.mod file to extract module name and Go version - Expose GoModule in template context as {{.GoModule}} - Update asset templates to use {{.GoModule}} instead of hardcoded values - Add gitignore pattern for testdata directories (keep only plugin.json files) - All templates now have access to both manifest and Go module information Templates can now use: - {{.GoModule.Module}} for module name - {{.GoModule.Version}} for Go version - {{if .GoModule}}...{{end}} for conditional logic 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- .gitignore | 5 ++++ assets/.golangci.yml | 2 +- assets/build/utils.mk | 2 +- updateassets.go | 62 ++++++++++++++++++++++++++++++++++++++----- 4 files changed, 62 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index 028d8fd..8dc59ef 100644 --- a/.gitignore +++ b/.gitignore @@ -31,3 +31,8 @@ Thumbs.db .env .env.local .claude + +# Ignore all files in testdata except plugin.json +testdata/**/* +!testdata/**/ +!testdata/**/plugin.json diff --git a/assets/.golangci.yml b/assets/.golangci.yml index 5682ada..59726f7 100644 --- a/assets/.golangci.yml +++ b/assets/.golangci.yml @@ -6,7 +6,7 @@ linters-settings: gofmt: simplify: true goimports: - local-prefixes: github.com/mattermost/mattermost-starter-template + local-prefixes: {{.GoModule}} govet: check-shadowing: true enable-all: true diff --git a/assets/build/utils.mk b/assets/build/utils.mk index 3dd5c52..eb44805 100644 --- a/assets/build/utils.mk +++ b/assets/build/utils.mk @@ -33,7 +33,7 @@ endif mock: ifneq ($(HAS_SERVER),) go install github.com/golang/mock/mockgen@v1.6.0 - mockgen -destination=server/command/mocks/mock_commands.go -package=mocks github.com/mattermost/mattermost-plugin-starter-template/server/command Command + mockgen -destination=server/command/mocks/mock_commands.go -package=mocks {{.GoModule}}/server/command Command endif ## Show help documentation. diff --git a/updateassets.go b/updateassets.go index 69ff444..705c1db 100644 --- a/updateassets.go +++ b/updateassets.go @@ -128,9 +128,16 @@ type AssetProcessorConfig struct { manifest *model.Manifest } +// GoModule represents information from go.mod file. +type GoModule struct { + Module string + Version string +} + // TemplateContext holds the data available to templates. type TemplateContext struct { Manifest *model.Manifest + GoModule *GoModule } func processAssetEntry(path string, d fs.DirEntry, err error, config AssetProcessorConfig) error { @@ -165,13 +172,13 @@ func processAssetEntry(path string, d fs.DirEntry, err error, config AssetProces } func processAssetFile(embeddedPath, targetPath, relativePath string, config AssetProcessorConfig) error { - shouldUpdate, err := shouldUpdateFile(embeddedPath, targetPath, config.manifest) + shouldUpdate, err := shouldUpdateFile(embeddedPath, targetPath, config) if err != nil { return err } if shouldUpdate { - err = updateFile(embeddedPath, targetPath, relativePath, config.manifest) + err = updateFile(embeddedPath, targetPath, relativePath, config) if err != nil { return err } @@ -189,9 +196,9 @@ func createDirectory(targetPath string) error { return nil } -func shouldUpdateFile(embeddedPath, targetPath string, manifest *model.Manifest) (bool, error) { +func shouldUpdateFile(embeddedPath, targetPath string, config AssetProcessorConfig) (bool, error) { // Process the template to get the final content - processedContent, err := processTemplate(embeddedPath, manifest) + processedContent, err := processTemplate(embeddedPath, config.manifest, config.pluginPath) if err != nil { return false, fmt.Errorf("failed to process template %s: %w", embeddedPath, err) } @@ -205,9 +212,9 @@ func shouldUpdateFile(embeddedPath, targetPath string, manifest *model.Manifest) return !bytes.Equal(existingContent, processedContent), nil } -func updateFile(embeddedPath, targetPath, relativePath string, manifest *model.Manifest) error { +func updateFile(embeddedPath, targetPath, relativePath string, config AssetProcessorConfig) error { // Process the template to get the final content - processedContent, err := processTemplate(embeddedPath, manifest) + processedContent, err := processTemplate(embeddedPath, config.manifest, config.pluginPath) if err != nil { return fmt.Errorf("failed to process template %s: %w", embeddedPath, err) } @@ -227,16 +234,23 @@ func updateFile(embeddedPath, targetPath, relativePath string, manifest *model.M } // processTemplate processes a template file with the manifest context. -func processTemplate(embeddedPath string, manifest *model.Manifest) ([]byte, error) { +func processTemplate(embeddedPath string, manifest *model.Manifest, pluginPath string) ([]byte, error) { // Read the template content templateContent, err := assetsFS.ReadFile(embeddedPath) if err != nil { return nil, fmt.Errorf("failed to read embedded file %s: %w", embeddedPath, err) } + // Parse go.mod file to get module information + goMod, err := parseGoModule(pluginPath) + if err != nil { + return nil, fmt.Errorf("failed to parse go.mod file: %w", err) + } + // Create template context context := TemplateContext{ Manifest: manifest, + GoModule: goMod, } // Create and parse the template @@ -254,3 +268,37 @@ func processTemplate(embeddedPath string, manifest *model.Manifest) ([]byte, err return buf.Bytes(), nil } + +// parseGoModule parses the go.mod file to extract module information. +func parseGoModule(pluginPath string) (*GoModule, error) { + goModPath := filepath.Join(pluginPath, "go.mod") + + content, err := os.ReadFile(goModPath) + if err != nil { + // If go.mod doesn't exist, return nil without error + if os.IsNotExist(err) { + return nil, nil + } + + return nil, fmt.Errorf("failed to read go.mod file: %w", err) + } + + goMod := &GoModule{} + lines := strings.Split(string(content), "\n") + + for _, line := range lines { + line = strings.TrimSpace(line) + + // Parse module line + if strings.HasPrefix(line, "module ") { + goMod.Module = strings.TrimSpace(strings.TrimPrefix(line, "module ")) + } + + // Parse go version line + if strings.HasPrefix(line, "go ") { + goMod.Version = strings.TrimSpace(strings.TrimPrefix(line, "go ")) + } + } + + return goMod, nil +}