internal

package

v3.6.3 Latest Latest Go to latest Published: Jan 16, 2026 License: BSD-3-Clause Imports: 25 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/vektra/mockery

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type Formatter
type Interface
- func NewInterface(name string, typeSpec *ast.TypeSpec, genDecl *ast.GenDecl, filepath string, ...) *Interface
type NodeVisitor
- func NewNodeVisitor(ctx context.Context) *NodeVisitor
- func (nv *NodeVisitor) DeclaredInterfaces() []declaredInterface
- func (nv *NodeVisitor) Visit(node ast.Node) ast.Visitor
type Parser
- func NewParser(buildTags []string, mockeryConfig config.RootConfig) *Parser
- func (p *Parser) ParsePackages(ctx context.Context, packageNames []string) ([]*Interface, error)
type RemoteTemplate
- func NewRemoteTemplate(templateURL string, schemaURL string) *RemoteTemplate
- func (r *RemoteTemplate) Schema(ctx context.Context) (*gojsonschema.Schema, error)
- func (r *RemoteTemplate) Template(ctx context.Context) (string, error)
type TemplateGenerator
- func NewTemplateGenerator(ctx context.Context, srcPkg *packages.Package, outPkgFSPath string, ...) (*TemplateGenerator, error)
- func (g *TemplateGenerator) Generate(ctx context.Context, interfaces []*Interface) ([]byte, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNoConfigFile         = fmt.Errorf("no config file exists")
	ErrNoGoFilesFoundInRoot = fmt.Errorf("no go files found in root search path")
	ErrPkgNotFound          = fmt.Errorf("package not found in config")
	ErrGoModNotFound        = fmt.Errorf("no go.mod file found")
	ErrGoModInvalid         = fmt.Errorf("go.mod file has no module line")
)

Functions ¶

This section is empty.

Types ¶

type Formatter ¶

type Formatter string

const (
	FormatGofmt     Formatter = "gofmt"
	FormatGoImports Formatter = "goimports"
	FormatNoop      Formatter = "noop"
)

type Interface ¶ added in v3.1.0

type Interface struct {
	Name       string // Name of the type to be mocked.
	TypeSpec   *ast.TypeSpec
	GenDecl    *ast.GenDecl
	FilePath   string
	FileSyntax *ast.File
	Pkg        *packages.Package
	Config     *config.Config
}

func NewInterface ¶ added in v3.1.0

func NewInterface(
	name string,
	typeSpec *ast.TypeSpec,
	genDecl *ast.GenDecl,
	filepath string,
	fileSyntax *ast.File,
	pkg *packages.Package,
	config *config.Config,
) *Interface

type NodeVisitor ¶

type NodeVisitor struct {
	// contains filtered or unexported fields
}

func NewNodeVisitor ¶

func NewNodeVisitor(ctx context.Context) *NodeVisitor

func (*NodeVisitor) DeclaredInterfaces ¶

func (nv *NodeVisitor) DeclaredInterfaces() []declaredInterface

func (*NodeVisitor) Visit ¶

func (nv *NodeVisitor) Visit(node ast.Node) ast.Visitor

type Parser ¶

type Parser struct {
	// contains filtered or unexported fields
}

func NewParser ¶

func NewParser(buildTags []string, mockeryConfig config.RootConfig) *Parser

func (*Parser) ParsePackages ¶

func (p *Parser) ParsePackages(ctx context.Context, packageNames []string) ([]*Interface, error)

type RemoteTemplate ¶

type RemoteTemplate struct {
	// contains filtered or unexported fields
}

func NewRemoteTemplate ¶

func NewRemoteTemplate(templateURL string, schemaURL string) *RemoteTemplate

func (*RemoteTemplate) Schema ¶

func (r *RemoteTemplate) Schema(ctx context.Context) (*gojsonschema.Schema, error)

Schema returns the JSON Schema as a string. It downloads the remote schema once and caches the result for future calls.

func (*RemoteTemplate) Template ¶

func (r *RemoteTemplate) Template(ctx context.Context) (string, error)

Template will return the template string. It downloads the remote template once and caches the result for future calls.

type TemplateGenerator ¶

type TemplateGenerator struct {
	// contains filtered or unexported fields
}

func NewTemplateGenerator ¶

func NewTemplateGenerator(
	ctx context.Context,
	srcPkg *packages.Package,
	outPkgFSPath string,
	templateName string,
	templateSchema string,
	requireSchemaExists bool,
	remoteTemplateCache map[string]*RemoteTemplate,
	formatter Formatter,
	pkgConfig *config.Config,
	pkgName string,
	forceInPackage *bool,
) (*TemplateGenerator, error)

func (*TemplateGenerator) Generate ¶

func (g *TemplateGenerator) Generate(
	ctx context.Context,
	interfaces []*Interface,
) ([]byte, error)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
config
file
fixtures
12345678/http
auto_generated_skip
buildtag/comment
buildtag/filename
constraint_ifaces
constraints
directive_comments
directive_comments_example
empty_return
example_project
example_project/bar/foo
example_project/baz
example_project/baz/internal/foo
example_project/context
example_project/foo
example_project/pkg_with_subpkgs
example_project/pkg_with_subpkgs/subpkg1
example_project/pkg_with_subpkgs/subpkg2
example_project/pkg_with_subpkgs/subpkg2/subpkg3
example_project/replace_type
example_project/replace_type/rti/internal
example_project/replace_type/rti/rt1
example_project/replace_type/rti/rt2
http
iface_new_type
iface_new_type/subpkg
iface_typed_param
iface_typed_param_lowercase
include_auto_generated
index_list_expr
inpackage
interface_dir_relative
interface_dir_relative/internal/fixtures/interface_dir_relative
interface_dir_relative/mocks/fixtures/interface_dir_relative
method_args/same_name_arg_and_type
multi_template
output_dir
pkg_with_no_files/subpkg
recursive_generation
recursive_generation/subpkg1
recursive_generation/subpkg2
recursive_generation/subpkg_with_only_autogenerated_files Code generated by an arbitrary code generator thingy.	Code generated by an arbitrary code generator thingy.
recursive_generation_with_subpkg_exclude
recursive_generation_with_subpkg_exclude/subpkg1
recursive_generation_with_subpkg_exclude/subpkg2
redefined_type_b
replace_type_pointers
template_exercise
type_alias
type_alias/subpkg
unexported
logging
stackerr

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL