mgdelacroix/gitssg
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Adds readme, license and contributing parsing

Browse source
This commit is contained in:
Miguel de la Cruz 2024-07-14 12:02:48 +02:00
parent 741709c8d5
commit a7de71882f
1 changed files with 36 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
gitssg.go
View file

@ -27,12 +27,12 @@ type RepoDir struct {
// ToDo: replace has* with the filename, as it can be bare or .md // ToDo: replace has* with the filename, as it can be bare or .md
type RepoInfo struct { type RepoInfo struct {
Name string Name string
Description string Description string
Url string Url string
HasReadme bool Readme string
HasLicense bool License string
HasContributing bool Contributing string
} }
type CommitFile struct { type CommitFile struct {
@ -69,6 +69,9 @@ type CommitInfo struct {
var embedTmpl embed.FS var embedTmpl embed.FS
var timeShortFormatStr = "2006-01-02 15:04" var timeShortFormatStr = "2006-01-02 15:04"
var timeLongFormatStr = time.RFC1123 var timeLongFormatStr = time.RFC1123
var readmeNames = []string{"README", "README.md", "README.txt"}
var licenseNames = []string{"LICENSE", "LICENSE.txt"}
var contributingNames = []string{"CONTRIBUTING", "CONTRIBUTING.txt"}
var funcMap = template.FuncMap{ var funcMap = template.FuncMap{
"inc": func(i int) int { "inc": func(i int) int {
return i + 1 return i + 1
@ -78,16 +81,16 @@ var funcMap = template.FuncMap{
menu += " | <a href=\"" + relpath + "files.html\">Files</a>" menu += " | <a href=\"" + relpath + "files.html\">Files</a>"
menu += " | <a href=\"" + relpath + "refs.html\">Refs</a>" menu += " | <a href=\"" + relpath + "refs.html\">Refs</a>"
if repoInfo.HasReadme { if repoInfo.Readme != "" {
menu += "| <a href=\"" + relpath + "file/README.html\">README</a>" menu += " | <a href=\"" + relpath + "file/" + repoInfo.Readme + ".html\">README</a>"
} }
if repoInfo.HasLicense { if repoInfo.License != "" {
menu += "| <a href=\"" + relpath + "file/LICENSE.html\">LICENSE</a>" menu += " | <a href=\"" + relpath + "file/" + repoInfo.License + ".html\">LICENSE</a>"
} }
if repoInfo.HasContributing { if repoInfo.Contributing != "" {
menu += "| <a href=\"" + relpath + "file/CONTRIBUTING.html\">CONTRIBUTING</a>" menu += " | <a href=\"" + relpath + "file/" + repoInfo.Contributing + ".html\">CONTRIBUTING</a>"
} }
return template.HTML(menu) return template.HTML(menu)
@ -271,7 +274,27 @@ func generateRepo(path string, logLimit int) error {
return fmt.Errorf("cannot get commit for hash %s: %w", head.Hash(), err) return fmt.Errorf("cannot get commit for hash %s: %w", head.Hash(), err)
} }
// ToDo: populate hasReadme, hasLicense and hasContributing // populate Readme, License and Contributing
for _, name := range readmeNames {
if _, err := c.File(name); err == nil {
repoInfo.Readme = name
break
}
}
for _, name := range licenseNames {
if _, err := c.File(name); err == nil {
repoInfo.License = name
break
}
}
for _, name := range contributingNames {
if _, err := c.File(name); err == nil {
repoInfo.Contributing = name
break
}
}
tree, err := c.Tree() tree, err := c.Tree()
if err != nil { if err != nil {