Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrNotSupportedFile = errors.New("unsupported file to parse")
ErrNotSupportedFile represents an error when a file is not supported by KICS
Functions ¶
This section is empty.
Types ¶
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
Builder is a representation of parsers that will be construct
type ParsedDocument ¶ added in v1.4.6
type ParsedDocument struct {
Docs []model.Document
Kind model.FileKind
Content string
IgnoreLines []int
CountLines int
ResolvedFiles map[string]model.ResolvedFile
IsMinified bool
}
ParsedDocument is a struct containing data retrieved from parsing
type Parser ¶
type Parser struct {
Platform []string
// contains filtered or unexported fields
}
Parser is a struct that associates a parser to its supported extensions
func (*Parser) CommentsCommands ¶ added in v1.4.1
func (c *Parser) CommentsCommands(filePath string, fileContent []byte) model.CommentsCommands
CommentsCommands gets commands on comments in the file beginning, before the code starts
func (*Parser) Parse ¶
func (c *Parser) Parse(filePath string, fileContent []byte, openAPIResolveReferences, isMinified bool) (ParsedDocument, error)
Parse executes a parser on the fileContent and returns the file content as a Document, the file kind and an error, if an error has occurred
func (*Parser) SupportedExtensions ¶
func (c *Parser) SupportedExtensions() model.Extensions
SupportedExtensions returns extensions supported by KICS
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.