fileparser

package

v1.0.1 Latest Latest Go to latest Published: Jul 22, 2025 License: Apache-2.0 Imports: 14 Imported by: 0

Details

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

Repository

github.com/flowexec/flow

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ApplyExecConfig(exec *executable.Executable, result *ParseResult) error
func ExecutablesFromDockerCompose(wsPath, path string) (executable.ExecutableList, error)
func ExecutablesFromImports(logger io.Logger, wsName string, flowFile *executable.FlowFile) (executable.ExecutableList, error)
func ExecutablesFromMakefile(wsPath, path string) (executable.ExecutableList, error)
func ExecutablesFromPackageJSON(wsPath, path string) (executable.ExecutableList, error)
func ExecutablesFromShFile(wsPath, filePath string) (*executable.Executable, error)
func InferVerb(name string) executable.Verb
func NormalizeName(name, verb string) string
type ParseResult
- func ExtractExecConfig(data, prefix string) (*ParseResult, error)

Constants ¶

View Source

const (
	TimeoutConfigurationKey     = "timeout"
	VerbConfigurationKey        = "verb"
	NameConfigurationKey        = "name"
	AliasConfigurationKey       = "alias"
	DescriptionConfigurationKey = "description"
	VisibilityConfigurationKey  = "visibility"
	TagConfigurationKey         = "tag"
	ParamConfigurationKey       = "param"
	ArgConfigurationKey         = "arg"
	DirConfigurationKey         = "dir"
	LogModeConfigurationKey     = "logmode"

	InternalListSeparator  = "|"
	InternalValueSeparator = ":"
)

Variables ¶

This section is empty.

Functions ¶

func ApplyExecConfig ¶ added in v1.0.1

func ApplyExecConfig(exec *executable.Executable, result *ParseResult) error

func ExecutablesFromDockerCompose ¶ added in v1.0.1

func ExecutablesFromDockerCompose(wsPath, path string) (executable.ExecutableList, error)

ExecutablesFromDockerCompose parses a docker-compose.yml and returns list of Executables for the services

func ExecutablesFromImports ¶ added in v1.0.1

func ExecutablesFromImports(
	logger io.Logger, wsName string, flowFile *executable.FlowFile,
) (executable.ExecutableList, error)

func ExecutablesFromMakefile ¶ added in v1.0.1

func ExecutablesFromMakefile(wsPath, path string) (executable.ExecutableList, error)

ExecutablesFromMakefile parses a Makefile and returns a list of Executables for each makeTarget

func ExecutablesFromPackageJSON ¶ added in v1.0.1

func ExecutablesFromPackageJSON(wsPath, path string) (executable.ExecutableList, error)

ExecutablesFromPackageJSON parses package.json scripts and returns a list of Executables for them

func ExecutablesFromShFile ¶ added in v1.0.1

func ExecutablesFromShFile(wsPath, filePath string) (*executable.Executable, error)

func InferVerb ¶ added in v1.0.1

func InferVerb(name string) executable.Verb

InferVerb infers the most likely Executable verb from a script or makeTarget name.

func NormalizeName ¶ added in v1.0.1

func NormalizeName(name, verb string) string

NormalizeName strips any character that is not a letter, number, dash, or underscore, and also removes the verb prefix from the name if present.

Types ¶

type ParseResult ¶ added in v1.0.1

type ParseResult struct {
	SimpleFields map[string]string
	Params       executable.ParameterList
	Args         executable.ArgumentList
}

func ExtractExecConfig ¶ added in v1.0.1

func ExtractExecConfig(data, prefix string) (*ParseResult, error)

Source Files ¶

View all Source files

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