Auto Upload File on Save in Aptana

This is an explanation on how to automatically upload a file via FTP when you click “save” in the Aptana IDE (2.x does not work in 3.x). Let’s jump right in…

1. If you don’t have a project, create one.

2. If you don’t have a “scripts” folder in your project, create one (I put mine in the root directory of my project. No clue if it will work from anywhere else).

3. Create a new file inside your scripts folder with a .js extension (I named mine “upload_current_file_on_save.js”, not sure if it will work with any other name).

4. Place this code inside the file:

Code:

/*
* Menu: gMan > Upload On Save
* Kudos: Ingo Muschenetz
* License: EPL 1.0
* Listener: commandService().addExecutionListener(this);
* DOM: http://localhost/com.aptana.ide.syncing
* DOM: http://download.eclipse.org/technology/dash/update/org.eclipse.eclipsemonkey.lang.javascript
*/

// Add * Listener: commandService().addExecutionListener(this); to the top of this file to enable it

/**
* Returns a reference to the workspace command service
*/
function commandService()
{
var commandServiceClass = Packages.org.eclipse.ui.commands.ICommandService;

// same as doing ICommandService.class
var commandService = Packages.org.eclipse.ui.PlatformUI.getWorkbench().getAdapter(commandServiceClass);
return commandService;
}

/**
* Called before any/every command is executed, so we must filter on command ID
*/
function preExecute(commandId, event) {}

/* Add in all methods required by the interface, even if they are unused */
function postExecuteSuccess(commandId, returnValue)
{

// if we see a save command
if (commandId == “org.eclipse.ui.file.save”)
{
   sync.uploadCurrentEditor();

   /* Replace above line if you’d like to limit it to just certain projects
   var fileName = editors.activeEditor.uri;
   if(fileName.match(/projectName/ig))
   {
      sync.uploadCurrentEditor();
   }
   */
}
}

function notHandled(commandId, exception) {}

function postExecuteFailure(commandId, exception) {}

5. Save the file.

A few notes on what needed changed in this file from the sample file I took this from:

1. I added this line of code to the comment block at the top:

Code:

* Listener: commandService().addExecutionListener(this);

I know there is a comment in this file that tells you to “add this to the top of this file”, but since I’m new to the whole scripts thing I didn’t get that when it said “top of the file” it meant “the middle of the comment block at the top of this file”. I thought I was literally supposed to make that line the very first line in the file… Which didn’t work at all…

2. I changed the “menu” line to:

Code:

* Menu: gMan > Upload On Save

from:

Code:

* Menu: Synchronize > Upload Current File On Save Enabled

For some reason it didn’t work until I changed this line. Since my project is code named “gMan” (It’s a user management system, you’ll make the connection…) I just named the menu item “gMan” after my project. Then the command is to upload on save, so that’s what I named it. As soon as I made this change is when the whole thing started working. Could be coincidence, or could be that you have to do this for the script to work (rename the menu command something other than what the sample is named).

In case you haven’t figured it out, you run the script by going to the “Scripts” menu in the toolbar at the top of Apatan (and selecting the script, whatever you named it in the previous step).

Want to read more about website creation in Aptana from this author? Check out his book:
HTML, XHTML, and CSS All-in-One Desk Reference For Dummies (For Dummies (Computer/Tech)). Support the Author of this post and buy the book from Amazon by clicking on the link on this page. Thanks for the help!

About the Author

Christopher McCulloh

E-Commerce developer at Finish Line Co-Author of HTML, XHTML and CSS All-in-one Desk Reference for Dummies Graduated from IU with a Bachelors of Media Arts and Science and a Certificate in Applied Computer Science. Tech Editor for Building Facebook Applications for Dummies and Building Websites All-in-one for Dummies 2nd Edition. Creator and maintainer of the Status-bar Calculator Firefox Extension Three years professional experience in Java E-Commerce Development and four years professional experience with PHP for a combined total of seven years professional JavaScript/HTML/CSS experience

More articles by Christopher McCulloh »

Let the Cloud Wars Begin!!!

This is all going the same direction. They are all going to end up with unlimited storage for the same price point per year, so, the sooner one of them calls it and just offers that, the better that one will do. They need to ju...

Events Calendar Pro Nav Formatting Messed up on Empty Calendar

The Events Calendar Pro (from http://tri.be/) has a few problems. If you are trying to figure out why a calendar with no events in that month has completely screwed up header navigation, just put this line of code inside of tab...

Introducing GitScripts

GitScripts is a project that attempts to make Git user friendly. I have been working on it for almost a year now. When we implemented Git in my office, we were having a really hard time using it. We loved the flexibility of the...

Updates – Tab Edit 1.4, Abandoning JS Console, Limeberry news

It’s apparently Code Blitz week here at Chomperstomp.com HQ. We’ve seen 5 blog posts in the last week, and code commits to no less than 4 open source projects (plus tons behind the scenes that I won’t talk abo...

Introducing Limeberry

Limeberry is a CSS 3 Finely Granular Color Gradient Generator. It allows you to input very precise (up to the nth decimal) numeric values to be used as your gradient color stops. Choose how many color stops you want and then de...