Tonis Tiigi
4880756a0f
Unify root/material unknown resolution with recursive Input traversal. Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
75 lines
2.0 KiB
Markdown
75 lines
2.0 KiB
Markdown
# packageurl-go
|
|
|
|
[](https://github.com/package-url/packageurl-go/actions?query=workflow%3Atest) [](https://coveralls.io/github/package-url/packageurl-go) [](https://pkg.go.dev/github.com/package-url/packageurl-go) [](https://goreportcard.com/report/github.com/package-url/packageurl-go)
|
|
|
|
Go implementation of the package url spec.
|
|
|
|
|
|
## Install
|
|
```
|
|
go get -u github.com/package-url/packageurl-go
|
|
```
|
|
|
|
## Versioning
|
|
|
|
The versions will follow the spec. So if the spec is released at ``1.0``. Then all versions in the ``1.x.y`` will follow the ``1.x`` spec.
|
|
|
|
|
|
## Usage
|
|
|
|
### Create from parts
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/package-url/packageurl-go"
|
|
)
|
|
|
|
func main() {
|
|
instance := packageurl.NewPackageURL("test", "ok", "name", "version", nil, "")
|
|
fmt.Printf("%s", instance.ToString())
|
|
}
|
|
```
|
|
|
|
### Parse from string
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/package-url/packageurl-go"
|
|
)
|
|
|
|
func main() {
|
|
instance, err := packageurl.FromString("test:ok/name@version")
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
fmt.Printf("%#v", instance)
|
|
}
|
|
|
|
```
|
|
|
|
|
|
## Test
|
|
Testing using the normal ``go test`` command. Using ``make test`` will pull the test fixtures shared between all package-url projects and then execute the tests.
|
|
|
|
```
|
|
$ make test
|
|
go test -v -cover ./...
|
|
=== RUN TestFromStringExamples
|
|
--- PASS: TestFromStringExamples (0.00s)
|
|
=== RUN TestToStringExamples
|
|
--- PASS: TestToStringExamples (0.00s)
|
|
=== RUN TestStringer
|
|
--- PASS: TestStringer (0.00s)
|
|
=== RUN TestQualifiersMapConversion
|
|
--- PASS: TestQualifiersMapConversion (0.00s)
|
|
PASS
|
|
coverage: 90.7% of statements
|
|
ok github.com/package-url/packageurl-go 0.004s coverage: 90.7% of statements
|
|
```
|