generate

Documentation

Index

• Constants
• func NewCmdConfigGenerate() *cobra.Command
• type Analyzer
• type AnalyzerMetadata
• type DSConfig
• type Options
  • func (o *Options) Run() error
• type Transformer

Constants

const DEEPSOURCE_TOML_VERSION = 1

Functions

func NewCmdConfigGenerate

func NewCmdConfigGenerate() *cobra.Command

NewCmdConfigGenerate handles the generation of DeepSource config based on user inputs

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                interface{} `toml:"meta,omitempty" json:"meta,omitempty"`
	Thresholds          interface{} `toml:"thresholds,omitempty" json:"thresholds,omitempty"`
}

DSConfig is the struct for .deepsource.toml file

type AnalyzerMetadata

type AnalyzerMetadata struct {
	FieldName   string
	Type        string
	Title       string
	Description string
	Options     []string
	UserInput   string
}

Struct to hold the data regarding the compulsary meta fields as required by analyzers Also, the userinput for that field

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 {
	ActivatedAnalyzers    []string // Analyzers activated by user
	AnalyzerMetaMap       map[string][]AnalyzerMetadata
	ActivatedTransformers []string // Transformers activated by the user
	ExcludePatterns       []string
	TestPatterns          []string
	GeneratedConfig       string
}

Options holds the metadata.

func (*Options) Run

func (o *Options) Run() error

Run executes the command.

type Transformer

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