is it possible to get intellisense going for `BUILD` files v

Question

is it possible to get intellisense going for `BUILD` files via vscode i e autocomplete of target documentation and such as if it was an actual python file with some globals in scope and if so how would one go about that pray

bitter-ability-32190 · Answer

I think it s been brought up before Might try searching Slack history although the Free tier only allows looking about 3 months back

freezing-lamp-12123 · Answer

yeah i tried didn t really get any good results mainly some discussion of auto complete of targets from the cli

busy-vase-39202 · Answer

Unfortunately none of the current maintainers uses VSCode so our collective knowledge of issues related to it is relatively limited We d love to get better at VSCode support and have a goal of adding VS Code enthusiasts to the core team So anyone interested in getting involved with that please do ping me We collaborate and mentor as needed

bitter-ability-32190 · Answer

FWIW I use VS Code religiously and some point in a past life wrote an extension Just never felt driven to pick up this specific task sweat smile The landscape of this kinda thing has such a learning curve IMO it s hard to want to ramp up disappointed

busy-vase-39202 · Answer

I stand corrected in the happiest of ways heart

bitter-ability-32190 · Answer

Better Editor support is always a goal of the team s but also very intricate expensive I know I d LOVE it for my org < freezing lamp 12123> if you find yourself wanting to do something cool like this don t hesitate to reach out slightly smiling face

freezing-lamp-12123 · Answer

i would love to see it happen i m not a vscode extension developer myself and neither lsp bsp is something i m experienced with would not mind learning more about it though and pointers on what first steps could be

freezing-lamp-12123 · Answer

BUILD files are python with some boilerplate setup hidden is that right

bitter-ability-32190 · Answer

Yup

bitter-ability-32190 · Answer

To be very transparent They are `exec`d with a set of `globals`

freezing-lamp-12123 · Answer

what does that boilerplate look like

bitter-ability-32190 · Answer

That is an excellent question slightly smiling face There s basically three layers the last make this a little challenging but maybe I m not being imaginative The first is all the symbols collected that are just Pants targets Like `python sources` and `pex binary` The second are objects and CAOF s exposed They re baked in like Targets but don t have any magic A good example is `http source` which can be used as the value of a `file` `resource` `source` field See <https www pantsbuild org v2 13 docs reference file> as an example The last is user defined macros Basically anything goes preamble used for every `BUILD` file

bitter-ability-32190 · Answer

Here is the `exec` for BUILD files And here is for macros

bitter-ability-32190 · Answer

So I think and not too hard maybe it d be feasible to autogen a ` pyi` file describing all targets objects COAFs macros and then somehow plug into the Python support to tell it to always prentend the definitions in this ` pyi` are globally defined thinking face

freezing-lamp-12123 · Answer

sounds reasonable i m also not very experienced with the innards of python packaging library management grin

freezing-lamp-12123 · Answer

thank you very much for the pointers

bitter-ability-32190 · Answer

Always heart

fresh-cat-90827 · Answer

Many IDEs and text editors support syntax highlighting for `BUILD` files There is some limited support for code navigation and interaction as well such as reporting syntax errors ability to comment uncomment blocks of code and collapse expand code sections PyCharm users need to install the and add the `BUILD` file name pattern to the `Bazel BUILD language` in the `Recognized File Types` section See to learn more VSCode users only need to install the

fresh-cat-90827 · Answer

this is what my devs are used as a temporary solution works quite well actually

fresh-cat-90827 · Answer

The ` pyi` idea won t work after my experiments it seems because the stubs are used when you import that module in another module but you want the stubs to apply to the module currently being edited

bitter-ability-32190 · Answer

< fresh cat 90827> where s your ``` builtins pyi def shell sources name str gt None ```

bitter-ability-32190 · Answer

So really this would apply to all Python files which isn t ideal Would be nice to extend the Python support for Pants and then use this trick slightly smiling face

bitter-ability-32190 · Answer

You ve got me dangerously close to just trying this out myself eyes

fresh-cat-90827 · Answer

that s very cool slightly smiling face I think we should try to do the right thing though stuck out tongue we have we have and some discussions slightly smiling face

bitter-ability-32190 · Answer

Right a right solution would have layers I think leveraging `pyright` `pylance` fits in well with a larger extension Otherwise the alternative is providing full Python LSP support which is folly

fresh-cat-90827 · Answer

potentially I didn t have time to explore I am afraid disappointed

fresh-cat-90827 · Answer

I was thinking maybe we could piggy back on Starlark language server and extend the grammar with the Pants specific semantics

bitter-ability-32190 · Answer

Well taking `BUILD` files at face value They aren t Starlark they ARE Python just with a different set of `builtins`

fresh-cat-90827 · Answer

I see what you mean

bitter-ability-32190 · Answer

Also <https github com zchee starlark language server> hasn t seen action in 3 years open mouth

bitter-ability-32190 · Answer

It must ve gotten COVID early

bitter-ability-32190 · Answer

There should be a way to sign up for beer bribery I m a 6 pack of a porter from most of these fun Pants features sweat smile

freezing-lamp-12123 · Answer

i ll happily sponsor that beers

freezing-lamp-12123 · Answer

unless you re only into crazy rare investment kinds joy

bitter-ability-32190 · Answer

The craziest in my palette are Trappist beers beer

bitter-ability-32190 · Answer

And my unpopular opinion is Rochefort 8 is better than 10 joy

happy-kitchen-89482 · Answer

FWIW the data in ` pants help all` may be of use For example it ll tell you what all the registered target types are I think

bitter-ability-32190 · Answer

I m guessing it won t include parameter and type info or objects and CAOFs

wide-midnight-78598 · Answer

I feel like between shell completions `pants toml` completions <https pantsbuild slack com archives C046T6T9U p1659243255507499> and this we have some big ticket items surrounding developer experience Would these get lumped in as part of the experimental bsp Or separate I m happy to help out as I m a long time VSCode convert for almost everything I do

bitter-ability-32190 · Answer

I think at least `BUILD` and `pants toml` wouldn t be BSP but closer to LSP or just a dedicated extension

fast-nail-55400 · Answer

the communication layer of the Pants BSP support could be leveraged to allow Pants to answer LSP queries though

bitter-ability-32190 · Answer

Someone will be owing me a beer soon <https pantsbuild slack com archives C046T6T9U p1660236681814569>

freezing-lamp-12123 · Answer

` hide `

freezing-lamp-12123 · Answer

laughing

freezing-lamp-12123 · Answer

it sounds soooooper awesome

bitter-ability-32190 · Answer

The neat thing is its very small server boilerplate and is implemented as an LSP so conceivably would work for JetBrains IDEs too or any with the right client

freezing-lamp-12123 · Answer

i wish my python would be better so i didn t feel like things take forever in getting any progress when building a pants plugin

fresh-cat-90827 · Answer

I wouldn t worry about knowledge of Python language per se David I think to be able to write a plugin you need to have a focused dedicated time so that you can get familiar with the codebase and understand the movings parts I remember that it never worked trying to write a plugin and jump between various small work parts that caused interruptions

fresh-cat-90827 · Answer

However once you become more familiar with the code you ll be able to switch context without losing the velocity and feeling lost again smile at least that s how it worked with me

fresh-cat-90827 · Answer

but I do appreciate that number of moving parts feel free to ask in the < C0D7TNJHL|development> it s incredible how helpful everyone is

freezing-lamp-12123 · Answer

i think i m also still unsure about how some of the innards interact but it s primarily because my memory is so poor that i forget about concepts i ve read about previously but never really clicked in actual usage of it

fresh-cat-90827 · Answer

agree 100 It never worked for me trying to do an hour here and there I had to do half a day blocks

freezing-lamp-12123 · Answer

yeah hoping to find more time to dedicate toward my experiments