prioritize readme.md

Author: wewark

modules/markup/markup.go

@@ -112,8 +112,11 @@ func IsMarkupFile(name, markup string) bool {
 
 // IsReadmeFile reports whether name looks like a README file
 // based on its name.
-func IsReadmeFile(name string) bool {
+func IsReadmeFile(name string, strict bool) bool {
 	name = strings.ToLower(name)
+	if strict {
+		return name == "readme.md"
+	}
 	if len(name) < 6 {
 		return false
 	} else if len(name) == 6 {

modules/markup/markup_test.go

@@ -32,9 +32,9 @@ func TestMisc_IsReadmeFile(t *testing.T) {
 	}
 
 	for _, testCase := range trueTestCases {
-		assert.True(t, IsReadmeFile(testCase))
+		assert.True(t, IsReadmeFile(testCase, false))
 	}
 	for _, testCase := range falseTestCases {
-		assert.False(t, IsReadmeFile(testCase))
+		assert.False(t, IsReadmeFile(testCase, false))
 	}
 }

routers/repo/view.go

@@ -62,13 +62,13 @@ func renderDirectory(ctx *context.Context, treeLink string) {
 			continue
 		}
 
-		if !markup.IsReadmeFile(entry.Name()) {
-			continue
+		if markup.IsReadmeFile(entry.Name(), true) {
+			readmeFile = entry.Blob()
+			break
 		}
 
-		readmeFile = entry.Blob()
-		if markup.Type(entry.Name()) != "" {
-			break
+		if markup.IsReadmeFile(entry.Name(), false) {
+			readmeFile = entry.Blob()
 		}
 	}
 
@@ -207,7 +207,7 @@ func renderFile(ctx *context.Context, entry *git.TreeEntry, treeLink, rawLink st
 		d, _ := ioutil.ReadAll(dataRc)
 		buf = templates.ToUTF8WithFallback(append(buf, d...))
 
-		readmeExist := markup.IsReadmeFile(blob.Name())
+		readmeExist := markup.IsReadmeFile(blob.Name(), false)
 		ctx.Data["ReadmeExist"] = readmeExist
 		if markup.Type(blob.Name()) != "" {
 			ctx.Data["IsMarkup"] = true