Support specifying a port for remotes

[bitfield]

Our GitLab server runs on port 8000, so when you right-click on a file and select 'Open File on Remote', or 'Copy Remote Url to Clipboard', the generated URL doesn't work. It looks like this:

https://gitlab.example.com/example/foo/blob/3146b57606b1e727b4cd70e108df2dd51e3a332f/path/to/file

whereas it should be:

https://gitlab.example.com:8000/example/foo/blob/3146b57606b1e727b4cd70e108df2dd51e3a332f/path/to/file

I can't figure out how to configure this in the GitLens settings. I've tried adding this:

    "gitlens.remotes": [
        {
            "domain": "gitlab.example.com",
            "type": "GitLab",
            "urls": {
                "file": "https://gitlab.example.com:8000/..."
            }
        }
    ],

But this seems to have no effect at all on the generated URL. What am I doing wrong?

[eamodio]

I think the issue is that you need to fill out more properties in your custom remote:

"gitlens.remotes": [
    {
        "domain": "gitlab.example.com",
        "type": "GitLab",
        "urls": {
            "repository": "https://git.corporate-url.com:8000/${repo}",
            "branches": "https://git.corporate-url.com:8000/${repo}/branches",
            "branch": "https://git.corporate-url.com:8000/${repo}/commits/${branch}",
            "commit": "https://git.corporate-url.com:8000/${repo}/commit/${id}",
            "file": "https://git.corporate-url.com:8000/${repo}?path=${file}${line}",
            "fileInBranch": "https://git.corporate-url.com:8000/${repo}/blob/${branch}/${file}${line}",
            "fileInCommit": "https://git.corporate-url.com:8000/${repo}/blob/${id}/${file}${line}",
            "fileLine": "#L${line}",
            "fileRange": "#L${start}-L${end}"
        }
    }
],

[bitfield]

Evidently I'm not understanding the documentation properly. I assumed that to change the properties of file links, I would need to change the file URL setting, and no other. Is that wrong? If I change all the other properties as well, how does that affect the way GitLens generates the file URL? If changing those properties sets the correct file URL, then what is the file setting for?

[bitfield]

@eamodio can we categorise this as a documentation enhancement? I mean, if it is possible to do what I'm trying to do, then I should be able to figure it out from the documentation. On the other hand, if it isn't, the documentation should say so, shouldn't it?

[eamodio]

@bitfield if you set it up with the structure I provided does it work? Depending on that -- there is either a bug or documentation issues

[bitfield]

Well, here's my question about that:

I assumed that to change the properties of file links, I would need to change the file URL setting, and no other. Is that wrong? If I change all the other properties as well, how does that affect the way GitLens generates the file URL? If changing those properties sets the correct file URL, then what is the file setting for?

Can you help me understand how this works?

[eamodio]

All the file* properties contribute to different aspects of how GitLens builds file urls.

• file is the base url for a file on HEAD (i.e. not targeting a specific branch or commit)
• fileInBranch is the base url for a file on a specific branch
• fileInCommit is the base url for a file in a specific commit

Then tacked on to each of the above could be one of the following:

• fileLine is the format that should be added to the url to select a line within the file
• fileRange is the format that should be added to the url to select a range within the file

Does that help?

[bitfield]

OK, that's helpful, thank you. It sounds like to enable 'Open File on Remote', for the HEAD version of a file, all I need to set is file. Is that correct?

[eamodio]

Yes, but then other features like Open Commit on Remote, Open Branch on Remote, etc would be broken.

You will also need to set fileLine & fileRange to match what your host would use. But since you mentioned GitLab, as long as you set "type": "GitLab", everything will default to the GitLab formats

I am looking into making this simpler and will add an explicit port to make this case MUCH easier.

[bitfield]

Yes, but then other features like Open Commit on Remote, Open Branch on Remote, etc would be broken.

That's OK, I just wanted to make sure my understanding was correct that setting file should be enough to make this one command ('Open File on Remote') work.

You will also need to set fileLine & fileRange to match what your host would use. But since you mentioned GitLab, as long as you set "type": "GitLab", everything will default to the GitLab formats

Right. I've done that, so according to what you've explained, this should work. It does not. That's the bug I'm reporting.