Exclude certain URLs for local linkchecks (#109)

* Exclude certain URLs for local linkchecks

- branched github URLs being checked even though they don't exist until
  pushed. Those URLs are now optionally checked with the -r flag
- "linkcheck" -> "lychee" to distinguish the function that runs lychee
  linkchecks and the function that runs doclinkchecker linkchecks

* call lychee instead of linkchec when utils are run w/ -a flag

* Remove "-r" flag from utils

---------

Co-authored-by: cjsha <[email protected]>

Author: cjsha

docfx-utils.ps1

@@ -4,27 +4,25 @@ param
     [parameter(mandatory=$false)][switch][Alias("c")]$clean,
     [parameter(mandatory=$false)][switch][Alias("b")]$build,
     [parameter(mandatory=$false)][switch][Alias("d")]$doclinkchecker,
-    [parameter(mandatory=$false)][string][Alias("l")]$linkcheck,
+    [parameter(mandatory=$false)][string][Alias("l")]$lychee,
     [parameter(mandatory=$false)][string][Alias("a")]$all
 )
 
 # this is called removeartifacts instead of clean because clean might be already mean something in powershell?
 function removeartifacts
 {
     $deletePaths = ".\workflows\**\*.svg", ".\workflows\hardware\**\*.svg", ".\workflows\**\*.bonsai.layout", ".\workflows\hardware\**\*.bonsai.layout", ".\api\*.yml", ".\api\.manifest", ".\_site\", ".\_raw\", ".\_view\", ".\src\onix-bonsai-onix1\artifacts\"
-
     foreach($deletePath in $deletePaths){if (Test-Path $deletePath){Remove-Item $deletePath -Recurse}}
     Write-Output ""
 }
 
 function build{.\build.ps1 --logLevel Suggestion --warningsAsErrors}
 
-function linkcheck 
+function lychee($lycheePath)
 {
-    param($lycheePath)
     Write-Output "`nRunning lychee..."
     Write-Output "------------------------------------------`n"
-    Invoke-Expression "& `"$lycheePath`" --no-progress --base _site --exclude ^https://github\.com.*merge.* --exclude ^https://github\.com.*apiSpec.* '_site/**/*.html'"
+    Invoke-Expression "& `"$lycheePath`" --no-progress --base _site --exclude ^https://github\.com.*merge.* --exclude ^https://github\.com.*apiSpec.* --exclude ^https://github\.com/open-ephys/onix1-bonsai-docs/blob/.*/#L1 '_site/**/*.html'"
     Write-Output "`n"
 }
 
@@ -41,7 +39,7 @@ if ($build){build}
 
 if ($doclinkchecker){doclinkchecker}
 
-if ($PSBoundParameters.ContainsKey("linkcheck")){linkcheck($linkcheck)}
+if ($PSBoundParameters.ContainsKey("lychee")){lychee $lychee}
 
 if ($PSBoundParameters.ContainsKey("all"))
 {
@@ -60,5 +58,5 @@ if ($PSBoundParameters.ContainsKey("all"))
     Start-Sleep -Seconds 2
     doclinkchecker
     Start-Sleep -Seconds 2
-    linkcheck($all)
+    lychee $all
 }