doc/dev/coding_standards_js.rst
author Denis Laxalde <denis.laxalde@logilab.fr>
Fri, 15 Mar 2019 12:12:23 +0100
changeset 12523 4d68d20427de
parent 12370 b3084ae2e718
permissions -rw-r--r--
Skip tests for ldapsource with python >= 3.7 Until someone works on fixing these, this should make our CI green again. I tried to use setupModule() to check for python version, but pre_setup_database() is apparently called even when a SkipTest exception is raised there. So handle this in that method.

Javascript Coding Standards
---------------------------

(Draft, to be continued)

:Naming: camelCase, except for CONSTANTS

Indentation rules
~~~~~~~~~~~~~~~~~

- one space before an opening curly bracket ({)

- line break after a closing curly bracket (}) (possibly no line break if
  everything is on the same line)

- no tabs


Documentation
~~~~~~~~~~~~~
XXX explain comment format for documentation generation


Coding
~~~~~~
- Don't forget 'var' before variable definition, and semi-colon (';') after **each** statement.
- Check the firebug console for deprecation warnings


API usage
~~~~~~~~~
- unless intended, use jQuery('container') rather than jqNode('container')


See also
~~~~~~~~
http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml