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 PrintCompletionScript()
• func Suggest(needle string, haystack []string, maxSuggestionDistance int) []string

Functions

func FindAllSubpackages

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

FindAllSubpackages 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 PrintCompletionScript

func PrintCompletionScript()

PrintCompletionScript prints Please's completion script to stdout.

func Suggest

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

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