docs

Documentation

Index

• Variables
• func DefaultTitleTransformer(table *schema.Table) string
• type Format
  • func FormatFromString(s string) (Format, error)
  • func (r Format) String() string
• type Generator
  • func NewGenerator(pluginName string, tables schema.Tables) *Generator
  • func (g *Generator) Generate(dir string, format Format) error

Variables

var DefaultTitleExceptions = map[string]string{

	"acl":   "ACL",
	"acls":  "ACLs",
	"api":   "API",
	"apis":  "APIs",
	"ca":    "CA",
	"cidr":  "CIDR",
	"cidrs": "CIDRs",
	"db":    "DB",
	"dbs":   "DBs",
	"dhcp":  "DHCP",
	"iam":   "IAM",
	"iot":   "IOT",
	"ip":    "IP",
	"ips":   "IPs",
	"ipv4":  "IPv4",
	"ipv6":  "IPv6",
	"mfa":   "MFA",
	"ml":    "ML",
	"oauth": "OAuth",
	"vpc":   "VPC",
	"vpcs":  "VPCs",
	"vpn":   "VPN",
	"vpns":  "VPNs",
	"waf":   "WAF",
	"wafs":  "WAFs",

	"aws": "AWS",
	"gcp": "GCP",
}

Functions

func DefaultTitleTransformer

func DefaultTitleTransformer(table *schema.Table) string

Types

type Format

type Format int

const (
	FormatMarkdown Format = iota
	FormatJSON
)

func FormatFromString

func FormatFromString(s string) (Format, error)

func (Format) String

func (r Format) String() string

type Generator

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

func NewGenerator

func NewGenerator(pluginName string, tables schema.Tables) *Generator

NewGenerator creates a new generator for the given tables. The tables are sorted by name. pluginName is optional and is used in markdown only

func (*Generator) Generate

func (g *Generator) Generate(dir string, format Format) error