mirror of
https://github.com/opentofu/opentofu.git
synced 2024-12-23 23:50:12 -06:00
593cf7b4d5
This new-ish package ended up under "helper" during the 0.12 cycle for want of some other place to put it, but in retrospect that was an odd choice because the "helper/" tree is otherwise a bunch of legacy code from when the SDK lived in this repository. Here we move it over into the "internal" directory just to distance it from the guidance of not using "helper/" packages in new projects; didyoumean is a package we actively use as part of error message hints.
25 lines
814 B
Go
25 lines
814 B
Go
package didyoumean
|
|
|
|
import (
|
|
"github.com/agext/levenshtein"
|
|
)
|
|
|
|
// NameSuggestion tries to find a name from the given slice of suggested names
|
|
// that is close to the given name and returns it if found. If no suggestion
|
|
// is close enough, returns the empty string.
|
|
//
|
|
// The suggestions are tried in order, so earlier suggestions take precedence
|
|
// if the given string is similar to two or more suggestions.
|
|
//
|
|
// This function is intended to be used with a relatively-small number of
|
|
// suggestions. It's not optimized for hundreds or thousands of them.
|
|
func NameSuggestion(given string, suggestions []string) string {
|
|
for _, suggestion := range suggestions {
|
|
dist := levenshtein.Distance(given, suggestion, nil)
|
|
if dist < 3 { // threshold determined experimentally
|
|
return suggestion
|
|
}
|
|
}
|
|
return ""
|
|
}
|