Fix: Match links to a single file with their dot extensions

[joshleaves]

Tentative fix for #156 .

I thought the issue came from url-parse.ts but nothing in the code was wrong, so I went up the chain, until I found that the initial decorator matcher was stopping at whitespace, commas,...and the dot character. The matcher was always sending a truncated path to parse-url.

Removing it and testing locally got me the expected result.

# Now it behaves as expected:

https://github.com/nathonius/obsidian-github-link/blob/main/src/github/url-parse.ts

And of course, the href value is the expected one.

[github-advanced-security]

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

[nathonius]

Apologies for the delay, it's been a very busy time for me. I'll try and look at this before the new year.

[joshleaves]

No problem, hope you're taking enough rest for the year's end. And thanks again for all your work on the extension

[nathonius]

So this will work to fix urls that are a file path, but it will cause problems if used within a sentence, for example:

Created issue for this: https://github.com/nathonius/obsidian-github-link/issues/156.

So I think we need to be smarter about this, but I'm not sure how. 🤔

I played around with the regex for a while and came up with this:

https://regex101.com/r/bXPVza/1
/(?<!]\()https:\/\/github\.com\/([A-z\d\-_~+#%&=*@?\/]*(.[\S\n])*)[^\n\s]/g

After this PR goes in I think I'll add some unit tests for various URLs that should and should not match and refine the regex.

[joshleaves]

I think I'll add some unit tests for various URLs that should and should not match and refine the regex

I'd like to work on that, since now the brain teaser got to me =D

[nathonius]

I think I'll add some unit tests for various URLs that should and should not match and refine the regex

I'd like to work on that, since now the brain teaser got to me =D

well... I don't have the framework set up yet, and that's something I'd prefer to handle myself 😅 but always happy for contributions otherwise

[joshleaves]

I've pushed a new commit that checks multiple GitHub URLs against the matcher Regexp, and played a bit more with the Regexp.

Tested, it works on my machine:

[joshleaves]

Simplified the RegExp according to the QualityGate recommendation, and ran a lint on the code.

Runs great even with dots, or many links on a single line!

[joshleaves]

I added some more tests to the capture regexp since it was also capturing the first word after the repo.

[sonarqubecloud]

Quality Gate passed

Issues
10 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[nathonius]

@all-contributors please add @joshleaves for code and tests

[allcontributors]

@nathonius

I've put up a pull request to add @joshleaves! 🎉

[claremacrae]

These are great tests....

For safety, if anyone cared, they could be augmented by checking for cases that should not be matched...

const NON_GITHUB_URLS = [
    // a few things that are similar to URLs, and could be confused for them
];

  test('does not match string similar to URL', () => {
     NON_GITHUB_URLS(url => {
       // ......
     });
   });