core

Sep 19, 2025

Changes in this version

type Plugin

+ URL string

+ WithImports bool

May 1, 2025

Changes in this version

+ type InputFilesDir struct

+ Path string

+ Root string

type Inputs

+ InputFilesDir []InputFilesDir

Dec 29, 2024

Changes in this version

+ var ErrInvalidRule = errors.New("invalid rule")

+ var ErrRepositoryDoesNotExist = errors.New("repository does not exist")

+ func CheckIsIgnored(comments []*parser.Comment, ruleName string) bool

+ func GetRuleName(rule Rule) string

+ func SetAllowCommentIgnores(val bool)

+ type BUFConfig struct

+ Breaking Breaking

+ Build Build

+ Deps []string

+ Lint Lint

+ Version string

+ type Breaking struct

+ Except []string

+ Ignore []string

+ IgnoreOnly map[string][]string

+ IgnoreUnstablePackages bool

+ Use []string

+ type BreakingCheckConfig struct

+ AgainstGitRef string

+ IgnoreDirs []string

+ type BreakingChecker struct

+ func (b *BreakingChecker) Check() ([]IssueInfo, error)

+ type Build struct

+ Excludes []string

+ type Collection struct

+ Enums map[string]Enum

+ Imports map[ImportPath]Import

+ Messages map[string]Message

+ OneOfs map[string]OneOf

+ Services map[string]Service

+ type Config struct

+ Deps []string

+ Inputs Inputs

+ Plugins []Plugin

+ type Console interface

+ RunCmd func(ctx context.Context, dir string, command string, commandParams ...string) (string, error)

+ type Core struct

+ func New(rules []Rule, ignore []string, deps []string, ignoreOnly map[string][]string, ...) *Core

+ func (c *Core) BreakingCheck(ctx context.Context, workingDir, path string) ([]IssueInfo, error)

+ func (c *Core) Download(ctx context.Context, dependencies []string) error

+ func (c *Core) Generate(ctx context.Context, root, directory string) error

+ func (c *Core) Get(ctx context.Context, requestedModule models.Module) error

+ func (c *Core) Lint(ctx context.Context, fsWalker DirWalker) ([]IssueInfo, error)

+ func (c *Core) Update(ctx context.Context, dependencies []string) error

+ func (c *Core) Vendor(ctx context.Context) error

+ func (i *Core) Initialize(ctx context.Context, disk DirWalker, defaultLinters []string) error

+ type CurrentProjectGitWalker interface

+ GetDirWalker func(workingDir, gitRef, path string) (DirWalker, error)

+ type DirWalker interface

+ WalkDir func(callback func(path string, err error) error) error

+ type Enum struct

+ EnumPath string

+ PackageName PackageName

+ ProtoFilePath string

+ type FS interface

+ Create func(name string) (io.WriteCloser, error)

+ Open func(name string) (io.ReadCloser, error)

+ type GitRefNotFoundError struct

+ GitRef string

+ func (e *GitRefNotFoundError) Error() string

+ type Import struct

+ PackageName PackageName

+ ProtoFilePath string

+ type ImportPath string

+ func ConvertImportPath(source string) ImportPath

+ type InputGitRepo struct

+ Out string

+ SubDirectory string

+ URL string

+ type Inputs struct

+ Dirs []string

+ InputGitRepos []InputGitRepo

+ type InstructionInfo struct

+ Instruction string

+ PkgName PackageName

+ func (i InstructionInfo) GetFullName() string

+ type InstructionParser struct

+ SourcePkgName PackageName

+ func (p InstructionParser) Parse(input string) InstructionInfo

+ type Issue struct

+ Message string

+ Position meta.Position

+ RuleName string

+ SourceName string

+ func AppendIssue(issues []Issue, lintRule Rule, pos meta.Position, sourceName string, ...) []Issue

+ type IssueInfo struct

+ Path string

+ type Lint struct

+ AllowCommentIgnores bool

+ EnumZeroValueSuffix string

+ Except []string

+ Ignore []string

+ IgnoreOnly map[string][]string

+ RPCAllowGoogleProtobufEmptyRequests bool

+ RPCAllowGoogleProtobufEmptyResponses bool

+ RPCAllowSameRequestResponse bool

+ ServiceSuffix string

+ Use []string

+ type LockFile interface

+ DepsIter func() iter.Seq[models.LockFileInfo]

+ IsEmpty func() bool

+ Read func(moduleName string) (models.LockFileInfo, error)

+ Write func(moduleName string, revisionVersion string, ...) error

+ type Message struct

+ MessagePath string

+ PackageName PackageName

+ ProtoFilePath string

+ type Migrate struct

+ BUF *BUFConfig

+ type ModuleConfig interface

+ ReadFromRepo func(ctx context.Context, repo repository.Repo, revision models.Revision) (models.ModuleConfig, error)

+ type OneOf struct

+ OneOfPath string

+ PackageName PackageName

+ ProtoFilePath string

+ type OpenImportFileError struct

+ FileName string

+ func (e *OpenImportFileError) Error() string

+ type PackageName string

+ func GetPackageName(protoFile *unordered.Proto) PackageName

+ type Plugin struct

+ Name string

+ Options map[string]string

+ Out string

+ type ProtoData map[PackageName]*Collection

+ type ProtoInfo struct

+ Info *unordered.Proto

+ Path string

+ ProtoFilesFromImport map[ImportPath]*unordered.Proto

+ type Query struct

+ Compiler string

+ Files []string

+ Imports []string

+ Plugins []Plugin

+ type Repo interface

+ Archive func(ctx context.Context, revision models.Revision, ...) error

+ Fetch func(ctx context.Context, revision models.Revision) error

+ GetFiles func(ctx context.Context, revision models.Revision, dirs ...string) ([]string, error)

+ ReadFile func(ctx context.Context, revision models.Revision, fileName string) (string, error)

+ ReadRevision func(ctx context.Context, requestedVersion models.RequestedVersion) (models.Revision, error)

+ type Rule interface

+ Message func() string

+ Validate func(ProtoInfo) ([]Issue, error)

+ type Service struct

+ PackageName PackageName

+ ProtoFilePath string

+ type Storage interface

+ CreateCacheDownloadDir func(models.CacheDownloadPaths) error

+ CreateCacheRepositoryDir func(name string) (string, error)

+ GetCacheDownloadPaths func(module models.Module, revision models.Revision) models.CacheDownloadPaths

+ GetInstallDir func(moduleName string, revisionVersion string) string

+ GetInstalledModuleHash func(moduleName string, revisionVersion string) (models.ModuleHash, error)

+ Install func(cacheDownloadPaths models.CacheDownloadPaths, module models.Module, ...) (models.ModuleHash, error)

+ IsModuleInstalled func(module models.Module) (bool, error)