add special case for handling go-get queries
6 files changed, 146 insertions(+), 2 deletions(-)
M internal/builder/builder.go → internal/builder/builder.go
@@ -255,6 +255,25 @@ return fault.Wrap(err) } } + log.Debug("rendering go packages") + for _, p := range config.Go.Packages { + buf.Reset() + if err := templates.GoPackagePage(siteSettings, &config.Go, p).Render(buf); err != nil { + return fault.Wrap(err) + } + if err := storage.Write(fmt.Sprintf("/go/%s", p), siteSettings.Title, buf); err != nil { + return fault.Wrap(err) + } + } + + buf.Reset() + if err := templates.GoPackageListPage(siteSettings, &config.Go).Render(buf); err != nil { + return fault.Wrap(err) + } + if err := storage.Write("/go/", siteSettings.Title, buf); err != nil { + return fault.Wrap(err) + } + return nil }
M internal/config/config.go → internal/config/config.go
@@ -53,6 +53,12 @@ return fault.Wrap(err, fmsg.With(fmt.Sprintf("could not parse timezone %s", string(text)))) } +type GoPackagesConfig struct { + Domain URL + Forge URL + Packages []string +} + type Config struct { Title string Email string@@ -76,6 +82,8 @@ Taxonomies []Taxonomy Menu []MenuItem RelMe []MenuItem `toml:"rel_me"` + + Go GoPackagesConfig } func GetConfig(dir string, log *log.Logger) (*Config, error) {
M internal/website/mux.go → internal/website/mux.go
@@ -46,7 +46,11 @@ } } func (website *Website) ServeHTTP(w http.ResponseWriter, r *http.Request) *ihttp.Error { - urlPath, shouldRedirect := website.reader.CanonicalisePath(r.URL.Path) + urlPath := r.URL.Path + if r.URL.Query().Has("go-get") && r.URL.Query().Get("go-get") == "1" { + urlPath = "/go" + r.URL.Path + } + urlPath, shouldRedirect := website.reader.CanonicalisePath(urlPath) if shouldRedirect { website.counter.Count(r, "302") http.Redirect(w, r, urlPath, http.StatusFound)
M internal/website/website.go → internal/website/website.go
@@ -61,7 +61,7 @@ var CSPHeader = csp.Header{ DefaultSrc: []string{"'none'"}, FormAction: []string{"'none'"}, BaseURI: []string{"'none'"}, - ImgSrc: []string{"'self'"}, + ImgSrc: []string{"'self'", "https://pkg.go.dev/"}, ScriptSrc: []string{"'self'"}, StyleSrc: []string{"'self'"}, FrameAncestors: []string{"https://kagi.com"},
A templates/gopkg.go
@@ -0,0 +1,111 @@ +package templates + +import ( + "fmt" + "net/url" + + g "go.alanpearce.eu/gomponents" + . "go.alanpearce.eu/gomponents/html" + "go.alanpearce.eu/homestead/internal/config" +) + +type GoPackageVars struct { + Package string + Domain config.URL + Forge config.URL +} + +func GoPackageListPage(site SiteSettings, cfg *config.GoPackagesConfig) g.Node { + return Layout(site, PageSettings{ + Title: site.Title, + TitleAttrs: Attrs{"class": "p-author h-card"}, + }, + Table( + THead( + Tr( + Th(g.Text("Name")), + Th(g.Text("Source")), + Th(g.Text("Documentation")), + ), + ), + TBody( + g.Map(cfg.Packages, func(pkg string) g.Node { + return Tr( + Td(g.Text(packageImportPath(cfg, pkg))), + Td(A(Href(packageForgeURL(cfg, pkg)), g.Text("Source"))), + Td(GodocBadge(cfg, pkg)), + ) + }), + ), + ), + ) +} + +func GoPackagePage(site SiteSettings, cfg *config.GoPackagesConfig, pkg string) g.Node { + return Layout(site, PageSettings{ + Title: site.Title, + TitleAttrs: Attrs{"class": "p-author h-card"}, + HeadExtra: g.Group{ + Meta(Name("go-import"), Content(importString(cfg, pkg))), + Meta(Name("go-source"), Content(sourceString(cfg, pkg))), + }, + }, + Div( + P( + g.Text("You're probably looking for the "), + A(Href(godocURL(cfg, pkg)), g.Text("documentation")), + g.Text(" or the "), + A(Href(packageForgeURL(cfg, pkg)), g.Text("source")), + g.Text("."), + ), + GodocBadge(cfg, pkg), + ), + ) +} + +func GodocBadge(cfg *config.GoPackagesConfig, pkg string) g.Node { + return A(Href(godocURL(cfg, pkg)), + Img( + Alt("Go Reference"), + Src(badgeURL(cfg, pkg)+".svg"), + ), + ) +} + +func must[T any](t T, err error) T { + if err != nil { + panic(err) + } + return t +} + +func importString(cfg *config.GoPackagesConfig, pkg string) string { + return fmt.Sprintf("%s git %s", + cfg.Domain.JoinPath(pkg), + cfg.Forge.JoinPath(pkg), + ) +} + +func sourceString(cfg *config.GoPackagesConfig, pkg string) string { + return fmt.Sprintf("%s _ %s %s", + cfg.Domain.JoinPath(pkg), + cfg.Forge.JoinPath(pkg).String()+"/tree/main/{dir}", + cfg.Forge.JoinPath(pkg).String()+"/tree/main/{dir}/{file}#n{line}", + ) +} + +func godocURL(cfg *config.GoPackagesConfig, pkg string) string { + return must(url.JoinPath("https://pkg.go.dev", packageImportPath(cfg, pkg))) +} + +func badgeURL(cfg *config.GoPackagesConfig, pkg string) string { + return must(url.JoinPath("https://pkg.go.dev/badge/", packageImportPath(cfg, pkg))) +} + +func packageImportPath(cfg *config.GoPackagesConfig, pkg string) string { + return cfg.Domain.JoinPath(pkg).String() +} + +func packageForgeURL(cfg *config.GoPackagesConfig, pkg string) string { + return cfg.Forge.JoinPath(pkg).String() +}
M templates/layout.go → templates/layout.go
@@ -25,6 +25,7 @@ type PageSettings struct { Title string TitleAttrs Attrs BodyAttrs Attrs + HeadExtra []g.Node } func ExtendAttrs(base Attrs, attrs Attrs) g.Node {@@ -60,6 +61,7 @@ Type("application/atom+xml"), Title(site.Title), Href("/atom.xml"), ), + g.Group(page.HeadExtra), ), Body( ExtendAttrs(page.BodyAttrs, nil),