github.com/looshlee/beatles@v0.0.0-20220727174639-742810ab631c/bugtool/cmd/cmdref.go (about)

     1  // Copyright 2018-2019 Authors of Cilium
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package cmd
    16  
    17  import (
    18  	"fmt"
    19  	"os"
    20  	"strings"
    21  
    22  	"github.com/spf13/cobra"
    23  	"github.com/spf13/cobra/doc"
    24  )
    25  
    26  var cmdRefDir string
    27  
    28  var cmdRef = &cobra.Command{
    29  	Use:   "cmdref",
    30  	Short: "Generate Cilium command reference",
    31  	Run: func(cmd *cobra.Command, args []string) {
    32  		genCmdRef()
    33  	},
    34  	Hidden: true,
    35  }
    36  
    37  func genCmdRef() {
    38  	// Remove the line 'Auto generated by spf13/cobra on ...'
    39  	BugtoolRootCmd.DisableAutoGenTag = true
    40  	if err := doc.GenMarkdownTreeCustom(BugtoolRootCmd, cmdRefDir, filePrepend, linkHandler); err != nil {
    41  		fmt.Fprintf(os.Stderr, "%s\n", err.Error())
    42  		return
    43  	}
    44  }
    45  func linkHandler(s string) string {
    46  	// The generated files have a 'See also' section but the URL's are
    47  	// hardcoded to use Markdown but we only want / have them in HTML
    48  	// later.
    49  	return strings.Replace(s, ".md", ".html", 1)
    50  }
    51  
    52  func filePrepend(s string) string {
    53  	// Prepend a HTML comment that this file is autogenerated. So that
    54  	// users are warned before fixing issues in the Markdown files.  Should
    55  	// never show up on the web.
    56  	return fmt.Sprintf("%s\n\n", "<!-- This file was autogenerated via cilium cmdref, do not edit manually-->")
    57  }
    58  
    59  func init() {
    60  	cmdRef.Flags().StringVarP(&cmdRefDir, "directory", "d", "./", "Path to the output directory")
    61  	BugtoolRootCmd.AddCommand(cmdRef)
    62  }