comments

Documentation

Index

• type Comment
  • func New(text string, opts ...Option) (*Comment, error)
  • func (c *Comment) Build() string
  • func (c *Comment) CommentWithoutOptions() *Comment
  • func (c *Comment) String() string
• type Option
  • func WithReferenceConfig(cfg config.Reference) Option
  • func WithTFTag(s string) Option

Types

type Comment

type Comment struct {
	Text string
	markers.Options
}

Comment represents a comment with text and supported marker options.

func New

func New(text string, opts ...Option) (*Comment, error)

New returns a Comment by parsing Upjet markers as Options

func (*Comment) Build

func (c *Comment) Build() string

Build builds comments by adding comment prefix ("// ") to each line of the string representation of this Comment.

func (*Comment) CommentWithoutOptions

func (c *Comment) CommentWithoutOptions() *Comment

CommentWithoutOptions returns a new Comment without the Options.

func (*Comment) String

func (c *Comment) String() string

String returns a string representation of this Comment (no "// " prefix)

type Option

type Option func(*Comment)

Option is a comment option

func WithReferenceConfig

func WithReferenceConfig(cfg config.Reference) Option

WithReferenceConfig returns a comment options with the given reference config

func WithTFTag

func WithTFTag(s string) Option

WithTFTag returns a comment options with input tf tag