utils

Documentation

Overview

Package utils contains various utility functions and whatnot.

Index

• func FindAllSubpackages(config *core.Configuration, rootPath string, prefix string) <-chan string
• func InitConfig(dir string, bazelCompatibility bool)
• func PrettyPrintSuggestion(needle string, haystack []string, maxSuggestionDistance int) string
• func ReadAllStdin() []string
• func ReadStdin() <-chan string
• func Suggest(needle string, haystack []string, maxSuggestionDistance int) []string

Functions

func FindAllSubpackages

func FindAllSubpackages(config *core.Configuration, rootPath string, prefix string) <-chan string

Finds all packages under a particular path. Used to implement rules with ... where we need to know all possible packages under that location.

func InitConfig

func InitConfig(dir string, bazelCompatibility bool)

InitConfig initialises a .plzconfig template in the given directory.

func PrettyPrintSuggestion

func PrettyPrintSuggestion(needle string, haystack []string, maxSuggestionDistance int) string

PrettyPrintSuggestion implements levenshtein-based suggestions on a sequence of items and produces a single message from them.

func ReadAllStdin

func ReadAllStdin() []string

ReadAllStdin reads standard input in its entirety to a slice. Since this reads it completely before returning it won't handle a slow input very nicely. ReadStdin is therefore preferable when possible.

func ReadStdin

func ReadStdin() <-chan string

ReadStdin reads a sequence of space-delimited words from standard input. Words are pushed onto the returned channel asynchronously.

func Suggest

func Suggest(needle string, haystack []string, maxSuggestionDistance int) []string

Suggest implements levenshtein-based suggestions on a sequence of items.