mirror
/
pkger
mirror of https://github.com/markbates/pkger.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

Updating documentation to reflect the paths generated without the hepa library

This commit is contained in:
Neil Skinner 2020-06-10 09:31:24 -04:00
parent 143afe6a94
commit c78e87acb0
1 changed files with 20 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -24,9 +24,10 @@ Paths:
* Packages can specified in at the beginning of a path with a `:` seperator. * Packages can specified in at the beginning of a path with a `:` seperator.
github.com/markbates/pkger:/cmd/pkger/main.go github.com/markbates/pkger:/cmd/pkger/main.go
* There are no relative paths. All paths are absolute to the modules root. * There are no relative paths. All paths are absolute to the modules root.
* Fully-qualified paths are embedded into the metadata of your static assets. If this behavior is undesirable, a preference is to build in a containerized environ, like docker, where the path strings are not ex-filtrating data about your development environment.
``` ```
"github.com/gobuffalo/buffalo:/go.mod" => $GOPATH/pkg/mod/github.com/gobuffalo/buffalo@v0.14.7/go.mod "github.com/gobuffalo/buffalo:/go.mod" => /go/pkg/mod/github.com/gobuffalo/buffalo@v0.14.7/go.mod
``` ```
## CLI ## CLI
@ -284,26 +285,26 @@ $ pkger parse
".": [ ".": [
{ {
"file": { "file": {
"Abs": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/foo/bar/baz", "Abs": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/foo/bar/baz",
"Path": { "Path": {
"Pkg": "app", "Pkg": "app",
"Name": "/foo/bar/baz" "Name": "/foo/bar/baz"
}, },
"Here": { "Here": {
"Dir": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref", "Dir": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref",
"ImportPath": "app", "ImportPath": "app",
"Module": { "Module": {
"Path": "app", "Path": "app",
"Main": true, "Main": true,
"Dir": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref", "Dir": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref",
"GoMod": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/go.mod", "GoMod": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/go.mod",
"GoVersion": "1.13" "GoVersion": "1.13"
}, },
"Name": "main" "Name": "main"
} }
}, },
"pos": { "pos": {
"Filename": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/main.go", "Filename": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/main.go",
"Offset": 629, "Offset": 629,
"Line": 47, "Line": 47,
"Column": 27 "Column": 27
@ -313,26 +314,26 @@ $ pkger parse
}, },
{ {
"file": { "file": {
"Abs": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/foo/bar/baz/biz.txt", "Abs": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/foo/bar/baz/biz.txt",
"Path": { "Path": {
"Pkg": "app", "Pkg": "app",
"Name": "/foo/bar/baz/biz.txt" "Name": "/foo/bar/baz/biz.txt"
}, },
"Here": { "Here": {
"Dir": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref", "Dir": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref",
"ImportPath": "app", "ImportPath": "app",
"Module": { "Module": {
"Path": "app", "Path": "app",
"Main": true, "Main": true,
"Dir": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref", "Dir": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref",
"GoMod": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/go.mod", "GoMod": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/go.mod",
"GoVersion": "1.13" "GoVersion": "1.13"
}, },
"Name": "main" "Name": "main"
} }
}, },
"pos": { "pos": {
"Filename": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/main.go", "Filename": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/main.go",
"Offset": 706, "Offset": 706,
"Line": 51, "Line": 51,
"Column": 25 "Column": 25
@ -388,38 +389,38 @@ $ pkger list -json
"ImportPath": "app", "ImportPath": "app",
"Files": [ "Files": [
{ {
"Abs": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/assets", "Abs": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/assets",
"Path": { "Path": {
"Pkg": "app", "Pkg": "app",
"Name": "/assets" "Name": "/assets"
}, },
"Here": { "Here": {
"Dir": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/assets", "Dir": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/assets",
"ImportPath": "", "ImportPath": "",
"Module": { "Module": {
"Path": "app", "Path": "app",
"Main": true, "Main": true,
"Dir": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref", "Dir": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref",
"GoMod": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/go.mod", "GoMod": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/go.mod",
"GoVersion": "1.13" "GoVersion": "1.13"
}, },
"Name": "assets" "Name": "assets"
} }
}, },
{ {
"Abs": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/assets/css", "Abs": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/assets/css",
"Path": { "Path": {
"Pkg": "app", "Pkg": "app",
"Name": "/assets/css" "Name": "/assets/css"
}, },
"Here": { "Here": {
"Dir": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/assets", "Dir": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/assets",
"ImportPath": "", "ImportPath": "",
"Module": { "Module": {
"Path": "app", "Path": "app",
"Main": true, "Main": true,
"Dir": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref", "Dir": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref",
"GoMod": "$GOPATH/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/go.mod", "GoMod": "/go/src/github.com/markbates/pkger/pkging/pkgtest/testdata/ref/go.mod",
"GoVersion": "1.13" "GoVersion": "1.13"
}, },
"Name": "assets" "Name": "assets"