Documentation
¶
Overview ¶
Package scanner exposes a golang source Scanner.
The Scanner scans the internal/assertions package.
It extracts all testify helpers methods, types, and package-level variables and constants.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option func(*options)
func WithCollectDoc ¶
WithCollectDoc indicates that the scanner should extract more information from comments.
func WithPackage ¶
WithPackage indicates which package is scanned.
func WithWorkDir ¶
WithWorkDir gives a workdir to the code scanner.
type Scanner ¶
type Scanner struct {
// contains filtered or unexported fields
}
Scanner scans the internal/assertions package and extracts all functions, types, and metadata.
func (*Scanner) Scan ¶
func (s *Scanner) Scan() (*model.AssertionPackage, error)
Scan a source package an returns a model.AssertionPackage data structure suited for code generation.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package comments provides utilities for extracting comments from Go source code.
|
Package comments provides utilities for extracting comments from Go source code. |
|
Package parser provides text parsing utilities for extracting structured information from comments.
|
Package parser provides text parsing utilities for extracting structured information from comments. |
|
Package signature provides utilities for extracting and formatting Go function signatures and types.
|
Package signature provides utilities for extracting and formatting Go function signatures and types. |
Click to show internal directories.
Click to hide internal directories.