c51e35e835
Adds cmd/mungedocs which is framework for processing all files under docs/ and either verifying that no changes needed or making in-place changes. Did not reuse kube::util::gen-docs because that seemed to be centered around handling added files, and this pass does not add files. Planned uses: - table of contents automatic updating - linkification - internal link checker - link-path-relativizer or absolutizer - example file syncer - header inserter. Just table-of-contents updating in this PR. Added Table of Contents to docs/networking.md. Demonstrates use of new TOC generator presubmit. Other docs will be added in future PRs. Additional development will be needed to handle some of the more complex cases.
122 lines
3.1 KiB
Go
122 lines
3.1 KiB
Go
/*
|
|
Copyright 2015 The Kubernetes Authors All rights reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package main
|
|
|
|
import (
|
|
"bytes"
|
|
"errors"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
flag "github.com/spf13/pflag"
|
|
)
|
|
|
|
var (
|
|
verify = flag.Bool("verify", false, "Exit with status 1 if files would have needed changes but do not change.")
|
|
rootDir = flag.String("root-dir", "", "Root directory containing documents to be processed.")
|
|
|
|
ErrChangesNeeded = errors.New("mungedocs: changes required")
|
|
)
|
|
|
|
func visitAndVerify(path string, i os.FileInfo, e error) error {
|
|
return visitAndChangeOrVerify(path, i, e, false)
|
|
}
|
|
|
|
func visitAndChange(path string, i os.FileInfo, e error) error {
|
|
return visitAndChangeOrVerify(path, i, e, true)
|
|
}
|
|
|
|
// Either change a file or verify that it needs no changes (according to modify argument)
|
|
func visitAndChangeOrVerify(path string, i os.FileInfo, e error, modify bool) error {
|
|
if !strings.HasSuffix(path, ".md") {
|
|
return nil
|
|
}
|
|
file, err := os.Open(path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer file.Close()
|
|
|
|
before, err := ioutil.ReadAll(file)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
after, err := updateTOC(before)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if modify {
|
|
// Write out new file with any changes.
|
|
if !bytes.Equal(after, before) {
|
|
file.Close()
|
|
ioutil.WriteFile(path, after, 0644)
|
|
}
|
|
} else {
|
|
// Just verify that there are no changes.
|
|
if !bytes.Equal(after, before) {
|
|
return ErrChangesNeeded
|
|
}
|
|
}
|
|
|
|
// TODO(erictune): more types of passes, such as:
|
|
// Linkify terms
|
|
// Verify links point to files.
|
|
|
|
return nil
|
|
}
|
|
|
|
func main() {
|
|
flag.Parse()
|
|
|
|
if *rootDir == "" {
|
|
fmt.Fprintf(os.Stderr, "usage: %s [--verify] --root-dir <docs root>\n", flag.Arg(0))
|
|
os.Exit(1)
|
|
}
|
|
|
|
// For each markdown file under source docs root, process the doc.
|
|
// If any error occurs, will exit with failure.
|
|
// If verify is true, then status is 0 for no changes needed, 1 for changes needed
|
|
// and >1 for an error during processing.
|
|
// If verify is false, then status is 0 if changes successfully made or no changes needed,
|
|
// 1 if changes were needed but require human intervention, and >1 for an unexpected
|
|
// error during processing.
|
|
var err error
|
|
if *verify {
|
|
err = filepath.Walk(*rootDir, visitAndVerify)
|
|
} else {
|
|
err = filepath.Walk(*rootDir, visitAndChange)
|
|
}
|
|
if err != nil {
|
|
if err == ErrChangesNeeded {
|
|
if *verify {
|
|
fmt.Fprintf(os.Stderr,
|
|
"Some changes needed but not made due to --verify=true\n")
|
|
} else {
|
|
fmt.Fprintf(os.Stderr,
|
|
"Some changes needed but human intervention is required\n")
|
|
}
|
|
os.Exit(1)
|
|
}
|
|
fmt.Fprintf(os.Stderr, "filepath.Walk() returned %v\n", err)
|
|
os.Exit(2)
|
|
}
|
|
}
|