files

package

v2.7.3 Latest Latest Go to latest Published: Nov 3, 2023 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/editorconfig-checker/editorconfig-checker

Links

Open Source Insights

Documentation ¶

Overview ¶

Package files contains functions and structs related to files

Index ¶

Constants
func AddToFiles(filePaths []string, filePath string, config config.Config) []string
func GetContentType(path string, config config.Config) (string, error)
func GetContentTypeBytes(rawFileContent []byte, config config.Config) (string, error)
func GetFiles(config config.Config) ([]string, error)
func GetRelativePath(filePath string) (string, error)
func IsAllowedContentType(contentType string, config config.Config) bool
func IsExcluded(filePath string, config config.Config) (bool, error)
func PathExists(filePath string) bool
func ReadLines(content string) []string
type FileInformation

Constants ¶

View Source

const DefaultMimeType = "application/octet-stream"

Variables ¶

This section is empty.

Functions ¶

func AddToFiles ¶

func AddToFiles(filePaths []string, filePath string, config config.Config) []string

AddToFiles adds a file to a slice if it isn't already in there and meets the requirements and returns the new slice

func GetContentType ¶

func GetContentType(path string, config config.Config) (string, error)

GetContentType returns the content type of a file

func GetContentTypeBytes ¶

func GetContentTypeBytes(rawFileContent []byte, config config.Config) (string, error)

GetContentTypeBytes returns the content type of a byte slice

func GetFiles ¶

func GetFiles(config config.Config) ([]string, error)

GetFiles returns all files which should be checked

func GetRelativePath ¶

func GetRelativePath(filePath string) (string, error)

GetRelativePath returns the relative path of a file from the current working directory

func IsAllowedContentType ¶

func IsAllowedContentType(contentType string, config config.Config) bool

IsAllowedContentType returns whether the contentType is an allowed content type to check or not

func IsExcluded ¶

func IsExcluded(filePath string, config config.Config) (bool, error)

IsExcluded returns whether the file is excluded via arguments or config file

func PathExists ¶

func PathExists(filePath string) bool

PathExists checks whether a path of a file or directory exists or not

func ReadLines ¶

func ReadLines(content string) []string

ReadLines returns the lines from a file as a slice

Types ¶

type FileInformation ¶

type FileInformation struct {
	Line         string
	Content      string
	FilePath     string
	LineNumber   int
	Editorconfig *editorconfig.Definition
}

FileInformation is a Struct which represents some FileInformation

Source Files ¶

View all Source files

files.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL