Skip to content

K
k3s
Commit 1934fc73 authored by Mike Danese's avatar Mike Danese
Browse files
Options

mungedocs: fix ignored errors in link checker

Before this change the link checker would ignore errors in a file if the last link in a file was correct. The last link would wipe out the error variable and set it to nil. Furthermore, it replaced errored links with the empty string. If we find an error that we can't correct, append the error message to an an errs slice and leave the string as is. Signed-off-by: 's avatarMike Danese <mikedanese@google.com>
parent 558f69e6
Hide whitespace changes
Inline Side-by-side
Showing with 12 additions and 9 deletions
cmd/mungedocs/links.go
View file @ 1934fc73
...@@ -17,6 +17,7 @@ limitations under the License. ...@@ -17,6 +17,7 @@ limitations under the License.
package main package main
import ( import (
"errors"
"fmt" "fmt"
"net/url" "net/url"
"os" "os"
...@@ -33,11 +34,12 @@ var ( ...@@ -33,11 +34,12 @@ var (
) )
func processLink(in string, filePath string) (string, error) { func processLink(in string, filePath string) (string, error) {
var err error var errs []string
out := linkRE.ReplaceAllStringFunc(in, func(in string) string { out := linkRE.ReplaceAllStringFunc(in, func(in string) string {
var err error
match := linkRE.FindStringSubmatch(in) match := linkRE.FindStringSubmatch(in)
if match == nil { if match == nil {
err = fmt.Errorf("Detected this line had a link, but unable to parse, %v", in) errs = append(errs, fmt.Sprintf("Detected this line had a link, but unable to parse, %v", in))
return "" return ""
} }
// match[0] is the entire expression; // match[0] is the entire expression;
...@@ -56,8 +58,8 @@ func processLink(in string, filePath string) (string, error) { ...@@ -56,8 +58,8 @@ func processLink(in string, filePath string) (string, error) {
u, terr := url.Parse(linkText) u, terr := url.Parse(linkText)
if terr != nil { if terr != nil {
err = fmt.Errorf("link %q is unparsable: %v", linkText, terr) errs = append(errs, fmt.Sprintf("link %q is unparsable: %v", linkText, terr))
return "" return in
} }
if u.Host != "" && u.Host != "github.com" { if u.Host != "" && u.Host != "github.com" {
...@@ -69,8 +71,8 @@ func processLink(in string, filePath string) (string, error) { ...@@ -69,8 +71,8 @@ func processLink(in string, filePath string) (string, error) {
if u.Path != "" && !strings.HasPrefix(linkText, "TODO:") { if u.Path != "" && !strings.HasPrefix(linkText, "TODO:") {
newPath, targetExists := checkPath(filePath, path.Clean(u.Path)) newPath, targetExists := checkPath(filePath, path.Clean(u.Path))
if !targetExists { if !targetExists {
err = fmt.Errorf("%q: target not found", linkText) errs = append(errs, fmt.Sprintf("%q: target not found", linkText))
return "" return in
} }
u.Path = newPath u.Path = newPath
if strings.HasPrefix(u.Path, "/") { if strings.HasPrefix(u.Path, "/") {
...@@ -87,7 +89,8 @@ func processLink(in string, filePath string) (string, error) { ...@@ -87,7 +89,8 @@ func processLink(in string, filePath string) (string, error) {
dir := path.Dir(filePath) dir := path.Dir(filePath)
suggestedVisibleText, err = makeRepoRelative(path.Join(dir, u.Path), filePath) suggestedVisibleText, err = makeRepoRelative(path.Join(dir, u.Path), filePath)
if err != nil { if err != nil {
return "" errs = append(errs, fmt.Sprintf("%q: unable to make path relative", filePath))
return in
} }
} else { } else {
suggestedVisibleText = u.Path suggestedVisibleText = u.Path
...@@ -109,8 +112,8 @@ func processLink(in string, filePath string) (string, error) { ...@@ -109,8 +112,8 @@ func processLink(in string, filePath string) (string, error) {
return fmt.Sprintf("[%s](%s)", visibleText, linkText+altText) return fmt.Sprintf("[%s](%s)", visibleText, linkText+altText)
}) })
if out == "" { if len(errs) != 0 {
return in, err return "", errors.New(strings.Join(errs, ","))
} }
return out, nil return out, nil
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment