analyzerapi

Documentation

Index

• Variables
• func AddModuleToResult(result *[]*ProjectModule, module *ProjectModule)
• func GetSingleLanguageMap(language ProjectLanguage, version string) map[ProjectLanguage]string
• func GetTestDataDir(t *testing.T, dir string) string
• func ProcessIgnoreFiles(files []string) *ignore.GitIgnore
• type Analyzer
• type AnalyzerContext
  • func GetAnalyzerContext(projectDir string) AnalyzerContext
  • func (ctx *AnalyzerContext) ContainsFile(extension string) bool
• type ProjectBuildSystem
• type ProjectBuildSystemSyntax
• type ProjectDependency
• type ProjectLanguage
• type ProjectModule
  • func FindParentModule(modules *[]*ProjectModule, module *ProjectModule) *ProjectModule
• type ProjectModuleDiscovery

Variables

var Analyzers []Analyzer

Functions

func AddModuleToResult

func AddModuleToResult(result *[]*ProjectModule, module *ProjectModule)

func GetSingleLanguageMap

func GetSingleLanguageMap(language ProjectLanguage, version string) map[ProjectLanguage]string

func GetTestDataDir

func GetTestDataDir(t *testing.T, dir string) string

func ProcessIgnoreFiles

func ProcessIgnoreFiles(files []string) *ignore.GitIgnore

Types

type Analyzer

type Analyzer interface {
	// GetName returns the name of the analyzer
	GetName() string

	// Analyze will retrieve information about the project
	Analyze(ctx AnalyzerContext) []*ProjectModule
}

Analyzer is the interface that needs to be implemented by all analyzers

type AnalyzerContext

type AnalyzerContext struct {
	// ProjectDir holds the project directory
	ProjectDir string `json:"project_dir"`

	// Files holds all project files
	Files []string `json:"files"`

	// FilesByExtension contains all files by extension
	FilesByExtension map[string][]string `json:"files_by_extension"`
}

AnalyzerContext holds the context to analyze projects

func GetAnalyzerContext

func GetAnalyzerContext(projectDir string) AnalyzerContext

func (*AnalyzerContext) ContainsFile

func (ctx *AnalyzerContext) ContainsFile(extension string) bool

type ProjectBuildSystem

type ProjectBuildSystem string

const (
	BuildSystemGradle          ProjectBuildSystem = "gradle"
	BuildSystemMaven           ProjectBuildSystem = "maven"
	BuildSystemGoMod           ProjectBuildSystem = "gomod"
	BuildSystemNpm             ProjectBuildSystem = "npm"
	BuildSystemHugo            ProjectBuildSystem = "hugo"
	BuildSystemHelm            ProjectBuildSystem = "helm"
	BuildSystemContainer       ProjectBuildSystem = "container"
	BuildSystemRequirementsTXT ProjectBuildSystem = "python-requirements.txt"
	BuildSystemPipfile         ProjectBuildSystem = "pipfile"
	BuildSystemSetupPy         ProjectBuildSystem = "setup.py"
	BuildSystemPoetry          ProjectBuildSystem = "poetry"
	BuildSystemMkdocs          ProjectBuildSystem = "mkdocs"
	BuildSystemComposer        ProjectBuildSystem = "composer"
	BuildSystemDotNet          ProjectBuildSystem = "dotnet"
	BuildSystemCargo           ProjectBuildSystem = "cargo"
)

type ProjectBuildSystemSyntax

type ProjectBuildSystemSyntax string

const (
	BuildSystemSyntaxDefault ProjectBuildSystemSyntax = "default"
	GradleGroovyDSL          ProjectBuildSystemSyntax = "groovy"
	GradleKotlinDSL          ProjectBuildSystemSyntax = "kotlin"
	ContainerFile            ProjectBuildSystemSyntax = "containerfile"
	ContainerBuildahScript   ProjectBuildSystemSyntax = "buildah-script"
	MkdocsTechdocs           ProjectBuildSystemSyntax = "mkdocs-techdocs"
)

type ProjectDependency

type ProjectDependency struct {
	// Type is the dep kind
	Type string `json:"type"`

	// ID is the identifier
	ID string `json:"id"`

	// Version is the dep version
	Version string `json:"version"`
}

ProjectDependency contains dependency information

type ProjectLanguage

type ProjectLanguage string

const (
	LanguageGolang     ProjectLanguage = "go"
	LanguageJava       ProjectLanguage = "java"
	LanguageKotlin     ProjectLanguage = "kotlin"
	LanguageJavascript ProjectLanguage = "javascript"
	LanguageTypescript ProjectLanguage = "typescript"
	LanguagePython     ProjectLanguage = "python"
	LanguagePHP        ProjectLanguage = "php"
	LanguageRust       ProjectLanguage = "rust"
)

type ProjectModule

type ProjectModule struct {
	// RootDirectory stores the project root directory
	RootDirectory string `json:"project_dir"`

	// Directory stores the module root directory
	Directory string `json:"module_dir"`

	// Discovery stores information on how this module was discovered
	Discovery []ProjectModuleDiscovery `json:"discovery"`

	// Name stores the module name
	Name string `json:"name"`

	// Slug contains an url/folder name compatible name of the module
	Slug string `json:"slug"`

	// BuildSystem used in this project
	BuildSystem ProjectBuildSystem `json:"build_system"`

	// BuildSystemSyntax used in this project
	BuildSystemSyntax ProjectBuildSystemSyntax `json:"build_system_syntax"`

	// Language of the project
	Language map[ProjectLanguage]string `json:"language"`

	// Dependencies
	Dependencies []ProjectDependency `json:"dependencies"`

	// Submodules contains information about submodules
	Submodules []*ProjectModule `json:"submodules"`

	// Files holds all project files
	Files []string `json:"files"`

	// FilesByExtension contains all files by extension
	FilesByExtension map[string][]string `json:"-"`
}

ProjectModule contains information about project modules

func FindParentModule

func FindParentModule(modules *[]*ProjectModule, module *ProjectModule) *ProjectModule

type ProjectModuleDiscovery

type ProjectModuleDiscovery struct {
	File string `json:"file"`
}

ProjectModuleDiscovery contains info on the files used to discover the module