Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Select the top-level "ambari pom.xml" and click Finish.

Coding Guidelines for Ambari.

Ambari Web Frontend Development Environment

Application Assembler: Brunch

We use Brunch as the client-side application assembler: http://brunch.io/Image Added
Brunch can:

Generate an application skeleton that is well structured with common client-side libraries (Backbone.js/Ember.js, jQuery, JavaScript/CoffeeScript, Stylus/LESS, etc)
Build and deploy automatically in the background as you modify the source files.
This lets you break up the application into a number of JS files for code organization and reuse without worrying about runtime load performance.
For QA/production deployment, we can turn on JavaScript/CSS minification for fast application loading.
Run automated tests.
Run a Node.js-based web server with a single command so that you can easily run the application from the application root directory without any special configuration.

Install Node.js from http://nodejs.org/Image Added.
We have created a Brunch-based application and checked it into Github. To check out the project from the Github repository, run:
git clone git@github.com:hortonworks/ambari
cd ambari-web
sudo npm install -g brunch
npm install

To run the web server (and to enable continuous build/deploy), run:
brunch watch --server
Or use the shorthand: brunch w --s

IDE: PhpStorm

All front-end developers should use PhpStorm by JetBrains.
JetBrains has granted all contributors of Apache Ambari a free license for PhpStorm and IntelliJ (if you also need to do Java development - IntelliJ is a superset of PhpStorm, but PhpStorm is lighter so it is recommended if you are not modifying Java code).

IDE Plugins

Go to Preferences->Plugins->Browse repositories and install “Node.js” and “Handlebars” plugins.
Coding Conventions

Before checking in any HTML/JavaScript/CSS files, they must be formatted with the IDE to maintain consistency.
Also, the IDE will give warnings in the editor about implicit globals, etc. Fix these warnings before checking in code.
IDE Code Formatting Customization

We will use all default settings for Code Style in the IDE, except for the following:
Go to Preferences
Code Style->General
Line separator (for new files): Unix
Make sure “Use tab character” is NOT checked
Tab size: 2
Indent: 2
Continuation indent: 2
Code Style->JavaScript:
Tabs and Indents
Make sure “use tab character” is NOT checked
Set Tab size, Indent, and Continuation indent to “2”.
Spaces->Other
Turn on “After name-value property separator ‘:’

In general, the following conventions should be followed for all JavaScript code: http://javascript.crockford.com/code.htmlImage Added

Exceptions to the rule from the above:
We use 2 spaces instead of 4.
Variable Declarations:
“It is preferred that each variable be given its own line and comment. They should be listed in alphabetical order.”
Comment only where it makes sense. No need to do alphabetical sorting.
“JavaScript does not have block scope, so defining variables in blocks can confuse programmers who are experienced with other C family languages. Define all variables at the top of the function.”
This does not need to be followed.

Unit Testing

Unit tests are written using Mocha.
Run unit tests via
brunch test
Code Check-In Guidelines

See Code Check-In Guidelines
Development Virtual Machine Set Up

See https://docs.google.com/a/hortonworks.com/document/d/1xS0Muy5_muH0xM4g67azRlqrEPcduO1ka3cyyeCBCpw/editImage Added