code

Documentation

Index

• type Comment
  • func GetComments(source []byte, lang *Language) ([]Comment, error)
• type Language
  • func C() *Language
  • func CSS() *Language
  • func Cpp() *Language
  • func GetLanguageFromExt(ext string) (*Language, error)
  • func Go() *Language
  • func JavaScript() *Language
  • func Julia() *Language
  • func Protobuf() *Language
  • func Python() *Language
  • func Ruby() *Language
  • func Rust() *Language
  • func Tsx() *Language
  • func TypeScript() *Language
  • func YAML() *Language
• type QueryEngine
  • func NewQueryEngine(tree *sitter.Tree, lang *Language) *QueryEngine

Types

type Comment

type Comment struct {
	Text   string
	Source string
	Line   int
	Offset int
	Scope  string
}

Comment represents an in-code comment (line or block).

func GetComments

func GetComments(source []byte, lang *Language) ([]Comment, error)

GetComments returns all comments in the given source code.

type Language

type Language struct {
	Delims  *regexp.Regexp
	Parser  *sitter.Language
	Queries []string
	Cutset  string
	Padding padding
}

Language represents a supported programming language.

NOTE: What about haskell, less, perl, php, powershell, r, sass, swift?

func C

func C() *Language

func CSS

func CSS() *Language

func Cpp

func Cpp() *Language

func GetLanguageFromExt

func GetLanguageFromExt(ext string) (*Language, error)

GetLanguageFromExt returns a Language based on the given file extension.

func Go

func Go() *Language

func JavaScript

func JavaScript() *Language

func Julia

func Julia() *Language

func Protobuf

func Protobuf() *Language

func Python

func Python() *Language

func Ruby

func Ruby() *Language

func Rust

func Rust() *Language

func Tsx

func Tsx() *Language

func TypeScript

func TypeScript() *Language

func YAML

func YAML() *Language

type QueryEngine

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

func NewQueryEngine

func NewQueryEngine(tree *sitter.Tree, lang *Language) *QueryEngine