config

package

v0.10.1 Latest Latest Go to latest Published: Dec 5, 2023 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/vorlif/xspreak

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func IsValidSpreakPackage(pkg string) bool
func ShouldExtractPackage(pkg string) bool
func ShouldScanPackage(pkg string) bool
func ShouldScanStruct(pkg string) bool
type Config
- func NewDefault() *Config
- func (c *Config) Prepare() error

Constants ¶

View Source

const (
	ExtractFormatPot  = "pot"
	ExtractFormatJSON = "json"
)

View Source

const (
	SpreakPackagePath         = "github.com/vorlif/spreak"
	SpreakLocalizePackagePath = SpreakPackagePath + "/localize"
	XSpreakPackagePath        = SpreakPackagePath + "/xspreak"
)

Variables ¶

This section is empty.

Functions ¶

func IsValidSpreakPackage ¶

func IsValidSpreakPackage(pkg string) bool

func ShouldExtractPackage ¶

func ShouldExtractPackage(pkg string) bool

func ShouldScanPackage ¶

func ShouldScanPackage(pkg string) bool

func ShouldScanStruct ¶

func ShouldScanStruct(pkg string) bool

Types ¶

type Config ¶

type Config struct {
	IsVerbose       bool
	CurrentDir      string
	SourceDir       string
	OutputDir       string
	OutputFile      string
	CommentPrefixes []string
	ExtractErrors   bool
	ErrorContext    string

	TemplatePatterns []string
	Keywords         []*tmpl.Keyword

	DefaultDomain   string
	WriteNoLocation bool
	WrapWidth       int
	DontWrap        bool

	OmitHeader      bool
	CopyrightHolder string
	PackageName     string
	BugsAddress     string

	MaxDepth int
	Args     []string

	Timeout time.Duration

	ExtractFormat     string
	TmplIsMonolingual bool
}

func NewDefault ¶

func NewDefault() *Config

func (*Config) Prepare ¶

func (c *Config) Prepare() error

Source Files ¶

View all Source files

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