dojo-meta

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

Visit us at dojo.io for documentation, tutorials, cookbooks, and other materials. This repository contains detailed information on the structure of Dojo 2, while dojo.io is focused on getting started with and learning Dojo 2.

Guidelines and Style Guide

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

Contributing Guidelines - Guidelines for contributing code (or documentation) to Dojo 2
Code Of Conduct - Guidelines for participation in all Dojo OSS communities.
Style Guide - The style guide for Dojo 2 for packages that do not use prettier
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.

Packages

There are several packages that makeup the Dojo 2 platform:

dojo/cli - Command Line Tooling for Dojo 2 Applications
- dojo/cli-build-app - A CLI command for building Dojo 2 applications
- dojo/cli-build-widget - A CLI command for building widgets
- dojo/cli-create-app - Command for creating application boilerplates
- dojo/cli-create-theme - Command for scaffolding a widget theme
- dojo/cli-create-widget - Command for creating a widget template and all associated boilerplate
- dojo/cli-export-project - Command for exporting project bundles
- dojo/cli-test-intern - Command for testing projects with Intern
dojo/core - The foundational code of the Dojo 2 platform
dojo/has - A feature detection library
dojo/interop - Interoperability with other frameworks (currently Dojo 1 Dijits and Redux)
dojo/i18n - A set of internationalization tooling
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 - A lightweight state container
dojo/streams - WHATWG Streams implementation
dojo/themes - Collection of Dojo 2 themes.
dojo/widget-core - The foundation code of Dojo 2 widgets
dojo/widgets - A set of rich UI elements

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/dgrid - Reactive extensive grid for Dojo 2
dojo/crypto - A set of libraries to deal with cryptography
dojo/dataviz - A data visualization library for Dojo 2

We have some deprecated packages:

dojo/actions - A command like library for Dojo 2 applications - This is deprecated because we have not found this abstraction to add value
dojo/app - An application framework for Dojo 2 - This is deprecated because widgets + routing + stores are sufficient to deal with higher order application concerns
dojo/cli-build-webpack - A legacy application and widget build command - *This is deprecated as it has been superseded by @dojo/cli-build-app and @dojo/cli-build-widget *
dojo/compose - A mixin/trait based composition library - This is deprecated because TypeScript now offers mixin behavior
dojo/dom - A set of APIs for manipulating the DOM - This is deprecated because Dojo 2 will fully abstract away DOM access.
dojo/interfaces - Common interfaces and types for Dojo 2 - This has been deprecated as interfaces now live in their respective repositories
dojo/parser - A HTML document parser for instantiating objects declaratively - This is deprecated in lieu of functionality provided using Custom Elements from @dojo/widget-core.

Examples

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

Support Packages

There are a few packages which are designed to make it easier to develop Dojo 2:

dojo/diagnostics - A set of modules that can be used to instrument Dojo 2 applications to provide additional diagnostic information.
dojo/devtool - A devtool extension for Chrome and Firefox that provides an interface to the dojo/diagnostics information.
dojo/test-extras - A set of modules to help with testing Dojo 2

There are several packages which are designed to support the Dojo 2 platform. Generally this packages are not directly used by end developers:

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.
dojo/grunt-dojo2-extras - Additional tasks and code supporting continuous delivery with Dojo 2 packages.
dojo/scripts - A package of scripts to aid with Dojo 2 package development.
dojo/webpack-contrib - Specialized webpack loaders and plugins used by the Dojo 2 toolchain.
dojo/web-editor - A web editor that can run projects exported from cli-export-project

Status

The following tables contain status information for the packages:

Package	CI Status	Code Coverage	npm	Stage
dojo/cli				2.0
dojo/core				2.0
dojo/has				2.0
dojo/interop				2.0
dojo/i18n				2.0
dojo/loader				2.0
dojo/routing				2.0
dojo/shim				2.0
dojo/stores				2.0
dojo/streams				Alpha
dojo/themes				2.0
dojo/widget-core				2.0
dojo/widgets				2.0

CLI Packages

The dojo/cli will provide extensible functionality via a variety of packages that can be plugged into the CLI.

Package	CI Status	Code Coverage	npm	Stage
dojo/cli-build-app				2.0
dojo/cli-build-widget				2.0
dojo/cli-create-app				2.0
dojo/cli-create-theme				2.0
dojo/cli-create-widget				2.0
dojo/cli-export-project				Alpha
dojo/cli-test-intern				2.0

Enhancements and Extensions

These are packages which provide extended functionality, usually to other tools, which are used by Dojo 2. For those using the out of the box tooling, there is little value in these packages, but for those having to integrate Dojo 2 into an existing development pipeline, these packages are likely to be of use.

Package	CI Status	Code Coverage	npm	Stage
dojo/devtool				Alpha
dojo/diagnostics				Alpha
dojo/webpack-contrib				RC2

Support Packages

In addition to dojo/cli there are some packages which are designed to be used both by the Dojo 2 team internally, but also others who are developing Dojo 2 applications: