🚀 Dojo 2 - meta information for the project.
Clone or download

README.md

Dojo Logo

dojo-meta

Join the chat at https://gitter.im/dojo/dojo2

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.

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:

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

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:

Status

The following tables contain status information for the packages:

Package CI Status Code Coverage npm Stage
dojo/cli Build Status codecov.io npm version 2.0
dojo/core Build Status codecov.io npm version 2.0
dojo/has Build Status codecov.io npm version 2.0
dojo/interop Build Status codecov.io npm version 2.0
dojo/i18n Build Status codecov.io npm version 2.0
dojo/loader Build Status codecov.io npm version 2.0
dojo/routing Build Status codecov.io npm version 2.0
dojo/shim Build Status codecov.io npm version 2.0
dojo/stores Build Status codecov.io npm version 2.0
dojo/streams Build Status codecov.io npm version Alpha
dojo/themes Build Status codecov.io npm version 2.0
dojo/widget-core Build Status codecov.io npm version 2.0
dojo/widgets Build Status codecov.io npm version 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 Build Status codecov.io npm version 2.0
dojo/cli-build-widget Build Status codecov.io npm version 2.0
dojo/cli-create-app Build Status codecov.io npm version 2.0
dojo/cli-create-theme Build Status codecov.io npm version 2.0
dojo/cli-create-widget Build Status codecov.io npm version 2.0
dojo/cli-export-project Build Status codecov.io npm version Alpha
dojo/cli-test-intern Build Status codecov.io npm version 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 Build Status codecov.io npm version Alpha
dojo/diagnostics Build Status codecov.io npm version Alpha
dojo/webpack-contrib Build Status codecov.io npm version 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:

Package CI Status Code Coverage npm Stage
dojo/test-extras Build Status codecov.io npm version 2.0
dojo/web-editor Build Status codecov.io npm version Alpha

Proposed packages

Package CI Status Code Coverage npm Stage
dojo/crypto
dojo/dataviz Build Status
dojo/dgrid Build Status codecov.io npm version Alpha

Example app packages

Package CI Status Code Coverage
dojo/examples Build Status codecov.io

Internal packages

Package CI Status Code Coverage npm Stage
dojo/grunt-dojo2 Build Status codecov.io npm version 2.0
dojo/grunt-dojo2-extras Build Status codecov.io npm version 2.0
dojo/scripts Build Status codecov.io npm version Alpha

Deprecated packages

Package CI Status Code Coverage npm
dojo/actions Build Status codecov.io
dojo/app Build Status codecov.io
dojo/cli-build-webpack Build Status codecov.io npm version
dojo/compose Build Status codecov.io npm version
dojo/dom Build Status codecov.io
dojo/interfaces Build Status npm version
dojo/parser
dojo/cli-css-typings

Licensing information

© 2018 JS Foundation & contributors. New BSD license.