Documentation ¶
Index ¶
- Variables
- type Config
- func (*Config) Descriptor() ([]byte, []int)deprecated
- func (x *Config) GetEnv() *Config_Env
- func (x *Config) GetFilename() string
- func (x *Config) GetFilters() []*Config_Filter
- func (x *Config) GetKernels() []*anypb.Any
- func (x *Config) GetLog() *Config_Log
- func (x *Config) GetProject() *Config_Project
- func (x *Config) GetServer() *Config_Server
- func (m *Config) GetSource() isConfig_Source
- func (*Config) ProtoMessage()
- func (x *Config) ProtoReflect() protoreflect.Message
- func (x *Config) Reset()
- func (x *Config) String() string
- type Config_DockerKernel
- func (*Config_DockerKernel) Descriptor() ([]byte, []int)deprecated
- func (x *Config_DockerKernel) GetBuild() *Config_DockerKernel_Build
- func (x *Config_DockerKernel) GetImage() string
- func (x *Config_DockerKernel) GetName() string
- func (*Config_DockerKernel) ProtoMessage()
- func (x *Config_DockerKernel) ProtoReflect() protoreflect.Message
- func (x *Config_DockerKernel) Reset()
- func (x *Config_DockerKernel) String() string
- type Config_DockerKernel_Build
- func (*Config_DockerKernel_Build) Descriptor() ([]byte, []int)deprecated
- func (x *Config_DockerKernel_Build) GetContext() string
- func (x *Config_DockerKernel_Build) GetDockerfile() string
- func (*Config_DockerKernel_Build) ProtoMessage()
- func (x *Config_DockerKernel_Build) ProtoReflect() protoreflect.Message
- func (x *Config_DockerKernel_Build) Reset()
- func (x *Config_DockerKernel_Build) String() string
- type Config_Env
- func (*Config_Env) Descriptor() ([]byte, []int)deprecated
- func (x *Config_Env) GetSources() []string
- func (x *Config_Env) GetUseSystemEnv() bool
- func (*Config_Env) ProtoMessage()
- func (x *Config_Env) ProtoReflect() protoreflect.Message
- func (x *Config_Env) Reset()
- func (x *Config_Env) String() string
- type Config_Filename
- type Config_Filter
- func (*Config_Filter) Descriptor() ([]byte, []int)deprecated
- func (x *Config_Filter) GetCondition() string
- func (x *Config_Filter) GetType() Config_FilterType
- func (*Config_Filter) ProtoMessage()
- func (x *Config_Filter) ProtoReflect() protoreflect.Message
- func (x *Config_Filter) Reset()
- func (x *Config_Filter) String() string
- type Config_FilterType
- func (Config_FilterType) Descriptor() protoreflect.EnumDescriptor
- func (x Config_FilterType) Enum() *Config_FilterType
- func (Config_FilterType) EnumDescriptor() ([]byte, []int)deprecated
- func (x Config_FilterType) Number() protoreflect.EnumNumber
- func (x Config_FilterType) String() string
- func (Config_FilterType) Type() protoreflect.EnumType
- type Config_LocalKernel
- func (*Config_LocalKernel) Descriptor() ([]byte, []int)deprecated
- func (x *Config_LocalKernel) GetName() string
- func (*Config_LocalKernel) ProtoMessage()
- func (x *Config_LocalKernel) ProtoReflect() protoreflect.Message
- func (x *Config_LocalKernel) Reset()
- func (x *Config_LocalKernel) String() string
- type Config_Log
- func (*Config_Log) Descriptor() ([]byte, []int)deprecated
- func (x *Config_Log) GetEnabled() bool
- func (x *Config_Log) GetPath() string
- func (x *Config_Log) GetVerbose() bool
- func (*Config_Log) ProtoMessage()
- func (x *Config_Log) ProtoReflect() protoreflect.Message
- func (x *Config_Log) Reset()
- func (x *Config_Log) String() string
- type Config_Project
- func (*Config_Project) Descriptor() ([]byte, []int)deprecated
- func (x *Config_Project) GetDir() string
- func (x *Config_Project) GetDisableGitignore() bool
- func (x *Config_Project) GetFindRepoUpward() bool
- func (x *Config_Project) GetIgnorePaths() []string
- func (*Config_Project) ProtoMessage()
- func (x *Config_Project) ProtoReflect() protoreflect.Message
- func (x *Config_Project) Reset()
- func (x *Config_Project) String() string
- type Config_Project_
- type Config_Server
- func (*Config_Server) Descriptor() ([]byte, []int)deprecated
- func (x *Config_Server) GetAddress() string
- func (x *Config_Server) GetTls() *Config_Server_TLS
- func (*Config_Server) ProtoMessage()
- func (x *Config_Server) ProtoReflect() protoreflect.Message
- func (x *Config_Server) Reset()
- func (x *Config_Server) String() string
- type Config_Server_TLS
- func (*Config_Server_TLS) Descriptor() ([]byte, []int)deprecated
- func (x *Config_Server_TLS) GetCertFile() string
- func (x *Config_Server_TLS) GetEnabled() bool
- func (x *Config_Server_TLS) GetKeyFile() string
- func (*Config_Server_TLS) ProtoMessage()
- func (x *Config_Server_TLS) ProtoReflect() protoreflect.Message
- func (x *Config_Server_TLS) Reset()
- func (x *Config_Server_TLS) String() string
Constants ¶
This section is empty.
Variables ¶
var ( Config_FilterType_name = map[int32]string{ 0: "FILTER_TYPE_UNSPECIFIED", 1: "FILTER_TYPE_BLOCK", 2: "FILTER_TYPE_DOCUMENT", } Config_FilterType_value = map[string]int32{ "FILTER_TYPE_UNSPECIFIED": 0, "FILTER_TYPE_BLOCK": 1, "FILTER_TYPE_DOCUMENT": 2, } )
Enum value maps for Config_FilterType.
var File_runme_config_v1alpha1_config_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct { // source is a source of Markdown files to look into. // // Types that are assignable to Source: // // *Config_Project_ // *Config_Filename Source isConfig_Source `protobuf_oneof:"source"` // env is the environment variables configuration. Env *Config_Env `protobuf:"bytes,3,opt,name=env,proto3" json:"env,omitempty"` // filters is a list of filters to apply. // Filters can be applied to documents or // individual code blocks. Filters []*Config_Filter `protobuf:"bytes,5,rep,name=filters,proto3" json:"filters,omitempty"` // log contains the log configuration. Log *Config_Log `protobuf:"bytes,7,opt,name=log,proto3" json:"log,omitempty"` Server *Config_Server `protobuf:"bytes,8,opt,name=server,proto3" json:"server,omitempty"` Kernels []*anypb.Any `protobuf:"bytes,9,rep,name=kernels,proto3" json:"kernels,omitempty"` // contains filtered or unexported fields }
Config describes the configuration of the runme tools, including CLI, server, and clients like VS Code extension.
func (*Config) Descriptor
deprecated
func (*Config) GetEnv ¶
func (x *Config) GetEnv() *Config_Env
func (*Config) GetFilename ¶
func (*Config) GetFilters ¶
func (x *Config) GetFilters() []*Config_Filter
func (*Config) GetKernels ¶ added in v3.2.7
func (*Config) GetLog ¶
func (x *Config) GetLog() *Config_Log
func (*Config) GetProject ¶
func (x *Config) GetProject() *Config_Project
func (*Config) GetServer ¶ added in v3.2.5
func (x *Config) GetServer() *Config_Server
func (*Config) ProtoMessage ¶
func (*Config) ProtoMessage()
func (*Config) ProtoReflect ¶
func (x *Config) ProtoReflect() protoreflect.Message
type Config_DockerKernel ¶ added in v3.2.7
type Config_DockerKernel struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Image string `protobuf:"bytes,2,opt,name=image,proto3" json:"image,omitempty"` Build *Config_DockerKernel_Build `protobuf:"bytes,3,opt,name=build,proto3" json:"build,omitempty"` // contains filtered or unexported fields }
func (*Config_DockerKernel) Descriptor
deprecated
added in
v3.2.7
func (*Config_DockerKernel) Descriptor() ([]byte, []int)
Deprecated: Use Config_DockerKernel.ProtoReflect.Descriptor instead.
func (*Config_DockerKernel) GetBuild ¶ added in v3.2.7
func (x *Config_DockerKernel) GetBuild() *Config_DockerKernel_Build
func (*Config_DockerKernel) GetImage ¶ added in v3.2.7
func (x *Config_DockerKernel) GetImage() string
func (*Config_DockerKernel) GetName ¶ added in v3.2.7
func (x *Config_DockerKernel) GetName() string
func (*Config_DockerKernel) ProtoMessage ¶ added in v3.2.7
func (*Config_DockerKernel) ProtoMessage()
func (*Config_DockerKernel) ProtoReflect ¶ added in v3.2.7
func (x *Config_DockerKernel) ProtoReflect() protoreflect.Message
func (*Config_DockerKernel) Reset ¶ added in v3.2.7
func (x *Config_DockerKernel) Reset()
func (*Config_DockerKernel) String ¶ added in v3.2.7
func (x *Config_DockerKernel) String() string
type Config_DockerKernel_Build ¶ added in v3.2.7
type Config_DockerKernel_Build struct { Context string `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"` Dockerfile string `protobuf:"bytes,2,opt,name=dockerfile,proto3" json:"dockerfile,omitempty"` // contains filtered or unexported fields }
func (*Config_DockerKernel_Build) Descriptor
deprecated
added in
v3.2.7
func (*Config_DockerKernel_Build) Descriptor() ([]byte, []int)
Deprecated: Use Config_DockerKernel_Build.ProtoReflect.Descriptor instead.
func (*Config_DockerKernel_Build) GetContext ¶ added in v3.2.7
func (x *Config_DockerKernel_Build) GetContext() string
func (*Config_DockerKernel_Build) GetDockerfile ¶ added in v3.2.7
func (x *Config_DockerKernel_Build) GetDockerfile() string
func (*Config_DockerKernel_Build) ProtoMessage ¶ added in v3.2.7
func (*Config_DockerKernel_Build) ProtoMessage()
func (*Config_DockerKernel_Build) ProtoReflect ¶ added in v3.2.7
func (x *Config_DockerKernel_Build) ProtoReflect() protoreflect.Message
func (*Config_DockerKernel_Build) Reset ¶ added in v3.2.7
func (x *Config_DockerKernel_Build) Reset()
func (*Config_DockerKernel_Build) String ¶ added in v3.2.7
func (x *Config_DockerKernel_Build) String() string
type Config_Env ¶
type Config_Env struct { // use_system_env indicates whether to use the system environment variables. UseSystemEnv bool `protobuf:"varint,1,opt,name=use_system_env,json=useSystemEnv,proto3" json:"use_system_env,omitempty"` // sources is a list of files with env. Sources []string `protobuf:"bytes,2,rep,name=sources,proto3" json:"sources,omitempty"` // contains filtered or unexported fields }
func (*Config_Env) Descriptor
deprecated
func (*Config_Env) Descriptor() ([]byte, []int)
Deprecated: Use Config_Env.ProtoReflect.Descriptor instead.
func (*Config_Env) GetSources ¶
func (x *Config_Env) GetSources() []string
func (*Config_Env) GetUseSystemEnv ¶
func (x *Config_Env) GetUseSystemEnv() bool
func (*Config_Env) ProtoMessage ¶
func (*Config_Env) ProtoMessage()
func (*Config_Env) ProtoReflect ¶
func (x *Config_Env) ProtoReflect() protoreflect.Message
func (*Config_Env) Reset ¶
func (x *Config_Env) Reset()
func (*Config_Env) String ¶
func (x *Config_Env) String() string
type Config_Filename ¶
type Config_Filename struct { // filename indicates a single Markdown file. Filename string `protobuf:"bytes,2,opt,name=filename,proto3,oneof"` }
type Config_Filter ¶
type Config_Filter struct { // type is the type of the filter. Type Config_FilterType `protobuf:"varint,1,opt,name=type,proto3,enum=runme.config.v1alpha1.Config_FilterType" json:"type,omitempty"` // condition is the filter program to execute for each document or block, // depending on the filter type. // // The condition should be a valid Expr expression and it should return a boolean value. // You can read more about the Expr syntax on https://expr-lang.org/. Condition string `protobuf:"bytes,2,opt,name=condition,proto3" json:"condition,omitempty"` // contains filtered or unexported fields }
func (*Config_Filter) Descriptor
deprecated
func (*Config_Filter) Descriptor() ([]byte, []int)
Deprecated: Use Config_Filter.ProtoReflect.Descriptor instead.
func (*Config_Filter) GetCondition ¶
func (x *Config_Filter) GetCondition() string
func (*Config_Filter) GetType ¶
func (x *Config_Filter) GetType() Config_FilterType
func (*Config_Filter) ProtoMessage ¶
func (*Config_Filter) ProtoMessage()
func (*Config_Filter) ProtoReflect ¶
func (x *Config_Filter) ProtoReflect() protoreflect.Message
func (*Config_Filter) Reset ¶
func (x *Config_Filter) Reset()
func (*Config_Filter) String ¶
func (x *Config_Filter) String() string
type Config_FilterType ¶
type Config_FilterType int32
const ( Config_FILTER_TYPE_UNSPECIFIED Config_FilterType = 0 Config_FILTER_TYPE_BLOCK Config_FilterType = 1 Config_FILTER_TYPE_DOCUMENT Config_FilterType = 2 )
func (Config_FilterType) Descriptor ¶
func (Config_FilterType) Descriptor() protoreflect.EnumDescriptor
func (Config_FilterType) Enum ¶
func (x Config_FilterType) Enum() *Config_FilterType
func (Config_FilterType) EnumDescriptor
deprecated
func (Config_FilterType) EnumDescriptor() ([]byte, []int)
Deprecated: Use Config_FilterType.Descriptor instead.
func (Config_FilterType) Number ¶
func (x Config_FilterType) Number() protoreflect.EnumNumber
func (Config_FilterType) String ¶
func (x Config_FilterType) String() string
func (Config_FilterType) Type ¶
func (Config_FilterType) Type() protoreflect.EnumType
type Config_LocalKernel ¶ added in v3.2.7
type Config_LocalKernel struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
func (*Config_LocalKernel) Descriptor
deprecated
added in
v3.2.7
func (*Config_LocalKernel) Descriptor() ([]byte, []int)
Deprecated: Use Config_LocalKernel.ProtoReflect.Descriptor instead.
func (*Config_LocalKernel) GetName ¶ added in v3.2.7
func (x *Config_LocalKernel) GetName() string
func (*Config_LocalKernel) ProtoMessage ¶ added in v3.2.7
func (*Config_LocalKernel) ProtoMessage()
func (*Config_LocalKernel) ProtoReflect ¶ added in v3.2.7
func (x *Config_LocalKernel) ProtoReflect() protoreflect.Message
func (*Config_LocalKernel) Reset ¶ added in v3.2.7
func (x *Config_LocalKernel) Reset()
func (*Config_LocalKernel) String ¶ added in v3.2.7
func (x *Config_LocalKernel) String() string
type Config_Log ¶
type Config_Log struct { // enabled indicates whether to enable logging. Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"` // path is the path to the log output file. Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"` // verbose is the verbosity level of the log. Verbose bool `protobuf:"varint,3,opt,name=verbose,proto3" json:"verbose,omitempty"` // contains filtered or unexported fields }
func (*Config_Log) Descriptor
deprecated
func (*Config_Log) Descriptor() ([]byte, []int)
Deprecated: Use Config_Log.ProtoReflect.Descriptor instead.
func (*Config_Log) GetEnabled ¶
func (x *Config_Log) GetEnabled() bool
func (*Config_Log) GetPath ¶
func (x *Config_Log) GetPath() string
func (*Config_Log) GetVerbose ¶
func (x *Config_Log) GetVerbose() bool
func (*Config_Log) ProtoMessage ¶
func (*Config_Log) ProtoMessage()
func (*Config_Log) ProtoReflect ¶
func (x *Config_Log) ProtoReflect() protoreflect.Message
func (*Config_Log) Reset ¶
func (x *Config_Log) Reset()
func (*Config_Log) String ¶
func (x *Config_Log) String() string
type Config_Project ¶
type Config_Project struct { // dir is the directory to look for Markdown files. Dir string `protobuf:"bytes,1,opt,name=dir,proto3" json:"dir,omitempty"` // find_repo_upward indicates whether to find the nearest Git repository upward. // This is useful to, for example, recognize .gitignore files. FindRepoUpward bool `protobuf:"varint,2,opt,name=find_repo_upward,json=findRepoUpward,proto3" json:"find_repo_upward,omitempty"` // ignore_paths is a list of paths to ignore relative to dir. IgnorePaths []string `protobuf:"bytes,3,rep,name=ignore_paths,json=ignore,proto3" json:"ignore_paths,omitempty"` // disable_gitignore indicates whether to disable the .gitignore file. DisableGitignore bool `protobuf:"varint,4,opt,name=disable_gitignore,json=disableGitignore,proto3" json:"disable_gitignore,omitempty"` // contains filtered or unexported fields }
func (*Config_Project) Descriptor
deprecated
func (*Config_Project) Descriptor() ([]byte, []int)
Deprecated: Use Config_Project.ProtoReflect.Descriptor instead.
func (*Config_Project) GetDir ¶
func (x *Config_Project) GetDir() string
func (*Config_Project) GetDisableGitignore ¶
func (x *Config_Project) GetDisableGitignore() bool
func (*Config_Project) GetFindRepoUpward ¶
func (x *Config_Project) GetFindRepoUpward() bool
func (*Config_Project) GetIgnorePaths ¶
func (x *Config_Project) GetIgnorePaths() []string
func (*Config_Project) ProtoMessage ¶
func (*Config_Project) ProtoMessage()
func (*Config_Project) ProtoReflect ¶
func (x *Config_Project) ProtoReflect() protoreflect.Message
func (*Config_Project) Reset ¶
func (x *Config_Project) Reset()
func (*Config_Project) String ¶
func (x *Config_Project) String() string
type Config_Project_ ¶
type Config_Project_ struct { // project indicates a dir-based source typically including multiple Markdown files. Project *Config_Project `protobuf:"bytes,1,opt,name=project,proto3,oneof"` }
type Config_Server ¶ added in v3.2.5
type Config_Server struct { Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"` Tls *Config_Server_TLS `protobuf:"bytes,2,opt,name=tls,proto3" json:"tls,omitempty"` // contains filtered or unexported fields }
func (*Config_Server) Descriptor
deprecated
added in
v3.2.5
func (*Config_Server) Descriptor() ([]byte, []int)
Deprecated: Use Config_Server.ProtoReflect.Descriptor instead.
func (*Config_Server) GetAddress ¶ added in v3.2.5
func (x *Config_Server) GetAddress() string
func (*Config_Server) GetTls ¶ added in v3.2.5
func (x *Config_Server) GetTls() *Config_Server_TLS
func (*Config_Server) ProtoMessage ¶ added in v3.2.5
func (*Config_Server) ProtoMessage()
func (*Config_Server) ProtoReflect ¶ added in v3.2.5
func (x *Config_Server) ProtoReflect() protoreflect.Message
func (*Config_Server) Reset ¶ added in v3.2.5
func (x *Config_Server) Reset()
func (*Config_Server) String ¶ added in v3.2.5
func (x *Config_Server) String() string
type Config_Server_TLS ¶ added in v3.2.5
type Config_Server_TLS struct { Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"` CertFile string `protobuf:"bytes,2,opt,name=cert_file,json=certFile,proto3" json:"cert_file,omitempty"` KeyFile string `protobuf:"bytes,3,opt,name=key_file,json=keyFile,proto3" json:"key_file,omitempty"` // contains filtered or unexported fields }
func (*Config_Server_TLS) Descriptor
deprecated
added in
v3.2.5
func (*Config_Server_TLS) Descriptor() ([]byte, []int)
Deprecated: Use Config_Server_TLS.ProtoReflect.Descriptor instead.
func (*Config_Server_TLS) GetCertFile ¶ added in v3.2.5
func (x *Config_Server_TLS) GetCertFile() string
func (*Config_Server_TLS) GetEnabled ¶ added in v3.2.5
func (x *Config_Server_TLS) GetEnabled() bool
func (*Config_Server_TLS) GetKeyFile ¶ added in v3.2.5
func (x *Config_Server_TLS) GetKeyFile() string
func (*Config_Server_TLS) ProtoMessage ¶ added in v3.2.5
func (*Config_Server_TLS) ProtoMessage()
func (*Config_Server_TLS) ProtoReflect ¶ added in v3.2.5
func (x *Config_Server_TLS) ProtoReflect() protoreflect.Message
func (*Config_Server_TLS) Reset ¶ added in v3.2.5
func (x *Config_Server_TLS) Reset()
func (*Config_Server_TLS) String ¶ added in v3.2.5
func (x *Config_Server_TLS) String() string