Contents

dart2js: Dart-to-JavaScript compiler

Contents

Use the dart2js compiler to compile Dart code to deployable JavaScript. Another Dart-to-JavaScript compiler, dartdevc, is for development use only. The webdev build command uses dart2js by default. The webdev serve command uses dartdevc by default, but you can switch to dart2js using the --release flag.

The dart2js compiler provides hints and warnings for improving your Dart code. Also see dart analyze, which performs further analysis.

This page tells you how to use the dart2js compiler. It also give tips on debugging the JavaScript that dart2js generates.

Basic usage

Here’s an example of compiling a Dart file to JavaScript:

$ dart compile js -O2 -o test.js test.dart

This command produces a file that contains the JavaScript equivalent of your Dart code. It also produces a source map, which can help you debug the JavaScript version of the app more easily.

Build config usage

You can also configure dart2js options in a build config file when using the webdev tool or build_runner. For more information, see the build_web_compilers package.

Options

Basic options

Common options for the dart2js compiler include:

-o <file> or --output=<file>
Generates the output into <file>. If not specified, the output goes in a file named out.js.
--enable-asserts
Enables assertion checking.
-O{0|1|2|3|4}
Controls optimizations that can help reduce code size and improve performance of the generated code. For more details on these optimizations, run dart compile js -hv.
  • -O0: Disables many optimizations.
  • -O1: Enables default optimizations.
  • -O2: Enables -O1 optimizations, plus additional ones (such as minification) that respect the language semantics and are safe for all programs.
  • -O3: Enables -O2 optimizations, plus omits implicit type checks.
  • -O4: Enables more aggressive optimizations than -O3, but with the same assumptions.
--no-source-maps
Do not generate a source map file.
-h or --help
Displays help. To get information about all options, use -hv.

Path and environment options

Some other handy options include:

--packages=<path>
Specifies the path to the package resolution configuration file. For more information, see Dart Package Configuration File.
-D<flag>=<value>
Defines an environment variable.
--version
Displays version information for dart2js.

Display options

The following options help you control the output of dart2js:

--suppress-warnings
Doesn’t display warnings.
--suppress-hints
Doesn’t display hints.
--terse
Emits diagnostics, without suggesting how to get rid of the diagnosed problems.
-v or --verbose
Displays lots of information.

Analysis options

The following options control the analysis that dart2js performs on Dart code:

--fatal-warnings
Treat warnings as compilation errors.
--enable-diagnostic-colors
Adds colors to diagnostic messages.
--show-package-warnings
Shows warnings and hints generated from packages.
--csp
Disables dynamic generation of code in the generated output. This is necessary to satisfy CSP restrictions (see W3C Content Security Policy.)
--dump-info
Generates a file (with the suffix .info.json) that contains information about the generated code. You can inspect the generated file with tools in dart2js_info.

Helping dart2js generate better code

Follow these practices to help dart2js do better type inference, so it can generate smaller and faster JavaScript code:

  • Don’t use Function.apply().
  • Don’t override noSuchMethod().
  • Avoid setting variables to null.
  • Be consistent with the types of arguments you pass into each function or method.

Debugging

This section gives tips for debugging dart2js-produced code in Chrome, Firefox, and Safari. Debugging the JavaScript produced by dart2js is easiest in browsers such as Chrome that support source maps.

Whichever browser you use, you should enable pausing on at least uncaught exceptions, and perhaps on all exceptions. For frameworks such as dart:async that wrap user code in try-catch, we recommend pausing on all exceptions.

Chrome

To debug in Chrome:

  1. Open the Developer Tools window, as described in the Chrome DevTools documentation.
  2. Turn on source maps, as described in the video SourceMaps in Chrome.
  3. Enable debugging, either on all exceptions or only on uncaught exceptions, as described in How to set breakpoints.
  4. Reload your app.

Edge

To debug in Edge:

  1. Update to the latest version of Edge.
  2. Load Developer Tools (F12). For more information, see Using the F12 developer tools.
  3. Reload the app. The debugger tab shows source-mapped files.
  4. Exception behavior can be controlled through Ctrl+Shift+E; the default is Break on unhandled exceptions.

Firefox

To debug in Firefox:

  1. Open the Web Developer Tools window, as described in the Firefox developer tools documentation.

  2. Enable Pause on exceptions, as shown in the following figure:

    Enable Pause on exceptions in Firefox debugger

  3. Reload the app. The Debugger tab shows source-mapped files.

Safari

To debug in Safari:

  1. Turn on the Develop menu, as described in the Safari Web Inspector Tutorial.
  2. Enable breaks, either on all exceptions or only on uncaught exceptions. See Add a JavaScript breakpoint under Safari Developer Help.
  3. Reload your app.