Skip to content

Development tools evaluation and selection

emi420 edited this page Feb 10, 2014 · 9 revisions

Stage A, Issue #23

Development tools evaluation and selection

https://github.com/emi420/Mootor/issues/23

Documentation auto-generation

YUIDoc http://yui.github.io/yuidoc/

All functions should have a comment block as defined in http://yui.github.io/yuidoc/syntax/index.html

Testing

Jasmine http://pivotal.github.io/jasmine/

All functions should have a corresponding test written in the jasmine spec.

CSS code production

Compass http://compass-style.org/

All CSS should be written in SCSS and compiled. There are several advantages to this.

JavaScript code production

Plain old JavaScript

YUICompressor http://yui.github.io/yuicompressor/

All compiled code should be available minified.

JavaScript code validation

JSHint (it is more configurable than JSLint) http://jshint.com/

All code should be hinted before it is released. A configuration guide might be provided at some point.

HTML code production

Plain old HTML

HTML code validation

w3c validator http://validator.w3.org/

All html code should pass the validator for HTML5

JavaScript code style guide

Google JavaScript Style Guide https://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml#Code_formatting


Authors:

  • Emilio Mariscal (emi420 [at] gmail.com)
  • Martín Szyszlican (martinsz [at] gmail.com)