Flag value and command valid arguments functions support. #27

akemrir · 2023-09-01T10:57:04Z

Flag value and command valid arguments functions support.

Change-Id: I676fdb58769490a59c5801d8972e9a797cd366bc

… flag

codecov-commenter · 2023-09-01T17:24:00Z

Codecov Report

Merging #27 (9ad648f) into main (9f53ab1) will decrease coverage by 1.71%.
Report is 1 commits behind head on main.
The diff coverage is 78.42%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@            Coverage Diff             @@
##             main      #27      +/-   ##
==========================================
- Coverage   86.81%   85.11%   -1.71%     
==========================================
  Files          11       13       +2     
  Lines        2094     2317     +223     
==========================================
+ Hits         1818     1972     +154     
- Misses        194      252      +58     
- Partials       82       93      +11

Files	Coverage Δ
comp_arguments.go	`100.00% <100.00%> (ø)`
flag.go	`86.75% <100.00%> (ø)`
option.go	`100.00% <ø> (ø)`
string_utils.go	`100.00% <100.00%> (ø)`
cli.go	`80.26% <96.29%> (+1.03%)`	⬆️
slice_utils.go	`68.42% <68.42%> (ø)`
completion.go	`78.25% <75.44%> (-9.77%)`	⬇️

jxskiss · 2023-09-12T14:46:48Z

comp_arguments.go

+/*
+Arg completion tag syntax (WIP):
+
+	`comp:"nofile"`
+	`comp:"enums=a,b,c,d;"`
+	`comp:"fn=funcName"`
+	`comp:"listExt=json,yaml,toml"`
+	`comp:"listFiles"`  // and listDirs, listDirsAndFiles, etc.
+
+*/


With more looking into this feature, I am thinking that adding a new tag is not the best solution, maybe simply use a parsing option is a simpler and better choice. e.g.

WithArgCompFuncs(funcs map[string]ArgCompletionFunc) ParseOpt // where key of funcs is a flag name "-a", or "--b", or an argument name "arg1"

Just a thought, how do you think?

Could you prepare example?

e.g.

func main() { var args struct { Name string `cli:"-n, --name, Who do you want to say to" default:"tom"` // This argument is required. Text string `cli:"#R, text, The 'message' you want to send"` } mcli.Parse(&args, mcli.WithArgCompFuncs(map[string]mcli.ArgCompletionFunc{ "-n": func(ctx mcli.ArgCompletionContext) []mcli.CompletionItem { return []mcli.CompletionItem{ {"Tom", "Tom Smith"}, {"John", "John White"}, } }, "text": func(ctx mcli.ArgCompletionContext) []mcli.CompletionItem { // biz logic // ... return []mcli.CompletionItem{ // ... } }, })) fmt.Printf("Say to %s: %s\n", args.Name, args.Text) }

ok, cleanup done
looks actually better

jxskiss · 2023-09-12T14:51:23Z

comp_arguments.go

+)
+
+// ArgCompletionFunc is a function to do completion for flag value or positional argument.
+type ArgCompletionFunc func(ctx ArgCompletionContext) ([][]string, ShellCompDirective)


A precisely defined return type could be easier to use for library users, e.g.

// returns []CompletionItem type CompletionItem struct { Value string Description string }

jxskiss · 2023-09-12T14:52:58Z

comp_arguments.go

+// WithCommandCompFuncs for holding completion functions for use with args completions
+func WithCommandCompFunc(function ArgCompletionFunc) CmdOpt {
+	return CmdOpt{f: func(options *cmdOptions) {
+		options.argCompFunc = function
+	}}
+}


This option seems unnecessary.

Why? It's separate for command.

app.Add("s0", serve, "Serve with port and dir", mcli.WithCommandCompFunc(configureFunc(config, cmdTestArguments)) )

I have decorator to pass extra arguments, but the purpose is the same. Separate handling for commands.
It's simpler then to handle and get the function.

For flags we have slice of functions, and we need to filter out them.

Not sure if I understand it right, is it to complete a positional argument? If yes, it can be unified by using

WithArgCompFuncs(map[string]ArgCompletionFunc{ "arg1": fn1, "arg2": fn2, })

Yes, it is to complete positional argument.
You are thinking about unification of arguments passing?

Right now I am passing one function to one command.

Please suggest place to which we would pass this map.

See the example text above #27 (comment), I passed the map to Parse.

So the goal is to pass both command positional argument completion and flag completion in same place?

Yes, I think this unified API is simpler and more straitforward to use.

Yes, but we would get completion after command parsing that way?
I changed the code, but it's not evaluating properly.

Were we would pass it otherwise?

Yes, complete positional argument after parsing flags will make it more flex and powerful, i.e. programmer can make use of parsed flags to decide which arguments to suggest.
e.g. for the above example program say, if name is "Tom", we suggest "a", "b" as text, if name is "John", we suggest "d", "e", "f".
I will take a look into the code.

Please do so. I am not pushing my current changes.

jxskiss · 2023-09-12T15:01:59Z

And another question, do we need to support context-aware completion? I mean can user implement the completion functions according to the flags and/or positional arguments already provided in comand line.

akemrir · 2023-09-13T16:53:07Z

Yes, he can.

func cmdTestArguments(config Config, ctx mcli.ArgCompletionContext) []mcli.CompletionItem {
	// fmt.Printf("%s, %#v\n", config, ctx.Args())

With ctx we pass context, user can get arguments from it.
So he can also adjust logic according to current state.

akemrir · 2023-09-13T16:55:19Z

I had also started cleanup. I will do final PR with whole cleanup after all remarks.

Change-Id: I303548507a8cde2888a6205f6afe269423b523d9

jxskiss · 2023-10-09T09:43:46Z

Finally I found some time to dive into this code, I send a PR to your branch, please check it, feedback is welcome.
akemrir#1

Change-Id: Id76572f4712e8b32994ceecfc58e6f3fa117f7b0

Change-Id: I53bc2d0b32a95a24b50a3722291b5853c201a311

PR-003 make arg completion more flexible

akemrir · 2023-10-10T05:59:24Z

ok, I had merged the changes from your PR to this PR
I've made also few accomodations for zsh/fish shells.
Could you take a look?

jxskiss and others added 13 commits August 15, 2023 21:34

WIP

3d479c0

Change-Id: I676fdb58769490a59c5801d8972e9a797cd366bc

initial changes

54155c3

Merge branch 'main' into tmp_arg_suggestion_draft

b42cdbd

Merge branch 'main' into PR-003

8529e02

Merge branch 'tmp_arg_suggestion_draft' into PR-003

da55d03

PR-003 - almost mvp

b4701b2

PR-003 - flag arguments mvp

c26342a

PR-003 - fixes/cleanups

55c94a3

PR-003 - mvp

0e49919

PR-003 - improvements

38acc09

PR-003 - contains removed in favor of slices.Contains

266917c

PR-003 - more tests, cleanup, revert of suggestion of already visible…

641f605

… flag

re-add slice contains

939d682

akemrir added 3 commits September 2, 2023 17:06

PR-003 - utils separation

8fb34e9

PR-003 - planned functions commented out

b21b44d

PR-003 - bash complete fix

01b443d

akemrir marked this pull request as ready for review September 6, 2023 05:50

jxskiss reviewed Sep 12, 2023

View reviewed changes

PR-003 - PR comments

63c05a8

akemrir and others added 2 commits September 16, 2023 18:24

PR-003 - PR remarks

36ba86e

PR-003 make arg completion more flexable

2a2d98d

Change-Id: I303548507a8cde2888a6205f6afe269423b523d9

jxskiss and others added 4 commits October 9, 2023 19:53

PR-003 test ArgCompletionContext and fix bugs

72bb385

Change-Id: Id76572f4712e8b32994ceecfc58e6f3fa117f7b0

PR-003 tidy code

f4f8a77

Change-Id: I53bc2d0b32a95a24b50a3722291b5853c201a311

Merge pull request #1 from jxskiss/akemrir-PR-003-patch

e3888d3

PR-003 make arg completion more flexible

fish and zsh shell complete updates

9ad648f

jxskiss merged commit 4f892a7 into jxskiss:main Oct 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Flag value and command valid arguments functions support. #27

Flag value and command valid arguments functions support. #27

akemrir commented Sep 1, 2023

codecov-commenter commented Sep 1, 2023 •

edited

Loading

jxskiss Sep 12, 2023

akemrir Sep 13, 2023

jxskiss Sep 14, 2023

akemrir Sep 16, 2023

jxskiss Sep 12, 2023

akemrir Sep 13, 2023

jxskiss Sep 12, 2023

akemrir Sep 13, 2023

jxskiss Sep 14, 2023

akemrir Sep 16, 2023

jxskiss Sep 16, 2023

akemrir Sep 17, 2023

jxskiss Sep 18, 2023

akemrir Sep 18, 2023

jxskiss Sep 19, 2023

akemrir Sep 19, 2023

jxskiss commented Sep 12, 2023 •

edited

Loading

akemrir commented Sep 13, 2023 •

edited

Loading

akemrir commented Sep 13, 2023

jxskiss commented Oct 9, 2023

akemrir commented Oct 10, 2023

Flag value and command valid arguments functions support. #27

Flag value and command valid arguments functions support. #27

Conversation

akemrir commented Sep 1, 2023

codecov-commenter commented Sep 1, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jxskiss commented Sep 12, 2023 • edited Loading

akemrir commented Sep 13, 2023 • edited Loading

akemrir commented Sep 13, 2023

jxskiss commented Oct 9, 2023

akemrir commented Oct 10, 2023

codecov-commenter commented Sep 1, 2023 •

edited

Loading

jxskiss commented Sep 12, 2023 •

edited

Loading

akemrir commented Sep 13, 2023 •

edited

Loading