project

type Config struct {
	// HideProjectNames determines if the project name should be obfuscated by matching its path.
	HideProjectNames []regex.Regex
	// Patterns contains the overridden project name per path.
	MapPatterns []MapPattern
	// ProjectFromGitRemote when enabled uses the git remote as the project name instead of local git folder.
	ProjectFromGitRemote bool
	// Submodule contains the submodule configurations.
	Submodule Submodule
}

type Detecter interface {
	Detect() (Result, bool, error)
	ID() DetectorID
}

type DetecterArg struct {
	Filepath  string
	ShouldRun bool
}

type DetectorID int

type File struct {
	Filepath string
}

type FilterConfig struct {
	// ExcludeUnknownProject determines if heartbeat should be skipped when the project cannot be detected.
	ExcludeUnknownProject bool
}

type Git struct {
	// Filepath contains the entity path.
	Filepath string
	// ProjectFromGitRemote when enabled uses the git remote as the project name instead of local git folder.
	ProjectFromGitRemote bool
	// SubmoduleDisabledPatterns will be matched against the submodule path and if matching, will skip it.
	SubmoduleDisabledPatterns []regex.Regex
	// SubmoduleProjectMapPatterns will be matched against the submodule path and if matching, will use the project map.
	SubmoduleProjectMapPatterns []MapPattern
}

type Map struct {
	Filepath string
	Patterns []MapPattern
}

type MapPattern struct {
	// Name is the project name.
	Name string
	// Regex is the regular expression for a specific path.
	Regex regex.Regex
}

type Mercurial struct {
	// Filepath contains the entity path.
	Filepath string
}

type Result struct {
	Project string
	Branch  string
	Folder  string
}

type Submodule struct {
	// DisabledPatterns contains the paths to match against submodules
	// and if matched it will skip the project detection.
	DisabledPatterns []regex.Regex
	// MapPatterns contains the overridden project name per path for submodule.
	MapPatterns []MapPattern
}

type Subversion struct {
	// Filepath contains the entity path.
	Filepath string
}

type Tfvc struct {
	// Filepath contains the entity path.
	Filepath string
}