structdiff

Documentation

Overview

Package structdiff compares two structural indexes to detect added, removed, and modified symbols and imports.

Index

• type FileImportChange
• type ModifiedSymbol
• type Report
  • func Compare(before, after *model.Index) Report
• type Stats
• type SymbolRef

Types

type FileImportChange

type FileImportChange struct {
	File    string   `json:"file"`
	Added   []string `json:"added,omitempty"`
	Removed []string `json:"removed,omitempty"`
}

type ModifiedSymbol

type ModifiedSymbol struct {
	Before SymbolRef `json:"before"`
	After  SymbolRef `json:"after"`
	Fields []string  `json:"fields"`
}

type Report

type Report struct {
	BeforeRoot      string             `json:"before_root"`
	AfterRoot       string             `json:"after_root"`
	AddedSymbols    []SymbolRef        `json:"added_symbols,omitempty"`
	RemovedSymbols  []SymbolRef        `json:"removed_symbols,omitempty"`
	ModifiedSymbols []ModifiedSymbol   `json:"modified_symbols,omitempty"`
	ImportChanges   []FileImportChange `json:"import_changes,omitempty"`
	Stats           Stats              `json:"stats"`
}

func Compare

func Compare(before, after *model.Index) Report

type Stats

type Stats struct {
	AddedSymbols    int `json:"added_symbols"`
	RemovedSymbols  int `json:"removed_symbols"`
	ModifiedSymbols int `json:"modified_symbols"`
	ChangedFiles    int `json:"changed_files"`
}

type SymbolRef

type SymbolRef struct {
	File      string `json:"file"`
	Kind      string `json:"kind"`
	Name      string `json:"name"`
	Signature string `json:"signature,omitempty"`
	Receiver  string `json:"receiver,omitempty"`
	StartLine int    `json:"start_line"`
	EndLine   int    `json:"end_line"`
}