:bike: :derelict_house_building: on shell complet...
# developmentw
wide-midnight-78598
10/19/2022, 2:11 PMš² šļø on shell completions naming (i.e. the goal that generates the shell completions script):
./pants complete./pants completion./pants completions./pants --completionwide-midnight-78598
10/19/2022, 2:11 PMIf it's becoming something closer to a top-level goal, I would have preferred a verb - but then that's closer to
generate-completionsc
curved-television-6568
10/19/2022, 2:13 PMThere is a way to have it as an option style, but with caveats that itāll also be a top level thing as you have above..
https://github.com/pantsbuild/pants/blob/1870d37d7ca8096ff3bd15c6e25fbb3c358a0af3/src/python/pants/goal/help.py#L93
curved-television-6568
10/19/2022, 2:14 PMhmmā¦ maybe if
name = "_completions"aliases = ("--completions",)w
wide-midnight-78598
10/19/2022, 2:14 PMOh, yeah, I saw the aliases - but since it ends up in both, it kinda becomes a "goal"
c
curved-television-6568
10/19/2022, 2:14 PMyeah, itāll still be a goal..
curved-television-6568
10/19/2022, 2:15 PMbtw, Iām +1 for
completionsš 1
w
wide-midnight-78598
10/19/2022, 2:15 PMSo, it would end up on this page fundamentally (https://www.pantsbuild.org/docs/reference-all-goals), even with the underscore
h
happy-kitchen-89482
10/19/2022, 2:56 PMThis is for the goal that generates a completions shell script?
w
wide-midnight-78598
10/19/2022, 2:59 PMYep
b
bitter-ability-32190
10/19/2022, 3:11 PM(Is this in a plugin? Thats off by default and the user opts into?)
c
curved-television-6568
10/19/2022, 3:19 PMbuiltin goals canāt be in plugins
b
bitter-ability-32190
10/19/2022, 3:19 PMIt could be a goal provided by a plugin tho, doens't have to be "builtin"
c
curved-television-6568
10/19/2022, 3:19 PMtrue, just went of the OPās
but since itās a built-in goal,
b
bitter-ability-32190
10/19/2022, 3:20 PMI ask because I think eventually it'd be dope if this didn't exist in favor of Stu's idea to autogen relevant exported artifacts (like venvs, or this file) and pulling the plug on a plugin goal is easier to stomach than a builtin one š
w
wide-midnight-78598
10/19/2022, 3:20 PMc
curved-television-6568
10/19/2022, 3:21 PMwell, thatās the exact suggestion I had with the builtin goal alias š : https://github.com/pantsbuild/pants/blob/1870d37d7ca8096ff3bd15c6e25fbb3c358a0af3/src/python/pants/goal/help.py#L112-L115
b
bitter-ability-32190
10/19/2022, 3:22 PMIDC about the name, but I don't want us to hog the goallist unless enabled. Especially considering we can see a future where the goal isn't required
w
wide-midnight-78598
10/19/2022, 3:22 PM@curved-television-6568 Was providing context to Josh's comment about why it's a builtin
c
curved-television-6568
10/19/2022, 3:22 PMOh, k š
w
wide-midnight-78598
10/19/2022, 3:24 PMI mean, my original idea was for completions to be part of
exportc
curved-television-6568
10/19/2022, 3:24 PMIDC about the name, but I donāt want us to hog the goallist unless enabled. Especially considering we can see a future where the goal isnāt requiredWell, if weāre to adopt the policy of āhidingā rather than removing features for stability reasons (Joshās deprecation policy work) then we would likely keep it around regardless, but if not needed then as a hidden goal.
b
bitter-ability-32190
10/19/2022, 3:25 PMWe could also just pile in on the auto-gen feature >:)
š 1
w
wide-midnight-78598
10/19/2022, 3:25 PMš¤·
c
curved-television-6568
10/19/2022, 3:28 PMKeeping a builtin goal around I donāt see as such a big burden and is easy to implement today, where as the alternatives I believe requires more work (also on the design side) and the backend rules for the completions would likely be very close then as to now so my vote be to do whatās easy to unblock this now, and for the future we could simply hide it if it becomes an obsolete goal. No strong preference either way besides that š
b
bitter-ability-32190
10/19/2022, 3:29 PMYeah don't let me stop you. Just trying to peer ahead.
šÆ 1
c
curved-television-6568
10/19/2022, 3:29 PMAs am I š (that is, I appreciate the balancing of a pro vs con approach to find the best way forward). no light without dark etc š
h
happy-kitchen-89482
10/19/2022, 5:15 PMDoes folding this into
export./pants export --bash-completionsš” 1
happy-kitchen-89482
10/19/2022, 5:17 PMNow that we have plugin options for subsystems (š), we can make
exportb
bitter-ability-32190
10/19/2022, 5:18 PM(FWIW because of the builtin-nature it might need tobe baked directly into
exportw
wide-midnight-78598
10/19/2022, 7:10 PMHas export been modified in the last month or so? I thought it only worked for venvs? Original idea from July (https://github.com/pantsbuild/pants/pull/16200#issuecomment-1192063349) was as part of export or export-codegen
wide-midnight-78598
10/19/2022, 7:10 PMAnd I'm all +1's for fewer goals
h
happy-kitchen-89482
10/19/2022, 7:45 PMCurrently the only thing export exports is venvs, but it was always intended to be a general āget stuff out of Pantsā goal. The problem was how to specify what you want to get out of it in a pluggable way. Plus, it tries to use cmd-line specs in a way that isnāt generically useful. But now that we have pluggability of options, the path is open for
exportš 1
w
wide-midnight-78598
10/19/2022, 8:01 PMSo long as I can access
help-allexport