Dimagi JavaScript Guide

Dimagi’s internal JavaScript guide for use in the CommCare HQ project.

Javascript code should be functional in all current major browsers, following the ECMAScript 2015 (ES6) standards, and should follow the guidelines described in this document.

Table of contents

Overview

• Static Files Organization

Dependencies

• Managing Dependencies
• Historical Background on Module Patterns
• RequireJS Migration Guide
• Third-Party Libraries
• External Packages

Best practices

• Integration Patterns
• Security
• Static Files
• Inheritance
• Code Review

Development Process

• Testing
• Linting