github.com/zntrio/harp/v2@v2.0.9/pkg/sdk/cmdutil/templates.go (about)

     1  // Licensed to Elasticsearch B.V. under one or more contributor
     2  // license agreements. See the NOTICE file distributed with
     3  // this work for additional information regarding copyright
     4  // ownership. Elasticsearch B.V. licenses this file to you under
     5  // the Apache License, Version 2.0 (the "License"); you may
     6  // not use this file except in compliance with the License.
     7  // You may obtain a copy of the License at
     8  //
     9  //     http://www.apache.org/licenses/LICENSE-2.0
    10  //
    11  // Unless required by applicable law or agreed to in writing,
    12  // software distributed under the License is distributed on an
    13  // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    14  // KIND, either express or implied.  See the License for the
    15  // specific language governing permissions and limitations
    16  // under the License.
    17  
    18  package cmdutil
    19  
    20  import (
    21  	"strings"
    22  
    23  	"github.com/MakeNowJust/heredoc/v2"
    24  )
    25  
    26  const Indentation = `  `
    27  
    28  // LongDesc normalizes a command's long description to follow the conventions.
    29  func LongDesc(s string) string {
    30  	if s == "" {
    31  		return s
    32  	}
    33  	return normalizer{s}.heredoc().trim().string
    34  }
    35  
    36  // Examples normalizes a command's examples to follow the conventions.
    37  func Examples(s string) string {
    38  	if s == "" {
    39  		return s
    40  	}
    41  	return normalizer{s}.trim().indent().string
    42  }
    43  
    44  type normalizer struct {
    45  	string
    46  }
    47  
    48  func (s normalizer) heredoc() normalizer {
    49  	s.string = heredoc.Doc(s.string)
    50  	return s
    51  }
    52  
    53  func (s normalizer) trim() normalizer {
    54  	s.string = strings.TrimSpace(s.string)
    55  	return s
    56  }
    57  
    58  func (s normalizer) indent() normalizer {
    59  	indentedLines := []string{}
    60  	for _, line := range strings.Split(s.string, "\n") {
    61  		trimmed := strings.TrimSpace(line)
    62  		indented := Indentation + trimmed
    63  		indentedLines = append(indentedLines, indented)
    64  	}
    65  	s.string = strings.Join(indentedLines, "\n")
    66  	return s
    67  }