rust

Documentation

Index

• type Language
  • func (l *Language) DefaultFileExtension() string
  • func (l *Language) DefaultTestFileSuffix() string
  • func (l *Language) ExecuteTests(logger *log.Logger, repositoryPath string) (testResult *language.TestResult, problems []error, err error)
  • func (l *Language) Files(logger *log.Logger, repositoryPath string) (filePaths []string, err error)
  • func (l *Language) ID() (id string)
  • func (l *Language) ImportPath(projectRootPath string, filePath string) (importPath string)
  • func (l *Language) Mistakes(logger *log.Logger, repositoryPath string) (mistakes []string, err error)
  • func (l *Language) Name() (id string)
  • func (l *Language) SupportsFix() bool
  • func (l *Language) SupportsTemplate() bool
  • func (l *Language) TestFilePath(projectRootPath string, filePath string) (testFilePath string)
  • func (l *Language) TestFramework() (testFramework string)

Types

type Language

type Language struct{}

Language holds a Rust language to evaluate a repository.

func (*Language) DefaultFileExtension

func (l *Language) DefaultFileExtension() string

DefaultFileExtension returns the default file extension.

func (*Language) DefaultTestFileSuffix

func (l *Language) DefaultTestFileSuffix() string

DefaultTestFileSuffix returns the default test file suffix.

func (*Language) ExecuteTests

func (l *Language) ExecuteTests(logger *log.Logger, repositoryPath string) (testResult *language.TestResult, problems []error, err error)

ExecuteTests invokes the language specific testing on the given repository.

func (*Language) Files

func (l *Language) Files(logger *log.Logger, repositoryPath string) (filePaths []string, err error)

Files returns a list of relative file paths of the repository that should be evaluated.

func (*Language) ID

func (l *Language) ID() (id string)

ID returns the unique ID of this language.

func (*Language) ImportPath

func (l *Language) ImportPath(projectRootPath string, filePath string) (importPath string)

ImportPath returns the import path of the given source file.

func (*Language) Mistakes

func (l *Language) Mistakes(logger *log.Logger, repositoryPath string) (mistakes []string, err error)

Mistakes builds a Rust repository and returns the list of mistakes found.

func (*Language) Name

func (l *Language) Name() (id string)

Name is the prose name of this language.

func (*Language) SupportsFix

func (l *Language) SupportsFix() bool

SupportsFix reports if the language is supported by "symflower fix".

func (*Language) SupportsTemplate

func (l *Language) SupportsTemplate() bool

SupportsTemplate reports if the language is supported by "symflower unit-test-skeleton".

func (*Language) TestFilePath

func (l *Language) TestFilePath(projectRootPath string, filePath string) (testFilePath string)

TestFilePath returns the file path of a test file given the corresponding file path of the test's source file.

func (*Language) TestFramework

func (l *Language) TestFramework() (testFramework string)

TestFramework returns the human-readable name of the test framework that should be used.