Skip to content
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.

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

fix: check other possible readme paths/branches #450

Merged
merged 5 commits into from
Jul 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 16 additions & 13 deletions github.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package main

import (
"errors"
"fmt"
"net/http"
"net/url"
"strings"
Expand Down Expand Up @@ -29,19 +30,21 @@ func findGitHubREADME(s string) (*source, error) {
}
u.Host = "raw.githubusercontent.com"

for _, r := range readmeNames {
v := u
v.Path += "/master/" + r

// nolint:bodyclose
// it is closed on the caller
resp, err := http.Get(v.String())
if err != nil {
return nil, err
}

if resp.StatusCode == http.StatusOK {
return &source{resp.Body, v.String()}, nil
for _, b := range readmeBranches {
for _, r := range readmeNames {
v := *u
v.Path += fmt.Sprintf("/%s/%s", b, r)

// nolint:bodyclose
// it is closed on the caller
resp, err := http.Get(v.String())
if err != nil {
return nil, err
}

if resp.StatusCode == http.StatusOK {
return &source{resp.Body, v.String()}, nil
}
}
}

Expand Down
29 changes: 16 additions & 13 deletions gitlab.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package main

import (
"errors"
"fmt"
"net/http"
"net/url"
"strings"
Expand All @@ -28,19 +29,21 @@ func findGitLabREADME(s string) (*source, error) {
return nil, err
}

for _, r := range readmeNames {
v := u
v.Path += "/raw/master/" + r

// nolint:bodyclose
// it is closed on the caller
resp, err := http.Get(v.String())
if err != nil {
return nil, err
}

if resp.StatusCode == http.StatusOK {
return &source{resp.Body, v.String()}, nil
for _, b := range readmeBranches {
for _, r := range readmeNames {
v := *u
v.Path += fmt.Sprintf("/raw/%s/%s", b, r)

// nolint:bodyclose
// it is closed on the caller
resp, err := http.Get(v.String())
if err != nil {
return nil, err
}

if resp.StatusCode == http.StatusOK {
return &source{resp.Body, v.String()}, nil
}
}
}

Expand Down
19 changes: 10 additions & 9 deletions glow_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,16 @@ func TestGlowSources(t *testing.T) {
}

for _, v := range tt {
buf := &bytes.Buffer{}
err := executeArg(rootCmd, v, buf)

if err != nil {
t.Errorf("Error during execution (args: %s): %v", v, err)
}
if buf.Len() == 0 {
t.Errorf("Output buffer should not be empty (args: %s)", v)
}
t.Run(v, func(t *testing.T) {
buf := &bytes.Buffer{}
err := executeArg(rootCmd, v, buf)
if err != nil {
t.Errorf("Error during execution (args: %s): %v", v, err)
}
if buf.Len() == 0 {
t.Errorf("Output buffer should not be empty (args: %s)", v)
}
})
}
}

Expand Down
15 changes: 8 additions & 7 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,14 @@ var (
// CommitSHA as provided by goreleaser.
CommitSHA = ""

readmeNames = []string{"README.md", "README"}
configFile string
pager bool
style string
width uint
showAllFiles bool
mouse bool
readmeNames = []string{"README.md", "README", "Readme.md", "Readme", "readme.md", "readme"}
readmeBranches = []string{"main", "master"}
configFile string
pager bool
style string
width uint
showAllFiles bool
mouse bool

rootCmd = &cobra.Command{
Use: "glow [SOURCE|DIR]",
Expand Down
Loading