[RFC|Merged] Javascript Coding Style

[_hsr]

Code: Select all

phpbb.attachment_lightbox() {
   this.init = function() {
      if(this.sources === undefined) {
         return this.addSources();
      }
      else {
         return this.enable();
      }
   }
}

This is a piece of code I'm working on right now, and I'd like to suggest the following changes:

Code: Select all

phpbb.add_ajax_callback = function(id, callback)
{
   if (typeof callback === 'function')
   {
      phpbb.ajax_callbacks[id] = callback;
   }
   return this;
}

be changed to

Code: Select all

phpbb.add_ajax_callback = function (id, callback) {
   if (typeof callback === 'function') {
      phpbb.ajax_callbacks[id] = callback;
   }
   return this;
}

Ticket
http://tracker.phpbb.com/browse/PHPBB3-10855

Patch
https://github.com/phpbb/phpbb3/pull/779

[callumacrae]

Your second example is wrong. It should be:

Code: Select all

phpbb.add_ajax_callback = function(id, callback) {
   if (typeof callback === 'function')
   {
      phpbb.ajax_callbacks[id] = callback;
   }
   return this;
}

Parentheses go on the same line with function expressions (but not function declarations) and objects.

I've proposed having parentheses on their own line in the 4.0 Coding Guidelines topic, feel free to go +1 it. It won't be done in 3.x.

[_hsr]

Parentheses?
Or do you mean curly braces?

And if you are saying the second one is wrong, as in this one:

Code: Select all

phpbb.add_ajax_callback = function(id, callback)
{
   if (typeof callback === 'function')
   {
      phpbb.ajax_callbacks[id] = callback;
   }
   return this;
}

It is from core.js, the original.

The function definition I suggested is this:

Code: Select all

phpbb.add_ajax_callback = function (id, callback) {
   if (typeof callback === 'function') {
      phpbb.ajax_callbacks[id] = callback;
   }
   return this;
}

edit: I've added a PR https://github.com/phpbb/phpbb3/pull/762/ if you all could comment there on the issues, it would be great.

[callumacrae]

Hm, that function was fine when I wrote it xD

You can't the curly braces in one place without changing them everywhere.

[naderman]

Yes, this is a topic about coding guideline modifications. He is proposing to change the guidelines for Javascript code, and adapt all the code.

[callumacrae]

Oh. +1 to that

[naderman]

I definitely prefer that style for javascript as well. So I would agree to changing coding guidelines to state that in Javascript opening braces go on the same line separated with a space.

[callumacrae]

Can we have camel-cap var and function names for JS, too? While PHP doesn't really have a standard, all the built in JS libraries use camel-caps, so it looks a bit weird to have anything else.

[brunoais]

^
+1

[hanakin]

+1