services

Documentation

Index

• Constants
• func AnalyseFile(basePath string, filePath string) (indexedFile dto.IndexedFile, err error)
• func AnalyseTheCode(src string, ext string, ignored []string) (foundResults map[string]dto.IndexedFile, pathIndex map[string]dto.IndexedFile, ...)
• func FindFeaturesInIndex(diff []string, absolutePath string) (result dto.AnalysisResult)
• func GetIgnoredFilePaths(path string, absolutePath string) (files []string, err error)
• type Git
  • func (g Git) Diff(path string, branch1 string, branch2 string) (files []string, err error)
• type VcsInterface

Constants

const (
	//FeatureAlias - the constant which identifies the feature alias which our parser will try to find in the strings
	FeatureAlias = "@featureType"

	//ProjectAlias - the constant for project annotation search
	ProjectAlias = "@project"
)

Functions

func AnalyseFile

func AnalyseFile(basePath string, filePath string) (indexedFile dto.IndexedFile, err error)

AnalyseFile find the features in the destination file path basePath - will be used for generation of relation path filePath - the actual absolute file path

func AnalyseTheCode

func AnalyseTheCode(src string, ext string, ignored []string) (foundResults map[string]dto.IndexedFile, pathIndex map[string]dto.IndexedFile, importsIndex map[string][]string, err error)

AnalyseTheCode method loads the available project features in the memory

func FindFeaturesInIndex

func FindFeaturesInIndex(diff []string, absolutePath string) (result dto.AnalysisResult)

FindFeaturesInIndex method tries to find features in the prepared indexes

func GetIgnoredFilePaths

func GetIgnoredFilePaths(path string, absolutePath string) (files []string, err error)

GetIgnoredFilePaths used for generation of the list of ignored file paths, which will be ignored during the features search

Types

type Git

type Git struct {
}

Git the object struct of Git vcs

func (Git) Diff

func (g Git) Diff(path string, branch1 string, branch2 string) (files []string, err error)

Diff the main method which is used for diff files get

type VcsInterface

type VcsInterface interface {
	Diff(path string, branch1 string, branch2 string) (files []string, err error)
	// contains filtered or unexported methods
}

VcsInterface the vcs interface