Allow hidden repositories (#13)

leighmcculloch · Jan 31, 2022 · bc7c053 · bc7c053
1 parent 2833fc5
commit bc7c053
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -99,6 +99,7 @@ The repository `type` and `source` properties will be set automatically when `ur
         "template"
       ],
       "type": "git",
+      "hidden": false,
       "url": "https://github.com/leighmcculloch/go-optional",
       "source": {
         "home": "https://github.com/leighmcculloch/go-optional",
@@ -112,4 +113,3 @@ The repository `type` and `source` properties will be set automatically when `ur
   ]
 }
 ```
-
diff --git a/config.go b/config.go
@@ -21,6 +21,7 @@ type repository struct {
 	Type       string     `json:"type"`
 	URL        string     `json:"url"`
 	Main       bool       `json:"main"`
+	Hidden     bool       `json:"hidden"`
 	SourceURLs sourceURLs `json:"source"`
 	Website    website    `json:"website"`
 }

diff --git a/generate_index.go b/generate_index.go
@@ -39,14 +39,14 @@ body { margin-top: 0; }
 <h3>Libraries:</h3>
 
 <ul>
-{{range $_, $r := .PackageRepositories -}}
+{{range $_, $r := .PackageRepositories -}}{{if not $r.Hidden -}}
 <li>
 <a href="/{{$r.Prefix}}">{{$r.Prefix}}</a>
 {{if .Subs -}}<ul>{{end -}}
 {{range $_, $s := .Subs -}}{{if not $s.Hidden -}}<li><a href="/{{$r.Prefix}}/{{$s.Name}}">{{$s.Name}}</a></li>{{end -}}{{end -}}
 {{if .Subs -}}</ul>{{end -}}
 </li>
-{{end -}}
+{{end }}{{end -}}
 </ul>
 
 <hr/>

diff --git a/generate_index_test.go b/generate_index_test.go
@@ -28,6 +28,10 @@ func TestGenerateIndex(t *testing.T) {
 					Prefix: "pkg2",
 					Subs:   []sub{{Name: "subpkg1"}, {Name: "subpkg2/subsubpkg1"}},
 				},
+				{
+					Prefix: "pkg3",
+					Hidden: true,
+				},
 			},
 			expectedOut: `<!DOCTYPE html>
 <html>

diff --git a/generate_package_test.go b/generate_package_test.go
@@ -52,6 +52,45 @@ Home: <a href="https://godoc.org/example.com/pkg1">https://godoc.org/example.com
 Source: <a href="https://repositoryhost.com/example/go-pkg1">https://repositoryhost.com/example/go-pkg1</a><br/>
 Sub-packages:<ul><li><a href="/pkg1/subpkg1">example.com/pkg1/subpkg1</a></li><li><a href="/pkg1/subpkg2">example.com/pkg1/subpkg2</a></li></ul></div>
 </body>
+</html>`,
+			expectedErr: nil,
+		},
+		{
+			description: "hidden",
+			domain:      "example.com",
+			docsDomain:  "godoc.org",
+			pkg:         "pkg1",
+			r: repository{
+				Prefix: "pkg1",
+				Hidden: true,
+				Subs:   []sub{{Name: "subpkg1"}, {Name: "subpkg2"}},
+				Type:   "git",
+				URL:    "https://repositoryhost.com/example/go-pkg1",
+			},
+			expectedOut: `<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+<title>example.com/pkg1</title>
+<meta name="go-import" content="example.com/pkg1 git https://repositoryhost.com/example/go-pkg1">
+<meta name="go-source" content="example.com/pkg1 _ _ _">
+<style>
+* { font-family: sans-serif; }
+body { margin-top: 0; }
+.content { display: inline-block; }
+code { display: block; font-family: monospace; font-size: 1em; background-color: #d5d5d5; padding: 1em; margin-bottom: 16px; }
+ul { margin-top: 16px; margin-bottom: 16px; }
+</style>
+</head>
+<body>
+<div class="content">
+<h2>example.com/pkg1</h2>
+<code>go get example.com/pkg1</code>
+<code>import "example.com/pkg1"</code>
+Home: <a href="https://godoc.org/example.com/pkg1">https://godoc.org/example.com/pkg1</a><br/>
+Source: <a href="https://repositoryhost.com/example/go-pkg1">https://repositoryhost.com/example/go-pkg1</a><br/>
+Sub-packages:<ul><li><a href="/pkg1/subpkg1">example.com/pkg1/subpkg1</a></li><li><a href="/pkg1/subpkg2">example.com/pkg1/subpkg2</a></li></ul></div>
+</body>
 </html>`,
 			expectedErr: nil,
 		},