picturesbyrobots / td-completes-me

A Simple Auto Completion Engine for Touch Designer

TD Completes Me

What is this?

This is a combo TOX/VSCode extension that leverages the Language Server protocol to send a list of context sensitive auto-completion items to Microsoft's Visual Studio Code.

What problem does this solve?

Creating extensive python scripts in Touch Designer can often be time consuming. We can use external editors like Sublime Text and VsCode but many of the features that make these tools beloved among traditional developers are not available to the Touch Designer programmer. This tool attempts to make editing the python scripts associated with Touch Designer projects a little more fluid and hopefully a little more joyful by implementing a (partial) autocompletion engine specific to the idioms of TD.

Features

• op('') provides a list of operator names relative to the curent text DAT being edited

  

• get completions for CHOP channel names and DAT rows and cols!

• parameter auto completion. get a list of availabe parameters by typing op('moviefilein1').par.

• self.ownerComp is respected (as long as it's called ownerComp)

• completions for custom extension and TD provided operator methods and members

Requirments

Right now only VSCode is supported. If there's interest we'll consider a Sublime Text addon.

TD builds > 2020.20020

Installation.

Clone or download this REPO and then head over to the BUILDS directory. There you'll find a .vsix extension and a tox. You can install the vsix extension by hitting control+shift+P and selecting extensions=>install from vsix. You can also download the latest version from the Release Page.

Contributing

Feel free! We(meaning me) are actively accepting pull requests.

Known Issues

Currently the td_completes_me uses a tcp based transport to communicate between Touch and VsCode. It will communicate by default on port 1338. If there is another process operating on this port then it will cause the extension to break. In practice this won't have any effect on editing your networks, you just won't get those sweet auto-completions!

Tested On

PC. It will probably work on a Mac.

Release Notes

0.3.0

Initial release.

0.3.1

fix warnings from external callback scripts

Enjoy!

td-completes-me's Issues

Basic TD Types not recognized

This is super awesome. I'd love to help make this our go-to Python editor tool.

First thing. It doesn't seem to recognize basic TD types, like op, COMP, DAT etc. All that stuff is in the main locals. I've never written an editor extension but I'm into it if you want a hand.

Hit me up at my personal email [email protected]

Cheers
Ivan DelSol
Head Python Wizard at Derivative

Hi!! Could you please help me with the using? Thank you so much!

So I had the .tox placed at the very root of the TD project, and I tried to do something in the perform COMP.

I also installed the .vsix and Python Official Extension in VSCode.

So how do I use the completion? I have newed a python file in VSCode and I typed op(''), and here is what it shows

Obviously the td-completes-me is working, or these stuff shall not be seen, but I don't know how to quote the component I am currently using in TD. I wanna get the completion of the transform1.translate.tx value. So I type these:



but any of them doesn't show the translate attribute:

So could you help me with my using? Thank you so much!!

Request to include the component in FunctionStore_tools

Hey devs, really like this component and was wondering if you'd be okay with me including it in my collection of TD tools: https://github.com/function-store/FunctionStore_tools

Thanks!

extension and module communicate on fixed port.

related to #7

It should be easy for users to change the port that the extension is communicating on.

[RFE] Use ENV Variable for Port

The Port (1338) atm is hardcoded. It would be nice if it would check for an ENV Variable (something like TDCM_PORT ?)

Having difficulties to install td-completes-me.

I would love to use your autocompletion, it would speed up my work a lot. Somehow I am having difficulties to get it running..

• From the latest Github Release, I downloaded the .tox file and the source code .zip with with the .vsix file.
• From Visual Studio Code I succesfully installed the .vsix
• I dropped the .tox into a new touchdesigner project

but the autocompletion doesn't appear when I open a td execute dat using visual studio code?

completions unavailable while using print statements

Completions don't seem to fire the cursor is inside ()

Sublime text!

If there's interest we'll consider a Sublime Text addon.

no autocomplete (command 'extension.tdCompletesMe.start_server' not found)

Hi I am not getting autocomplete functionality in vs and I see this error Command 'Touch Designer: Start AutoCompletion Engine' resulted in an error (command 'extension.tdCompletesMe.start_server' not found) vscode when I try to run the start command. I am inexperienced building extensions myself. Ihave tried disabling other plugins, but I cannot get vscode to converse with touchdesigner. I TD, the tcip dat says binding socket error access denied Any tips for where to look to solve the issue?

Thanks

textport spam

I'm getting some textport spam:

{'search_term': 'dat_SearchReplaceExt__td_15204_49.py', 'search_method': 'editing_file'}
repeated a bunch of times.

I think it's from line 423 of td_completes_me_ext.

If you use the function "debug" instead of "print" when you're sending debug info to the textport, it'll tell you what DAT and line the print came from. Super useful when you're just throwing stuff in to test, because if you forget to take it out you know exactly where the spam is coming from.

vsc settings.json

Hi!
Line in settings.json
"tdCompletesMe.connectType": null,
have an warning with
Incorrect type. Expected "string ".

Where I can find describe?

Code folding broken by TCM

When TCM is enabled, all the code folding icons disappear. Disabling restores them.