plugconf

Documentation

Index

• func ParseMultiPlugconf(reposList []lockjson.Repos) (*MultiParsedInfo, MultiParseError)
• func ParsePlugconf(file *ast.File, src []byte, path string) (*ParsedInfo, *ParseError)
• func ParsePlugconfFile(path string, reposID int, reposPath pathutil.ReposPath) (result *ParsedInfo, parseErr *ParseError)
• func RdepsOf(reposPath pathutil.ReposPath, reposList []lockjson.Repos) (pathutil.ReposPathList, error)
• type MultiParseError
  • func (errs MultiParseError) Errors() *multierror.Error
  • func (errs MultiParseError) ErrorsAndWarns() *multierror.Error
  • func (errs MultiParseError) HasErrs() bool
  • func (errs MultiParseError) HasWarns() bool
  • func (errs MultiParseError) Warns() *multierror.Error
• type MultiParsedInfo
  • func (mp *MultiParsedInfo) Each(f func(pathutil.ReposPath, *ParsedInfo))
  • func (mp *MultiParsedInfo) GenerateBundlePlugconf(vimrcPath, gvimrcPath string) ([]byte, error)
• type ParseError
  • func (e *ParseError) Errors() *multierror.Error
  • func (e *ParseError) ErrorsAndWarns() *multierror.Error
  • func (e *ParseError) HasErrs() bool
  • func (e *ParseError) HasErrsOrWarns() bool
  • func (e *ParseError) HasWarns() bool
• type ParsedInfo
  • func (pi *ParsedInfo) ConvertConfigToOnLoadPreFunc() bool
  • func (pi *ParsedInfo) GeneratePlugconf() ([]byte, error)
• type Template
  • func FetchPlugconfTemplate(reposPath pathutil.ReposPath) (*Template, error)
  • func (pt *Template) Generate(path string) ([]byte, *multierror.Error)

Functions

func ParseMultiPlugconf

func ParseMultiPlugconf(reposList []lockjson.Repos) (*MultiParsedInfo, MultiParseError)

ParseMultiPlugconf parses plugconfs of given reposList.

func ParsePlugconf

func ParsePlugconf(file *ast.File, src []byte, path string) (*ParsedInfo, *ParseError)

ParsePlugconf always returns non-nil parseErr (which may have empty errors / warns)

func ParsePlugconfFile

func ParsePlugconfFile(path string, reposID int, reposPath pathutil.ReposPath) (result *ParsedInfo, parseErr *ParseError)

ParsePlugconfFile parses plugconf and returns parsed info and parse error and warnings. path is a filepath of plugconf. reposID is an ID of unsigned integer which identifies one plugconf. reposPath is an pathutil.ReposPath of plugconf.

func RdepsOf

func RdepsOf(reposPath pathutil.ReposPath, reposList []lockjson.Repos) (pathutil.ReposPathList, error)

RdepsOf returns depended (required) plugins of reposPath. reposList is used to calculate dependency of reposPath.

Types

type MultiParseError

type MultiParseError []ParseError

MultiParseError holds multiple ParseError.

func (MultiParseError) Errors

func (errs MultiParseError) Errors() *multierror.Error

Errors returns all errors in holding ParseError.

func (MultiParseError) ErrorsAndWarns

func (errs MultiParseError) ErrorsAndWarns() *multierror.Error

ErrorsAndWarns returns errors and warnings in holding ParseError.

func (MultiParseError) HasErrs

func (errs MultiParseError) HasErrs() bool

HasErrs returns true when any of holding ParseError.HasErrs() returns true.

func (MultiParseError) HasWarns

func (errs MultiParseError) HasWarns() bool

HasWarns returns true when any of holding ParseError.HasWarns() returns true.

func (MultiParseError) Warns

func (errs MultiParseError) Warns() *multierror.Error

Warns returns all warnings in holding ParseError.

type MultiParsedInfo

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

MultiParsedInfo holds multiple ParsedInfo. This value is generated by ParseMultiPlugconf.

func (*MultiParsedInfo) Each

func (mp *MultiParsedInfo) Each(f func(pathutil.ReposPath, *ParsedInfo))

Each iterates each repository by given func.

func (*MultiParsedInfo) GenerateBundlePlugconf

func (mp *MultiParsedInfo) GenerateBundlePlugconf(vimrcPath, gvimrcPath string) ([]byte, error)

GenerateBundlePlugconf generates bundled plugconf content. Generated content does not include s:loaded_on() function. vimrcPath and gvimrcPath are fullpath of vimrc and gvimrc. They become an empty string when each path does not exist.

type ParseError

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

ParseError does not provide Error() because I don't want let it pretend like error type. Receivers of a value of this type must decide how to handle.

func (*ParseError) Errors

func (e *ParseError) Errors() *multierror.Error

Errors returns multierror.Error of errors.

func (*ParseError) ErrorsAndWarns

func (e *ParseError) ErrorsAndWarns() *multierror.Error

ErrorsAndWarns returns multierror.Error which errors and warnings are mixed in.

func (*ParseError) HasErrs

func (e *ParseError) HasErrs() bool

HasErrs returns true when 1 or more errors.

func (*ParseError) HasErrsOrWarns

func (e *ParseError) HasErrsOrWarns() bool

HasErrsOrWarns returns true when 1 or more errors or warnings.

func (*ParseError) HasWarns

func (e *ParseError) HasWarns() bool

HasWarns returns true when 1 or more warnings.

type ParsedInfo

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

ParsedInfo represents parsed info of plugconf.

func (*ParsedInfo) ConvertConfigToOnLoadPreFunc

func (pi *ParsedInfo) ConvertConfigToOnLoadPreFunc() bool

ConvertConfigToOnLoadPreFunc converts s:config() function name to s:on_load_pre() (see 'volt migrate plugconf/config-func' function). If no s:config() function is found, returns false. If found, returns true.

func (*ParsedInfo) GeneratePlugconf

func (pi *ParsedInfo) GeneratePlugconf() ([]byte, error)

GeneratePlugconf generates a plugconf file placed at "$VOLTPATH/plugconf/{repos}.vim".

type Template

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

Template is a content of plugconf template.

func FetchPlugconfTemplate

func FetchPlugconfTemplate(reposPath pathutil.ReposPath) (*Template, error)

FetchPlugconfTemplate fetches reposPath's plugconf from vim-volt/plugconf-templates repository. Fetched URL: https://raw.githubusercontent.com/vim-volt/plugconf-templates/master/templates/{reposPath}.vim

func (*Template) Generate

func (pt *Template) Generate(path string) ([]byte, *multierror.Error)

Generate generates plugconf content from Template.