Implement prompter package #131
Conversation
samcoe
force-pushed
the
prompter
branch
2 times, most recently
from
b6d6d78 to
72668d0
Compare
There was a problem hiding this comment.
Comparing these changes versus https://github.com/cli/cli/tree/trunk/internal/prompter, this is a welcome addition!
Minor nit but also a larger question regarding documentation. 🙇
pkg/prompter/prompter.go
Outdated
| // LatinMatchingFilter returns whether the value matches the input filter. | ||
| // The strings are compared normalized in case. | ||
| // The filter's diactritics are kept as-is, but the value's are normalized, | ||
| // so that a missing diactritic in the filter still returns a result. | ||
| func latinMatchingFilter(filter, value string, index int) bool { |
There was a problem hiding this comment.
(nit) Not sure if it matters but will match the function case just in case
| // LatinMatchingFilter returns whether the value matches the input filter. | |
| // The strings are compared normalized in case. | |
| // The filter's diactritics are kept as-is, but the value's are normalized, | |
| // so that a missing diactritic in the filter still returns a result. | |
| func latinMatchingFilter(filter, value string, index int) bool { | |
| // latinMatchingFilter returns whether the value matches the input filter. | |
| // The strings are compared normalized in case. | |
| // The filter's diactritics are kept as-is, but the value's are normalized, | |
| // so that a missing diactritic in the filter still returns a result. | |
| func latinMatchingFilter(filter, value string, index int) bool { |
There was a problem hiding this comment.
Yeah this is something that I don't like about godoc comments... they encourage/enforce sentences but also the first letter can be uncapitalized, it bothers me.
| @@ -84,3 +88,19 @@ func RelativeTimeAgo(a, b time.Time) string { | |||
|
|
|||
| return fmtDuration(int(ago.Hours()/24/365), "year") | |||
| } | |||
|
|
|||
| // RemoveDiacritics returns the input value without "diacritics", or accent marks. | |||
pkg/prompter/mock.go
Outdated
| package prompter | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| // PrompterMock provides stubbed out methods for prompting the user for | ||
| // use in tests. PrompterMock has a superset of the methods on Prompter | ||
| // so they both can satisfy the same interface. | ||
| type PrompterMock struct { | ||
| t *testing.T | ||
| selectStubs []selectStub | ||
| multiSelectStubs []multiSelectStub | ||
| inputStubs []inputStub | ||
| passwordStubs []passwordStub | ||
| confirmStubs []confirmStub | ||
| } |
There was a problem hiding this comment.
Assuming CLI extension integrators would use this in their own testing, how much documentation based on the cli/cli usage should be captured in documentation?
Do we expect people to depend upon https://pkg.go.dev/github.com/cli/go-gh or use markdown in the repo?
There was a problem hiding this comment.
Yeah I wanted to write up an example that compiles like the ExamplePrompter() but it started getting complicated due to the fact that I was trying to write a test about writing a test. Perhaps just a normal comment is enough. I will think on it a bit more.
There was a problem hiding this comment.
I went ahead and added a test example in the comments.
This PR implemented the prompter package which was mostly taken from
ghwith some small tweaks. Additionally, it includes aPrompterMockfor use in tests.cc cli/cli#7898