snippet

README

snippet

testing Go files with snippets

Documentation

Overview

Package snippet compare snippets in golang file.

Snippets lines without specific upcase/lower case of letters. Name of snippet is single word.

Format of snippet:

// Snippet Name
some code
// End Name

Index

• Variables
• func Compare(actualFilename, expectFilename string, diffOnly bool) (err error)
• func Test(t interface{ ... }, folder string)
• type Position
  • func (p Position) String() string
• type Snippet
  • func Get(filename string) (snippets []Snippet, err error)
  • func (s Snippet) String() string

Variables

var ExpectSnippets = "./expect.snippets"

ExpectSnippets is location of expect snippets

var SuffixFiles = []string{".go"}

SuffixFiles store list of acceptable fileformat

Functions

func Compare

func Compare(
	actualFilename, expectFilename string,
	diffOnly bool,
) (err error)

Compare snippers from expectFilenames and files/folders from actualFilename

func Test

func Test(t interface {
	Errorf(format string, args ...any)
	Logf(format string, args ...any)
}, folder string)

Test and update snippets in all acceptable files in `folder` with subfolders. Location with expected snippets in file "ExpectSnippets"

for update snippets run in console: UPDATE=true go test or see package `compare`

Types

type Position

type Position struct {
	Filename string
	Line     int
}

Position line of code

func (Position) String

func (p Position) String() string

type Snippet

type Snippet struct {
	Name       string
	Start, End Position
	Code       []string
}

Snippet inside code

func Get

func Get(filename string) (snippets []Snippet, err error)

Get snippets from `filename` and it is folder or file

func (Snippet) String

func (s Snippet) String() string