analysis

package

Go to main page

Versions in this module

v0

v0.7.2

Apr 19, 2026

v0.7.1

Apr 19, 2026

Changes in this version

+ func ReadFromBytes(fileContent []byte) (Analyzer, YamlAnalyzer, error)

+ func ReadFromFile(filePath string) (Analyzer, YamlAnalyzer, error)

+ func RunYamlAnalyzer(YamlAnalyzer *YamlAnalyzer) func(pass *Pass) (any, error)

+ func RunYamlTests(testDir string) (passed bool, err error)

type Language

+ func DecodeLanguage(language string) Language

+ type NodeFilter struct

+ type PathFilter struct

+ ExcludeGlobs []glob.Glob

+ IncludeGlobs []glob.Glob

type VarKind

+ const VarKindClass

type Variable

+ Exported bool

+ type Yaml struct

+ Category Category

+ Code string

+ Description string

+ Exclude []string

+ Filters []filterYaml

+ Include []string

+ Language string

+ Message string

+ PathFilter *pathFilterYaml

+ Pattern string

+ Patterns []string

+ Severity Severity

+ type YamlAnalyzer struct

+ Analyzer *Analyzer

+ Message string

+ NodeFilter []NodeFilter

+ PathFilter *PathFilter

+ Patterns []*sitter.Query

+ type YamlTestCase struct

+ TestFile string

+ YamlCheckerPath string

+ func FindYamlTestFiles(testDir string) ([]YamlTestCase, error)

v0.7.0

Apr 14, 2025

Changes in this version

+ func ContainsSkipcq(skipLines []*SkipComment, issue *Issue) bool

+ type SkipComment struct

+ CheckerIds []string

+ CommentLine int

+ CommentText string

+ func GatherSkipInfo(fileContext *ParseResult) []*SkipComment

v0.6.1

Mar 28, 2025

v0.6.0

Mar 28, 2025

Changes in this version

type Analyzer

+ Requires []*Analyzer

+ ResultType reflect.Type

type Pass

+ ResultCache map[*Analyzer]map[*ParseResult]any

+ ResultOf map[*Analyzer]any

v0.5.1

Mar 13, 2025

v0.5.0

Mar 10, 2025

v0.4.1

Feb 28, 2025

v0.4.0

Feb 28, 2025

Changes in this version

+ var ScopeNodes = []string

+ func ChildWithFieldName(node *sitter.Node, fieldName string) *sitter.Node

+ func ChildrenOfType(node *sitter.Node, nodeType string) []*sitter.Node

+ func ChildrenWithFieldName(node *sitter.Node, fieldName string) []*sitter.Node

+ func FindMatchingChild(node *sitter.Node, predicate func(*sitter.Node) bool) *sitter.Node

+ func FirstChildOfType(node *sitter.Node, nodeType string) *sitter.Node

+ func GetExtFromLanguage(lang Language) string

+ func WalkTree(node *sitter.Node, walker Walker)

type ParseResult

+ ScopeTree *ScopeTree

+ type Reference struct

+ IsWriteRef bool

+ Node *sitter.Node

+ Variable *Variable

+ type Scope struct

+ AstNode *sitter.Node

+ Children []*Scope

+ Upper *Scope

+ Variables map[string]*Variable

+ func NewScope(upper *Scope) *Scope

+ func (s *Scope) Lookup(name string) *Variable

+ type ScopeBuilder interface

+ CollectVariables func(node *sitter.Node) []*Variable

+ DeclaresVariable func(node *sitter.Node) bool

+ GetLanguage func() Language

+ NodeCreatesScope func(node *sitter.Node) bool

+ OnNodeEnter func(node *sitter.Node, currentScope *Scope)

+ OnNodeExit func(node *sitter.Node, currentScope *Scope)

+ type ScopeTree struct

+ Language Language

+ Root *Scope

+ ScopeOfNode map[*sitter.Node]*Scope

+ func BuildScopeTree(builder ScopeBuilder, ast *sitter.Node, source []byte) *ScopeTree

+ func MakeScopeTree(lang Language, ast *sitter.Node, source []byte) *ScopeTree

+ func (st *ScopeTree) GetScope(node *sitter.Node) *Scope

+ type TsScopeBuilder struct

+ func (j *TsScopeBuilder) GetLanguage() Language

+ func (ts *TsScopeBuilder) CollectVariables(node *sitter.Node) []*Variable

+ func (ts *TsScopeBuilder) DeclaresVariable(node *sitter.Node) bool

+ func (ts *TsScopeBuilder) NodeCreatesScope(node *sitter.Node) bool

+ func (ts *TsScopeBuilder) OnNodeEnter(node *sitter.Node, scope *Scope)

+ func (ts *TsScopeBuilder) OnNodeExit(node *sitter.Node, scope *Scope)

+ type UnresolvedRef struct

+ type VarKind int32

+ const VarKindError

+ const VarKindFunction

+ const VarKindImport

+ const VarKindParameter

+ const VarKindVariable

+ type Variable struct

+ DeclNode *sitter.Node

+ Kind VarKind

+ Name string

+ Refs []*Reference

+ type Walker interface

+ OnEnterNode func(node *sitter.Node) bool

+ OnLeaveNode func(node *sitter.Node)

v0.3.1

Feb 27, 2025

v0.3.0

Feb 27, 2025

Changes in this version

+ var ErrUnsupportedLanguage = fmt.Errorf("unsupported language")

+ func GetEscapedCommentIdentifierFromPath(path string) string

+ func IssueAsTextFromJson(jsonData []byte) ([]byte, error)

+ func RunAnalyzerTests(testDir string, analyzers []*Analyzer) (string, string, bool, error)

type Issue

+ func IssueFromJson(jsonData []byte) (*Issue, error)

v0.2.0

Feb 18, 2025

Changes in this version

+ func Preorder(pass *Pass, fn func(*sitter.Node))

+ func ReportIssues(issues []*Issue, format string) ([]byte, error)

+ type Analyzer struct

+ Category Category

+ Description string

+ Language Language

+ Name string

+ Run func(*Pass) (interface{}, error)

+ Severity Severity

+ type Category string

+ const CategoryAntipattern

+ const CategoryBugRisk

+ const CategoryPerformance

+ const CategorySecurity

+ const CategoryStyle

+ func (c Category) IsValid() bool

+ type Issue struct

+ Category Category

+ Filepath string

+ Id *string

+ Message string

+ Node *sitter.Node

+ Severity Severity

+ func RunAnalyzers(path string, analyzers []*Analyzer) ([]*Issue, error)

+ func (i *Issue) AsJson() ([]byte, error)

+ func (i *Issue) AsText() ([]byte, error)

+ type Language int

+ const LangBash

+ const LangCsharp

+ const LangCss

+ const LangDockerfile

+ const LangElixir

+ const LangElm

+ const LangGo

+ const LangGroovy

+ const LangHcl

+ const LangHtml

+ const LangJava

+ const LangJs

+ const LangKotlin

+ const LangLua

+ const LangMarkdown

+ const LangOCaml

+ const LangPhp

+ const LangPy

+ const LangRuby

+ const LangRust

+ const LangScala

+ const LangSql

+ const LangSwift

+ const LangTs

+ const LangTsx

+ const LangUnknown

+ const LangYaml

+ func LanguageFromFilePath(path string) Language

+ func (lang Language) Grammar() *sitter.Language

+ type ParseResult struct

+ Ast *sitter.Node

+ FilePath string

+ Language Language

+ Source []byte

+ TsLanguage *sitter.Language

+ func Parse(filePath string, source []byte, language Language, grammar *sitter.Language) (*ParseResult, error)

+ func ParseFile(filePath string) (*ParseResult, error)

+ type Pass struct

+ Analyzer *Analyzer

+ FileContext *ParseResult

+ Files []*ParseResult

+ Report func(*Pass, *sitter.Node, string)

+ type Severity string

+ const SeverityCritical

+ const SeverityError

+ const SeverityInfo

+ const SeverityWarning

+ func (s Severity) IsValid() bool

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL