comments

Documentation

Overview

Package comments provides functionality to add and remove comments to the top of files.

Index

• func ContainsFileType(fileTypes []FileType, fileType FileType) bool
• func FileContent(path string) (string, error)
• func FileContentWithoutHeader(path string, headerRegexp *regexp.Regexp) (string, error)
• func StripPrefixes(fileContent string, prefixes []string) (string, string)
• func SupportsFile(filePath string) bool
• func WriteFileWithHeader(path, header, body string) error
• type FileType
  • func GetFileType(filePath string) FileType
• type Format
  • func GetFormat(path string) (Format, bool)
  • func (f Format) SplitHeaderFromContent(text string, headerRegexp *regexp.Regexp) (header, content string)

Functions

func ContainsFileType

func ContainsFileType(fileTypes []FileType, fileType FileType) bool

indicates whether the given list of FileTypes contains the given FileType

func FileContent

func FileContent(path string) (string, error)

func FileContentWithoutHeader

func FileContentWithoutHeader(path string, headerRegexp *regexp.Regexp) (string, error)

FileContentWithoutHeader provides the content of the file with the given path, without the comment block identified by the given token.

func StripPrefixes

func StripPrefixes(fileContent string, prefixes []string) (string, string)

func SupportsFile

func SupportsFile(filePath string) bool

indicates whether it is possible to add comments to the file with the given name

func WriteFileWithHeader

func WriteFileWithHeader(path, header, body string) error

WriteFileWithHeader creates a file at the given path containing the given file content (header + body). The header argument should contain only text. This method will transform it into the correct comment format.

Types

type FileType

type FileType string

a file format that we know about, represented as its file extension

func GetFileType

func GetFileType(filePath string) FileType

provides the extension of the given filepath

type Format

type Format struct {
	// contains filtered or unexported fields
}

a comment format known to this app

func GetFormat

func GetFormat(path string) (Format, bool)

func (Format) SplitHeaderFromContent

func (f Format) SplitHeaderFromContent(text string, headerRegexp *regexp.Regexp) (header, content string)