fix: Key construction in ExtractGoComments
#9
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.
The intended (from README.md) usage of
ExtractGoComments(base, path string, commentMap map[string]string) error
treats the params as following:base
– package import pathpath
– package location on the filesystemcommentMap
outputIf we pass
"../"
aspath
param the code will fail to load comments properly because of thepath.Join
used on the unverified input. Moreover, if thepath
is the absolute path, the code will join it withbase
so we end up with keysbase + "/" + absPath
(cleaned in thepath.Clean
func, but still).This PR fixes the behavior in the following way:
path
torootPath
for better understanding the semantics & not allowing name clashes in the funcroot
variable equal to the absolute path of therootPath
locationroot
pathroot
prefix of the path prior to joining with thebase
value