helpers

package

v0.1.1-0...-c17c15d Latest Latest Go to latest Published: Apr 29, 2019 License: Unlicense Imports: 16 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/unjello/belit

Links

Open Source Insights

Documentation ¶

Overview ¶

andrzej lichnerowicz, unlicensed (~public domain)

Index ¶

Variables
func DownloadRemote(baseDir string, url string) error
func EnsureDirectory(baseDir string) error
func ExtractModelineOptions(buffer string) (map[string]string, error)
func FileExists(name string) error
func GetFileContents(name string) ([]byte, error)
func GetTempFile() (string, error)
func PrintCommand(command []string, isDebug bool) error
func RemoveFile(name string) error
func RunCommand(command []string) (string, string, error)
type CompilerOptions
- func GetCompilerOptions(filename string) (CompilerOptions, error)
type SourceInfo
- func GetSources(file string) ([]SourceInfo, error)
- func GetSourcesFromBuffer(buffer []byte) ([]SourceInfo, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrCouldNotCreateDirectory     = errors.New("belit/fs: could not create directory")
	ErrCouldNotCreateTemporaryFile = errors.New("belit/fs: could not create temporary file")
	ErrFileDoesNotExist            = errors.New("belit/fs: file does not exist")
	ErrCouldNotReadFile            = errors.New("belit/fs: could not read file")
)

View Source

var (
	ErrCouldNotOpenFile     = errors.New("belit/parser: could not open file for reading")
	ErrCouldNotCloseScanner = errors.New("belit/parser: could not close scanner")
)

View Source

var AppFS = afero.NewOsFs()

View Source

var (
	ErrorModelineNotFound = errors.New("modeline not found")
)

Functions ¶

func DownloadRemote ¶

func DownloadRemote(baseDir string, url string) error

func EnsureDirectory ¶

func EnsureDirectory(baseDir string) error

TODO: add error return

func ExtractModelineOptions ¶

func ExtractModelineOptions(buffer string) (map[string]string, error)

ExtractModelineOptions searches throght the file in search of vim's [modeline](http://vimdoc.sourceforge.net/htmldoc/options.html#modeline) compatibile options

func FileExists ¶

func FileExists(name string) error

func GetFileContents ¶

func GetFileContents(name string) ([]byte, error)

func GetTempFile ¶

func GetTempFile() (string, error)

func PrintCommand ¶

func PrintCommand(command []string, isDebug bool) error

func RemoveFile ¶

func RemoveFile(name string) error

func RunCommand ¶

func RunCommand(command []string) (string, string, error)

Types ¶

type CompilerOptions ¶

type CompilerOptions struct {
	CompilerEnv        string
	CompilerOptionsEnv string
}

CompilerOptions holds names of environments to look at based on file type (extension)

func GetCompilerOptions ¶

func GetCompilerOptions(filename string) (CompilerOptions, error)

GetCompilerOptions returns set of names to corresponding options based on file type

type SourceInfo ¶

type SourceInfo struct {
	RepositoryPath string
	HeaderName     string
}

func GetSources ¶

func GetSources(file string) ([]SourceInfo, error)

func GetSourcesFromBuffer ¶

func GetSourcesFromBuffer(buffer []byte) ([]SourceInfo, error)

Source Files ¶

View all Source files

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