parser

Documentation

Index

• type PluginFileHeaders
  • func GetPluginHeaders(filePath string) (PluginFileHeaders, error)
• type ReadmeParser
  • func NewReadmeParser() *ReadmeParser
  • func (p *ReadmeParser) GetMetadata() map[string]any
  • func (p *ReadmeParser) Parse(content string)
  • func (p *ReadmeParser) ToMarkdown() string
• type ThemeFileHeaders
  • func GetThemeHeaders(filePath string) (ThemeFileHeaders, error)

Types

type PluginFileHeaders

type PluginFileHeaders struct {
	Name            string
	Author          string
	Description     string
	License         string
	PluginURI       string
	Version         string
	RequiresPHP     string
	RequiresWP      string
	RequiresPlugins []string
	Tags            []string
}

func GetPluginHeaders

func GetPluginHeaders(filePath string) (PluginFileHeaders, error)

GetPluginHeaders retrieves headers for a WordPress plugin file.

type ReadmeParser

type ReadmeParser struct {
	Name            string
	MetaDescription string
	Contributors    []string
	Tags            []string
	Requires        string
	Tested          string
	RequiresPHP     string
	StableTag       string
	License         string
	LicenseURI      string
	DonateLink      string

	Sections      map[string]string
	Screenshots   map[int]string
	FAQ           map[string]string
	UpgradeNotice map[string]string
}

func NewReadmeParser

func NewReadmeParser() *ReadmeParser

func (*ReadmeParser) GetMetadata

func (p *ReadmeParser) GetMetadata() map[string]any

func (*ReadmeParser) Parse

func (p *ReadmeParser) Parse(content string)

Parse reads and parses the readme.txt content.

func (*ReadmeParser) ToMarkdown

func (p *ReadmeParser) ToMarkdown() string

type ThemeFileHeaders

type ThemeFileHeaders struct {
	Name        string
	Author      string
	Description string
	License     string
	ThemeURI    string
	Version     string
	RequiresWP  string
	RequiresPHP string
	Tags        []string
}

func GetThemeHeaders

func GetThemeHeaders(filePath string) (ThemeFileHeaders, error)

GetThemeHeaders retrieves headers for a WordPress theme stylesheet.