invopop / invopop/jsonschema

AddGoComments can not use "windows" paths with backslash

Open
#76 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Go
Stars
952
Forks
136
PR merge metrics
No merged PRs in 30d

Description

This is not a big issue but I noticed that on windows when constructing paths using path.join or related the comments
did not load. But if I replaced all the backslashes (normal microsoft) with slashes (the rest of the world) it works.

Slashes works
`reflector.AddGoComments("github.com/lavoqualis/messages.go", "./sources" )`
but backslash
`reflector.AddGoComments("github.com/lavoqualis/messages.go", ".\\sources" )`
doesn't.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start at the reflector.AddGoComments entry point and reproduce the two documented calls on Windows, comparing forward- and backslash paths. Trace how the source path is resolved and verify that the backslash form loads comments successfully without breaking the existing slash form.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.