language

package
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 15, 2023 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// Go language parser const
	Go = "go"
)

Variables

This section is empty.

Functions

func IsSupportedLanguage

func IsSupportedLanguage(input string) bool

IsSupportedLanguage is returns true if the input is a supported language

Types

type Target

type Target interface {
	// ParseSource parses the data source for @fyi annotations and returns an error manifest if successfully parsed.
	// Returns error if the parsing process fails
	ParseSource(ctx context.Context, content io.Reader) (*api.Manifest, error)
	// ParseAllSources parses the included directories for @fyi annotations and returns an error manifest if successfully parsed.
	// Returns error if the parsing process fails
	ParseAllSources(ctx context.Context) ([]*api.Manifest, error)
	// AnnotateAllErrors annotates all errors in the included directories with fyi comments and error wrapping
	AnnotateAllErrors(ctx context.Context, wrapErrors, annotateOnlyTodos bool) error
	// AnnotateSourceErrors annotates all errors in the content with fyi comments and error wrapping
	AnnotateSourceErrors(ctx context.Context, filename string, wrapErrors, annotateOnlyTodos bool) error
}

Target is the source code language the parser should parse.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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