devpkg: use struct field values in FlakeRef.String #1597
Merged
Conversation
This file contains hidden or 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
Improve FlakeRef.String so that it reassembles the flakeref using the current field values instead of returning the original parsed string that it came from. This makes it easier to modify parsed flakerefs or to create new ones from scratch. The strings are normalized so that when two flakerefs are equal, their strings will also be equal. The docs for FlakeRef.String go into more detail on what the normalized form looks like. Being able to parse/modify/encode flake references is part of the work to support multiple package outputs. Having a single (well-tested type) for handling flakes should help manage the complexity as another syntax for outputs is added.
savil
approved these changes
Nov 1, 2023
| @@ -41,7 +41,7 @@ linters-settings: | |||
| - name: bool-literal-in-expr | |||
| - name: cognitive-complexity | |||
| arguments: | |||
| - 30 # TODO: gradually reduce it | |||
| - 32 # TODO: gradually reduce it | |||
There was a problem hiding this comment.
lol, that's the opposite direction to the TODO! (It's okay)
| return url.String() | ||
| case "github": | ||
| if f.Owner == "" || f.Repo == "" { | ||
| return "" |
There was a problem hiding this comment.
Ideally, but I want FlakeRef to be a fmt.Stringer so this function is unable to return an error.
| @@ -260,6 +359,33 @@ func isArchive(path string) bool { | |||
| strings.HasSuffix(path, ".zip") | |||
| } | |||
|
|
|||
| // buildOpaquePath escapes and joins path elements for a URL flakeref. The | |||
| // resulting path is cleaned according to url.JoinPath. | |||
| func buildOpaquePath(elem ...string) string { | |||
There was a problem hiding this comment.
The Opaque word confused me. How about buildEscapedPath or buildURLSafePath?
There was a problem hiding this comment.
Sounds good. I'm going to rename it in another PR just so I don't have to rebase/merge all the other PRs.
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.
Improve FlakeRef.String so that it reassembles the flakeref using the current field values instead of returning the original parsed string that it came from. This makes it easier to modify parsed flakerefs or to create new ones from scratch.
The strings are normalized so that when two flakerefs are equal, their strings will also be equal. The docs for FlakeRef.String go into more detail on what the normalized form looks like.
Being able to parse/modify/encode flake references is part of the work to support multiple package outputs. Having a single (well-tested type) for handling flakes should help manage the complexity as another syntax for outputs is added.