Use GitHub/GitLab API to get a repo readme #160
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for your PR, @cristiand391! I'll try this out and review it asap! |
YerinAlexey
suggested changes
Feb 13, 2021
| return nil, err | ||
| } | ||
|
|
||
| apiRepoURL := fmt.Sprintf("https://gitlab.com/api/v4/projects/%s%s%s", user, "%2F", repo) |
There was a problem hiding this comment.
To be safe, this should probably be escaped.
Ref: url.PathEscape
Suggested change
| apiRepoURL := fmt.Sprintf("https://gitlab.com/api/v4/projects/%s%s%s", user, "%2F", repo) | |
| apiRepoURL := fmt.Sprintf("https://gitlab.com/api/v4/projects/%s", url.PathEscape(user + "/" + repo)) |
| v.Path += "/raw/master/" + r | ||
| repoInfo := gitLabRepo{} | ||
|
|
||
| if err := json.Unmarshal([]byte(string(content)), &repoInfo); err != nil { |
There was a problem hiding this comment.
This is useless conversion as ioutil.ReadAll already returns []byte.
Ref: ioutil.ReadAll
Suggested change
| if err := json.Unmarshal([]byte(string(content)), &repoInfo); err != nil { | |
| if err := json.Unmarshal(content, &repoInfo); err != nil { |
| return "", "", err | ||
| } | ||
|
|
||
| pathSplit := strings.Split(u.Path, "/") |
There was a problem hiding this comment.
I think it is better to use path.Split here as it will work on non-Unix systems as well.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ref: #151 (comment)
This PR adds initial support for using the GitHub/GitLab public API to get a repo readme file.
TODO:Rate limiting:
The GitHub API allows up to 60 requests per hour, in the case the user exceeds the limit, how should Glow handle it?
GitLab allows up to 10 req per second so it shouldn't be a problem.