Add support for scriptcs, Cake, and FAKE

[xt0rted]

Checklist:

• If this PR is a new feature, please provide at least one example link
• Make sure all of the significant new logic is covered by tests

Example files:

• start.csx
• HtmlAgilityPack.csx
• build.cake
• build.fsx
• build.fsx

[xt0rted]

@stefanbuck I'm having trouble getting these lines to work as I wanted.

I was trying to make everything after #module & #addin the link so you didn't have to search for the package name in the url, but GitHub's parsing the lines with a full url and everything after // is in a span so no link gets injected.

Is there a way to support making that whole value a link or are we stuck with making just the package name the link?

This is the file I was testing against https://github.com/cake-build/cake/blob/develop/build.cake.

[stefanbuck]

This sounds similar to an issue I'm currently facing getting PHP / laravel support in.

<td>
  <span class="pl-k">use</span><span data-rgh-whitespace="space"> </span><span class="pl-v">Illuminate</span>\<span class="pl-v">Contracts</span>\<span class="pl-v">Container</span>\<span class="pl-v">Container</span>;
</td>

Yesterday, I spent two hours try to come up with a solution without luck. It's mainly a lack of support for such markup in https://github.com/padolsey/findAndReplaceDOMText which we use in the insert-link package.

I've noticed that refined-github is able to wrap the url in your case. If we find a solution we should make sure it doesn't conflict with refined-github which is a widely used extension as well.

Is this a blocker for you? Maybe best to ignore it for now and investigate into it separately.

[xt0rted]

No not a blocker. I can have just the package name be the link until we find a better solution.

[stefanbuck]

My other PR was failing as well for some odd reason. After rebasing it passed

[stefanbuck]

Overall looks great. I left one comment about a potential optimization

[stefanbuck]

😍

[stefanbuck]

I think a console.log should work here too. That way you can get rid of the newline operator.

[stefanbuck]

Just to share some insights, you can use undefined as a return value as well. Just saying, no need to change it.

[xt0rted]

@stefanbuck I just tried return; and return undefined; and both give me an error. I guess that's why I was using an empty array here.

Uncaught (in promise) TypeError: Cannot read property 'registry' of undefined
    at app.js:41806
    at Array.map (<anonymous>)
    at app.js:41795
    at app.js:40329
    at Array.map (<anonymous>)
    at run (app.js:40322)
    at app.js:40355
    at gitHubInjection (app.js:15027)
    at init (app.js:40350)

The error points back to this line

OctoLinker/packages/helper-normalise-resolver-results/index.js

Line 67 in dbaaaa5

if (url.registry) {

[stefanbuck]

Ohh sorry for pointing you into the wrong direction. I guess there is some value in having a consistent return type 😉

[stefanbuck]

The signature of the resolve handler is resolve(path, target, meta, regExp).

Side note: Meta defaults to an empty object and is used in the context of plugin-npm-manifest.

What I want to talk about is the fourth argument regExp which is the matching RegExp from line 29. In my PHP PR I make use of this to use different resolvers

OctoLinker/packages/plugin-php/index.js

Lines 7 to 13 in 87a137a

	resolve(path, [target], meta, regExp) {
	if (target.includes('\\')) {
	return;
	}
	if (regExp === PHP_FUNC) {
	return liveResolverQuery({

maybe we can do something similar here. This allows use to be more specific and does reduce unnecessary look up in the OctoLinker API.

[xt0rted]

That's awesome, I'll have to revisit some of the css & dotnet things I was working on because I'm pretty sure I'll be able to simplify them by checking the regex.

[xt0rted]

Once this is merged a PR needs to be sent to fsprojects/awesome-fsharp#125 adding OctoLinker to the list.