How to automate JS class-lookups in TextMate

Following are instructions for adding to the TextMate Javascript bundle so that you can assign a shortcut key in TM to bring up Unity docs in a TM browser, or select a Class or Class.function and go directly to its corresponding Unity docs. The process for C#/etc should be quite similar. Tweak the path to Unity.app if you have installed to somewhere non-standard.

If you look at the Unity documentation folder in the Finder, it should be quite easy to modify this (if you have a favorite page to start from for "Root Unity Documentation" below, for example).

These commands will also implicitly install a menu item in Bundles->JavaScript->

Root Unity documentation
- within TM, open the bundle editor (ctl-opt-cmd)
- Using "Show All" filter, find the JavaScript hierarchy and open it
- Highlight the hiearchy root (JavaScript) and click the +-down arrow menu in the bottom left corner
- select "New Command"
- name the new command something like "Unity Documentation"
- paste the following code in the "Command(s)" text area

Code (csharp):

1.  
2. UNITYDOC="/Applications/Unity/Unity.app/Contents/Documentation/Documentation/ScriptReference/index.html"
3. if [[ -f $UNITYDOC ]]
4.    then echo "<meta http-equiv=\"refresh\" content=\"0; tm-file://$UNITYDOC\">"
5.    else echo "
6.  
7. Couldn't find Unity documentation."
8. fi

- set "Input" as None
- set "Output" as "Show as HTML"
- set your shortcut key to whatever you like (I used ctl-opt-h)
- set the "Scope Selector" to source.js

Docs for selected text
- follow directions above up to creating the "New Command" and name something like "Documentation for Unity Word / Selection"
- paste the following code in the "Command(s)" text area:

Code (csharp):

1. ref=${TM_SELECTED_TEXT}
2. UNITYDOC="/Applications/Unity/Unity.app/Contents/Documentation/Documentation/ScriptReference/$ref.html"
3.  
4. if [[ -f "$UNITYDOC" ]]
5.     then [[ -n "$UNITYDOC" ]]  exit_show_html "<meta http-equiv='Refresh' content='0;URL=tm-file://$UNITYDOC'>"
6.     else echo "No Unity documentation found for: $TM_SELECTED_TEXT"
7. fi

- set "Input" to "Selected Text" or "Word"
- set "Output" to "Show as Tool Tip"
- shortcut key to what you like (I did ctl-opt-cmd)
- set "Scope Selector" to "source.js"

Note that this currently only works by directly looking up what you have selected. It cannot currently look up a function which is associated with an instantiated class for example. So you could look up "GameObject" or "GameObject.transform" by highlighting it, but it could not look up "myVar.transform".[/code]

 

Fantastic - thanks!

 

That's very useful! Using it with C# here, and it seems to work fine. Thanks a lot.

 

This is a really nice addition to TextMate (recently picked it up for Unity, works great). Anyone with ideas on using selected text to search Unity docs?

I've tried the follow, but it always returns the 'not found' despite working fine in my browser :

Code (csharp):

1.  
2. ref=${TM_SELECTED_TEXT}
3. UNITYDOC="/Applications/Unity/Unity.app/Contents/Documentation/Documentation/ScriptReference/30_search.html?q=$ref"
4.  
5. if [[ -f "$UNITYDOC" ]]
6.    then [[ -n "$UNITYDOC" ]]  exit_show_html "<meta http-equiv='Refresh' content='0;URL=tm-file://localhost/$UNITYDOC'>"
7.    else echo "Unity documentation not found"
8. fi
9.  

 

I got it working with Javascript, how did you get it to work with C#, there is only C and C++ in the list..

 

zumwalt; take a look at this thread here; http://forum.unity3d.com/viewtopic.php?t=1601&highlight=textmate

 

Thanks, I have plugged that into textmate, but don't have syntax highlighting or autocomplete, I'll play with it more later, great work guys! kudos!

 

Neil cleared this one up; looks like we were testing for existance of the file and since we're trying use it to search, it fails.

replace the if ... fi section with this:

Code (csharp):

1. exit_show_html "<meta http-equiv='Refresh' content='0;URL=file://localhost/$UNITYDOC'>"

all thanks to Neil for this!

 

These are the 2 I use;

Documentation (general):

Code (csharp):

1. UNITYDOC="/Applications/Unity/Unity.app/Contents/Documentation/Documentation/ScriptReference/index.html"
2. if [[ -f $UNITYDOC ]]
3.  then echo "<meta http-equiv=\"refresh\" content=\"0; tm-file://$UNITYDOC\">"
4.  else echo "
5.  
6. Couldn't find Unity documentation."
7. fi
8.  

Documentation (selection):

Code (csharp):

1.  
2. ref=${TM_SELECTED_TEXT}
3. UNITYDOC="/Applications/Unity/Unity.app/Contents/Documentation/Documentation/ScriptReference/30_search.html?q=$ref"
4.  
5. exit_show_html "<meta http-equiv='Refresh' content='0;URL=file://localhost/$UNITYDOC'>"
6.  

 

that still doesn't work for me.

Cheers.

 

it works on an exact search of a class name. but the full just gives me a blank page.

also is there a way to populate the contextual menu, so one can select text right-click and veiw documentation?

Cheers.