functions

package
v1.5.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 15, 2024 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type FunctionDetails

type FunctionDetails struct {
	FilePath   string
	File       string
	Name       string
	IsPublic   bool
	NumParams  int
	NumReturns int
	NumLines   int
}

func RetrieveFunctions

func RetrieveFunctions(pkg *model.PackageInfo, mainPackage string) ([]*FunctionDetails, error)

type RuleResult

type RuleResult struct {
	Rule          configuration.FunctionsRule `json:"rule"`
	Description   string                      `json:"description"`
	Verifications []Verification              `json:"verifications"`
	Passes        bool                        `json:"passes"`
}

func CheckRule

func CheckRule(moduleInfo model.ModuleInfo, functionRule configuration.FunctionsRule) *RuleResult

type RulesResult

type RulesResult struct {
	Results []*RuleResult `json:"results"`
	Passes  bool          `json:"passes"`
}

func CheckRules

func CheckRules(moduleInfo model.ModuleInfo, functionRules []*configuration.FunctionsRule) *RulesResult

type Verification

type Verification struct {
	Package string   `json:"package"`
	Details []string `json:"details"`
	Passes  bool     `json:"passes"`
}

Jump to

Keyboard shortcuts

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