Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
42 lines (27 sloc) 2.23 KB

Util

The util/ directory is different than dojo/dijit/dojox in that it doesn't contain JavaScript code that accessed directly from web pages. Rather, it contains utility scripts as listed below.

:ref:`Dojo Build System <build/index>`

:ref:`The Dojo build system <build/index>` is used to create efficient optimized packages of JavaScript and CSS, customized for a given application or website. You can take advantage of this powerful tool to help structure your development and speed up your applications.

:ref:`ShrinkSafe <util/shrinksafe/index>`

:ref:`ShrinkSafe <util/shrinksafe/index>` is a standalone utility for compressing JavaScript, used by the Dojo Build System as an optional compression step, though can be used on individual files manually.

:ref:`DOH <util/doh>`

:ref:`DOH <util/doh>` is the test harness used by dojo, similar to JUnit. The util/doh/ directory also contains :ref:`DOH Robot <util/dohrobot>`, an API used in conjunction with DOH for automated keyboard/mouse testing.

:ref:`Checkstyle <util/checkstyle>`

:ref:`Checkstyle <util/checkstyle>` is a standalone utility for checking JavaScript files for violations of the Dojo style guide. Also includes an online tool for automatically fixing the majority of style guide violations.

Dojo Documentation System

Dojo uses a custom inline comment syntax which produces well structured xml, and powers the official API Docs . The doc system is powered by js-doc-parse. To get up and running quickly, check out this quickstart tutorial . For full js-doc-parse documentation, see https://github.com/wkeese/api-viewer/blob/master/README.rst .

Previously, the API docs were powered by the :ref:`doctools <util/doctools>` directory. However, this is now deprecated and will be removed in 2.0.

Migration

The migration directory contains scripts for helping to migrate from older versions of dojo to newer ones.