dojo-meta

This repository contains information regarding Dojo 2 that crosses package boundaries.

Guidelines and Style Guide

There are several documents that are relevent for contributing to Dojo 2.

Contributing Guidelines - Guidelines for contributing code (or documentation) to Dojo 2
Style Guide - The style guide for Dojo 2.
tslint.json - The configuration file tslint that is used to validate Dojo 2 code against

Dependent Technologies

While Dojo 2 tries to provide a holistic set of tools to build web applications, there are several key technologies where we feel that Dojo 2 would be better integrating and building upon versus building from the ground up.

In order to ensure that Dojo 2 is a solid set of JavaScript tools and libraries, Dojo 2 is built on TypeScript. This provides us with structural design time typing as well as an effective way to communicate the intent of the Dojo 2 APIs. It also provides us the ability to adopt ES6+ syntax features but make distributables that will be backwards compatible to the target browsers for Dojo 2.

In addition, there are some core runtime technologies that parts of Dojo 2 are built on:

MaquetteJS a minimalistic virtual DOM built in TypeScript
RxJS 5 Observables an implementation of ES Observable built in TypeScript
ImmutableJS immutable collections for JavaScript

Packages

There are several packages that makeup the Dojo 2 platform:

dojo/actions - A command like library for Dojo 2 applications
dojo/app - An application framework for Dojo 2
dojo/cli - Command Line Tooling for Dojo 2 Applications
dojo/compose - A mixin/trait based composition library
dojo/core - The foundational code of the Dojo 2 platform
dojo/data - A data querying, transformation and materialization library for Dojo 2
dojo/dataviz - A data vizualization library for Dojo 2
dojo/dom - A set of APIs for manipulating the DOM
dojo/has - A feature detection library
dojo/loader - A TypeScript based AMD loader
dojo/routing - A routing service to build web applications with
dojo/shim - Modules that provide fills of ES6+ functionality
dojo/stores - Data stores for Dojo 2
dojo/widgets - A set of rich UI elements
dojo/i18n - A set of internationalization tooling

We also have packages that are still in their planning stages and as such might not be part of the initial Dojo 2 release.

dojo/crypto - A set of libraries to deal with cryptography

We have deprecated a package:

dojo/parser - A HTML document parser for instantiating objects declaratively - This is deprecated in lieu of functionality provided by dojo/app.

Examples

We have added a repository of examples which have been built on Dojo 2. Those examples are available in the dojo/examples repository.

Support Packages

There are several packages which are designed to support the Dojo 2 platform:

dojo/dojo2-package-template - The standard template for Dojo 2 packages, including build and packaging templates
dojo/grunt-dojo2 - A set of Grunt tasks for use with Dojo 2 packages.

These packages are aimed at Dojo 2 contributors rather than Dojo 2 end users.

Status

The following tables contain status information for the packages:

Package	Stage	Maintainer
dojo/actions	Alpha
dojo/app	Alpha
dojo/compose	Beta	@maier49
dojo/cli	Alpha	@Tomdye
dojo/core	Beta
dojo/dataviz	Prototype
dojo/dom	Beta
dojo/has	Beta	@kitsonk
dojo/shim	Beta	@kitsonk
dojo/loader	Beta
dojo/widgets	Alpha	@kitsonk
dojo/routing	Alpha
dojo/stores	Prototype	@maier49
dojo/i18n	Prototype