Documentation
¶
Overview ¶
Package cmd provides ...
Index ¶
- Constants
- Variables
- func AddFlags(rootCmd *cobra.Command)
- func BuildConfigFromFlags(cmd *cobra.Command, args []string) (*config.Config, error)
- func ExitCodeForError(err error) int
- func GetBuildDate() string
- func GetCommit() string
- func GetVersion() string
- func NewBaselineCommand() *cobra.Command
- func NewCheckCommand() *cobra.Command
- func NewRootCommand() *cobra.Command
- func NewStatsCommand() *cobra.Command
- func NewVersionCommand() *cobra.Command
- func PrintVersion()
- type CrawlOptions
- type FilterStats
- type SuppressionConfig
- type VersionInfo
Constants ¶
const ( ExitSuccess = 0 ExitGeneralError = 1 ExitConfigError = 2 ExitInternalError = 3 ExitInterrupted = 130 )
const ( // VendorDirPrefix is the vendor directory prefix for exclusion. VendorDirPrefix = "vendor" + string(filepath.Separator) // VendorDirInPath is the vendor directory marker when it appears in a path. VendorDirInPath = string(filepath.Separator) + VendorDirPrefix // DSStoreFile is the macOS Finder metadata file that should always be excluded. DSStoreFile = ".DS_Store" // GitDirPrefix is the Git directory prefix for exclusion. GitDirPrefix = ".git" + string(filepath.Separator) // GitDirInPath is the Git directory marker when it appears in a path. GitDirInPath = string(filepath.Separator) + GitDirPrefix // NodeModulesDirPrefix is the node_modules directory prefix for exclusion. NodeModulesDirPrefix = "node_modules" + string(filepath.Separator) // NodeModulesDirInPath is the node_modules directory marker when it appears in a path. NodeModulesDirInPath = string(filepath.Separator) + NodeModulesDirPrefix )
Directory exclusion constants.
Variables ¶
var ( Version = "dev" //nolint:gochecknoglobals // Build-time variables meant to be overridden Commit = "unknown" //nolint:gochecknoglobals Date = "unknown" //nolint:gochecknoglobals )
Version information - can be overridden during build.
Functions ¶
func BuildConfigFromFlags ¶
BuildConfigFromFlags extracts flag values and builds a merged configuration. This function handles the common config-building logic shared between run and stats commands.
func ExitCodeForError ¶ added in v0.4.0
ExitCodeForError maps an error to the appropriate process exit code. nil error returns ExitSuccess. Context cancellation returns ExitInterrupted. Config/validation errors return ExitConfigError. Everything else returns ExitGeneralError.
func GetVersion ¶
func GetVersion() string
GetVersion returns version information including build info.
func NewBaselineCommand ¶ added in v0.4.0
NewBaselineCommand creates the `baseline` subcommand that snapshots the currently-detected clones into a baseline file for later CI comparison.
func NewCheckCommand ¶ added in v0.4.0
NewCheckCommand creates the `check` subcommand that reports only new clones relative to a baseline, exiting non-zero if any are found. Designed for CI.
func NewRootCommand ¶
NewRootCommand creates the root Cobra command.
func NewStatsCommand ¶
NewStatsCommand creates the stats command.
func NewVersionCommand ¶ added in v0.4.0
NewVersionCommand creates the version subcommand.
Types ¶
type CrawlOptions ¶
type CrawlOptions struct {
Ctx context.Context
Filter *gogenfilter.Filter
FilterStats *FilterStats
Includes generatorIncludes
IncludeVendor bool
IncludeNodeMods bool
FileCheck fileCheckFunc
FChan chan string
}
CrawlOptions contains the common options for crawling operations.
type FilterStats ¶ added in v0.2.0
type FilterStats struct {
// contains filtered or unexported fields
}
FilterStats holds aggregated filter statistics. Replaces the removed gogenfilter.FilterStats type — stats aggregation is now the caller's responsibility per gogenfilter's API redesign.
func NewFilterStats ¶ added in v0.2.0
func NewFilterStats(reasons []gogenfilter.FilterReason) *FilterStats
NewFilterStats creates a new FilterStats with the given filter reasons.
func (*FilterStats) Breakdown ¶ added in v0.2.0
func (s *FilterStats) Breakdown() map[string]int
Breakdown returns a copy of the per-reason breakdown.
func (*FilterStats) FilteredBy ¶ added in v0.2.0
func (s *FilterStats) FilteredBy(reason string) int
FilteredBy returns the number of files filtered by the given reason.
func (*FilterStats) Reasons ¶ added in v0.2.0
func (s *FilterStats) Reasons() []gogenfilter.FilterReason
Reasons returns the filter reasons this tracker was configured with.
func (*FilterStats) Record ¶ added in v0.2.0
func (s *FilterStats) Record(result gogenfilter.FilterResult)
Record records a filter result.
func (*FilterStats) TotalFiltered ¶ added in v0.2.0
func (s *FilterStats) TotalFiltered() int
TotalFiltered returns the total number of filtered files.
type SuppressionConfig ¶ added in v0.4.0
SuppressionConfig groups the filter thresholds used to suppress clone groups. Passing it as a single value avoids 3-parameter function signatures that are prone to argument-swap bugs.
type VersionInfo ¶ added in v0.4.0
type VersionInfo struct {
Version string `json:"version"`
Commit string `json:"commit"`
Date string `json:"date"`
GoVersion string `json:"goVersion"`
Compiler string `json:"compiler"`
Platform string `json:"platform"`
Arch string `json:"arch"`
}
VersionInfo provides structured version information for CI tooling.
Source Files
Directories