From 1acd1691006755acda220a4208b2cf98203881e4 Mon Sep 17 00:00:00 2001 From: Fabio Bonelli Date: Thu, 12 Mar 2026 12:32:00 +0100 Subject: [PATCH] docs: add godoc example functions --- example_test.go | 54 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 example_test.go diff --git a/example_test.go b/example_test.go new file mode 100644 index 0000000..7477ffd --- /dev/null +++ b/example_test.go @@ -0,0 +1,54 @@ +package publiccode_test + +import ( + "fmt" + "strings" + + publiccode "github.com/italia/publiccode-parser-go/v5" +) + +func ExampleNewDefaultParser() { + parser, err := publiccode.NewDefaultParser() + if err != nil { + panic(err) + } + + _, err = parser.Parse("file:///path/to/publiccode.yml") + if err != nil { + fmt.Println(err) + } +} + +func ExampleNewParser_disableNetwork() { + parser, err := publiccode.NewParser(publiccode.ParserConfig{ + DisableNetwork: true, + }) + if err != nil { + panic(err) + } + + _, err = parser.Parse("file:///path/to/publiccode.yml") + if err != nil { + fmt.Println(err) + } +} + +func ExampleParser_ParseStream() { + yaml := ` +publiccodeYmlVersion: "0" +name: My Software +url: https://github.com/example/example +` + + parser, err := publiccode.NewParser(publiccode.ParserConfig{ + DisableNetwork: true, + }) + if err != nil { + panic(err) + } + + _, err = parser.ParseStream(strings.NewReader(yaml)) + if err != nil { + fmt.Println(err) + } +}