Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

generator

package

Go to main page

Versions in this module

v1

v1.1.0

Jan 1, 2026

Changes in this version

+ type ConcurrentFileCollector struct

+ func NewConcurrentFileCollector(rootPath string) *ConcurrentFileCollector

+ func (c *ConcurrentFileCollector) CollectFilesConcurrent(node *Node, secretScanner *secrets.Scanner) ([]FileData, error)

type Generator

+ TreeOnly bool

+ func (g *Generator) SetTreeOnlyMode(treeOnly bool)

type TemplateData

+ FilePaths []string

v1.0.7

May 4, 2025

v1.0.6

Apr 22, 2025

v1.0.5

Apr 18, 2025

v1.0.4

Apr 18, 2025

v1.0.3

Apr 10, 2025

Changes in this version

type FileData

+ Findings []secrets.Finding

type Generator

+ RedactSecrets bool

+ SecretScanner secrets.Scanner

+ func (g *Generator) SetRedactionMode(redact bool)

type Node

+ Findings []secrets.Finding

v1.0.2

Apr 2, 2025

v1.0.1

Apr 2, 2025

v1.0.0

Apr 1, 2025

Changes in this version

+ type FileData struct

+ Content string

+ Language string

+ Path string

+ type Format interface

+ Extension func() string

+ Name func() string

+ Render func(data TemplateData) (string, int, error)

+ type Generator struct

+ DeselectedFiles map[string]bool

+ FilterMgr *filesystem.FilterManager

+ GitIgnoreMgr *filesystem.GitIgnoreManager

+ OutputPath string

+ RootPath string

+ SelectedFiles map[string]bool

+ ShowHidden bool

+ UseGitIgnore bool

+ UseTempFile bool

+ func NewGenerator(rootPath string, gitIgnoreMgr *filesystem.GitIgnoreManager, ...) *Generator

+ func (g *Generator) Generate() (string, int, error)

+ func (g *Generator) GenerateString() (string, int, error)

+ func (g *Generator) GetFormat() Format

+ func (g *Generator) GetFormatName() string

+ func (g *Generator) PrepareTemplateData() (TemplateData, error)

+ func (g *Generator) SetFormat(format Format)

+ type Node struct

+ Children []*Node

+ Content string

+ IsDir bool

+ Language string

+ Name string

+ Path string

+ type TemplateData struct

+ Files []FileData

+ Structure string