Skip to content

Should also support upper-case README files #20581

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 1, 2022
Merged

Should also support upper-case README files #20581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e64af75
Should also support upper-case README files
BLumia Aug 1, 2022
b5960e2
Merge branch 'main' into fix-reg-20508
lunny Aug 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions modules/markup/renderer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,11 +328,13 @@ func IsReadmeFile(name string) bool {
// the length of the provided extension list.
// Note that the '.' should be provided in ext, e.g ".md"
func IsReadmeFileExtension(name string, ext ...string) (int, bool) {
name = strings.ToLower(name)
if len(name) < 6 || name[:6] != "readme" {
return 0, false
}

for i, extension := range ext {
extension = strings.ToLower(extension)
if name[6:] == extension {
return i, true
}
Expand Down
10 changes: 10 additions & 0 deletions modules/markup/renderer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,16 @@ func TestMisc_IsReadmeFile(t *testing.T) {
expected: true,
idx: 0,
},
{
name: "README.md",
expected: true,
idx: 0,
},
{
name: "ReAdMe.Md",
expected: true,
idx: 0,
},
{
name: "readme.txt",
expected: true,
Expand Down