module

Documentation

Overview

Package module provides a struct to represent an OpenTofu/Terraform module.

Index

• type Doc
  • func FindDoc(dir string) (*Doc, error)
  • func NewDoc(rawContent, fileExt string) *Doc
  • func (doc *Doc) Content(stripTags bool) string
  • func (doc *Doc) Description(maxLenght int) string
  • func (doc *Doc) IsMarkDown() bool
  • func (doc *Doc) Title() string
• type DocRegs
  • func (regs DocRegs) Replace(str string) string
• type Module
  • func NewModule(repo *Repo, moduleDir string) (*Module, error)
  • func (module *Module) Description() string
  • func (module *Module) FilterValue() string
  • func (module *Module) Logger() log.Logger
  • func (module *Module) ModuleDir() string
  • func (module *Module) TerraformSourcePath() string
  • func (module *Module) Title() string
  • func (module *Module) URL() string
• type Modules
• type Repo
  • func NewRepo(ctx context.Context, logger log.Logger, cloneURL, tempDir string) (*Repo, error)
  • func (repo *Repo) FindModules(ctx context.Context) (Modules, error)
  • func (repo *Repo) ModuleURL(moduleDir string) (string, error)

Types

type Doc

type Doc struct {
	// contains filtered or unexported fields
}

func FindDoc

func FindDoc(dir string) (*Doc, error)

func NewDoc

func NewDoc(rawContent, fileExt string) *Doc

func (*Doc) Content

func (doc *Doc) Content(stripTags bool) string

func (*Doc) Description

func (doc *Doc) Description(maxLenght int) string

func (*Doc) IsMarkDown

func (doc *Doc) IsMarkDown() bool

func (*Doc) Title

func (doc *Doc) Title() string

type DocRegs

type DocRegs []*regexp.Regexp

func (DocRegs) Replace

func (regs DocRegs) Replace(str string) string

type Module

type Module struct {
	*Repo
	*Doc
	// contains filtered or unexported fields
}

func NewModule

func NewModule(repo *Repo, moduleDir string) (*Module, error)

NewModule returns a module instance if the given `moduleDir` path contains a Terraform module, otherwise returns nil.

func (*Module) Description

func (module *Module) Description() string

Description implements /github.com/charmbracelet/bubbles.list.DefaultItem.Description

func (*Module) FilterValue

func (module *Module) FilterValue() string

FilterValue implements /github.com/charmbracelet/bubbles.list.Item.FilterValue

func (*Module) Logger

func (module *Module) Logger() log.Logger

func (*Module) ModuleDir

func (module *Module) ModuleDir() string

func (*Module) TerraformSourcePath

func (module *Module) TerraformSourcePath() string

func (*Module) Title

func (module *Module) Title() string

Title implements /github.com/charmbracelet/bubbles.list.DefaultItem.Title

func (*Module) URL

func (module *Module) URL() string

type Modules

type Modules []*Module

type Repo

type Repo struct {
	// contains filtered or unexported fields
}

func NewRepo

func NewRepo(ctx context.Context, logger log.Logger, cloneURL, tempDir string) (*Repo, error)

func (*Repo) FindModules

func (repo *Repo) FindModules(ctx context.Context) (Modules, error)

FindModules clones the repository if `repoPath` is a URL, searches for Terragrunt modules, indexes their README.* files, and returns module instances.

func (*Repo) ModuleURL

func (repo *Repo) ModuleURL(moduleDir string) (string, error)

ModuleURL returns the URL of the module in this repository. `moduleDir` is the path from the repository root.