generate

Documentation

Index

• func NewCmdConfigGenerate(cf *cmdutils.CLIFactory) *cobra.Command
• type Analyzer
• type AnalyzerMeta
• type DSConfig
• type Options
  • func (o *Options) Run() error
  • func (o *Options) Validate() error
• type Transformer

Functions

func NewCmdConfigGenerate

func NewCmdConfigGenerate(cf *cmdutils.CLIFactory) *cobra.Command

NewCmdVersion returns the current version of cli being used

Types

type Analyzer

type Analyzer struct {
	Name                string       `toml:"name,omitempty" json:"name,omitempty"`
	RuntimeVersion      string       `toml:"runtime_version,omitempty" json:"runtime_version,omitempty"`
	Enabled             bool         `toml:"enabled" json:"enabled"`
	DependencyFilePaths []string     `toml:"dependency_file_paths,omitempty" json:"dependency_file_paths,omitempty"`
	Meta                AnalyzerMeta `toml:"meta,omitempty" json:"meta,omitempty"`
	Thresholds          interface{}  `toml:"thresholds,omitempty" json:"thresholds,omitempty"`
}

DSConfig is the struct for .deepsource.toml file

type AnalyzerMeta

type AnalyzerMeta struct {
	ImportRoot  string `toml:"import_root,omitempty" json:"import_root,omitempty"`
	JavaVersion string `toml:"java_version,omitempty" json:"java_version,omitempty"`
}

type DSConfig

type DSConfig struct {
	Version         int           `toml:"version" json:"version"`
	ExcludePatterns []string      `toml:"exclude_patterns" json:"exclude_patterns,omitempty"`
	TestPatterns    []string      `toml:"test_patterns" json:"test_patterns,omitempty"`
	Analyzers       []Analyzer    `toml:"analyzers,omitempty" json:"analyzers,omitempty"`
	Transformers    []Transformer `toml:"transformers,omitempty" json:"transformers,omitempty"`
}

type Options

type Options struct {
	AnalyzerNames         []string
	AnalyzerShortcodes    []string
	AnalyzersMap          map[string]string // Map for {analyzer name : shortcode}
	TransformerNames      []string
	TransformerShortcodes []string
	TransformerMap        map[string]string // Map for {transformer name:shortcode}

	GoImportRoot string // Mandatory meta for Go
	JavaVersion  string // Mandatory meta for JAVA

	ActivatedAnalyzers    []string
	ActivatedTransformers []string
	ExcludePatterns       []string
	TestPatterns          []string

	GeneratedConfig string
	// contains filtered or unexported fields
}

Options holds the metadata.

func (*Options) Run

func (o *Options) Run() error

Run executes the command.

func (*Options) Validate

func (o *Options) Validate() error

Validate impletments the Validate method for the ICommand interface.

type Transformer

type Transformer struct {
	Name    string `toml:"name" json:"name"`
	Enabled bool   `toml:"enabled" json:"enabled"`
}