regex

Documentation

Index

• func BuiltInRegexExtension(extension string) (core.Extension, error)
• type Extension
  • func (s *Extension) AnalyzeFile(theFile file.File) *file.Results
  • func (s *Extension) Init(a core.Analyzer) error
• type ExtensionYamlFile

Functions

func BuiltInRegexExtension

func BuiltInRegexExtension(extension string) (core.Extension, error)

Types

type Extension

type Extension struct {
	OnlyStats bool
	Glob      glob.Glob
	Patterns  []*regexp.Regexp
}

Extension is a FileAnalyzer that uses regular expressions to find snippets. It can be configured to only match certain files using a glob. For a snippet to be recorded, it must be in a group with a name. For example, the following regex will match a function named "foo" and a function named "bar": (?P<function>func foo\(\) {.*?})|(?P<function>func bar\(\) {.*?})

See https://www.regular-expressions.info/named.html for more information on named groups.

func (*Extension) AnalyzeFile

func (s *Extension) AnalyzeFile(theFile file.File) *file.Results

func (*Extension) Init

func (s *Extension) Init(a core.Analyzer) error

type ExtensionYamlFile

type ExtensionYamlFile struct {
	Extensions map[string]*embeddedExtensionDefinition `yaml:"extensions"`
}