build_web_compilers 0.4.4+2

build_web_compilers #

Web compilers for users of package:build.
Build Status Issues related to build_web_compilers Pub Package Version Latest Dartdocs Join the chat on Gitter

Installation #

This package is intended to be used as a development dependency for users of package:build who want to run code in a browser. Simply add the following to your pubspec.yaml:


Usage #

If you are using the autogenerated build script (going through pub run build_runner <command> instead of handwriting a build.dart file), then all you need is the dev_dependency listed above.

Configuration #

By default, the dartdevc compiler will be used, which is the Dart Development Compiler.

If you would like to opt into dart2js you will need to add a build.yaml file, which should look roughly like the following:

        # These are globs for the entrypoints you want to compile.
        - test/**.browser_test.dart
        - web/**.dart
          compiler: dart2js
          # List any dart2js specific args here, or omit it.
          - --checked

We are working on command line configuration as well, you can follow for updates on that.

Manual Usage #

If you are using a custom build script, you will need to add the following builder applications to what you already have, almost certainly at the end of the list (unless you need to post-process the js files).

        (_) => new ModuleBuilder(),
        (_) => new UnlinkedSummaryBuilder(),
        (_) => new LinkedSummaryBuilder(),
        (_) => new DevCompilerBuilder()
        // Recommended, but not required. This makes it so only modules that are
        // imported by entrypoints get compiled.
        isOptional: true,
        hideOutput: true),
        // You can also use `WebCompiler.Dart2Js`. If you don't care about
        // dartdevc at all you may also omit the previous builder application
        // entirely.
        [(_) => new WebEntrypointBuilder(WebCompiler.DartDevc)], toRoot(),
        hideOutput: true,
        // These globs should match your entrypoints only.
        defaultGenerateFor: const InputSet(
            include: const ['web/**', 'test/**.browser_test.dart'])),

0.4.4+2 #

  • Support package:analyzer version 0.33.x.

0.4.4+1 #

  • Support package:build_modules version 1.x.x.

0.4.4 #

  • Track performance of different builder stages.

0.4.3+1 #

  • Removed dependency on cli_util.
  • Fix error in require.js error handling code

0.4.3 #

  • Only call window.postMessage during initialization if the current context is a Window.
  • Fixed an error while showing stack traces for DDC generated scripts when <base> tag is used.
  • Value of <base href="/.../"> tag should start and end with a / to be used as the base url for require js.
  • Added more javascript code to dev bootstrap for hot-reloading support
  • Support the latest build_modules.

0.4.2+2 #

  • Add magic comment marker for build_runner to know where to inject live-reloading client code. This is only present when using the dartdevc compiler. (reapplied)

0.4.2+1 #

  • Restore new keyword for a working release on Dart 1 VM.

0.4.2 #

  • Add magic comment marker for build_runner to know where to inject live-reloading client code. This is only present when using the dartdevc compiler.
  • Release broken on Dart 1 VM.

0.4.1 #

  • Support the latest build_modules, with updated dart2js support so that it can do multiple builds concurrently and will restart workers periodically to mitigate the effects of dart-lang/sdk#33708.
  • Improvements to reduce the memory usage of the dart2js builder, so that transitive dependency information can be garbage collected before the dart2js compile is completed.
  • Increased the upper bound for the sdk to <3.0.0.

0.4.0+5 #

  • Fixed an issue where subdirectories with hyphens in the name weren't bootstrapped properly in dartdevc.

0.4.0+4 #

  • Expand support for package:build_config to include version 0.3.x.

0.4.0+3 #

  • Expand support for package:archive to include version 2.x.x.

0.4.0+2 #

  • Fix a dart2 error.

0.4.0+1 #

  • Support package:analyzer 0.32.0.

0.4.0 #

  • Changed the default for enable_sync_async to true for the build_web_compilers|entrypoint builder.
  • Changed the default for ignore_cast_failures to false for the build_web_compilers|entrypoint builder.

0.3.8 #

  • Remove .dart sources and files from the output directory in release mode.
  • Clean up .tar.gz outputs produced by Dart2Js.
  • Don't output extra Dart2Js outputs other than deferred part files.
  • Fixed a logical error in dartdevc compiler to detect correct base url for require js.
  • Added a enable_sync_async option to the build_web_compilers|entrypoint builder, which defaults to false.

0.3.7+3 #

  • The dartdevc compiler now respects the <base href="/...."> tags and will set them as the base url for require js.

0.3.7+2 #

  • Fix sdk stack trace folding in the browser console and package:test.

0.3.7+1 #

  • Add missing dependency on the pool package.

0.3.7 #

  • Reduce memory usage by requesting (and lazily building) lower level modules first when building for an entrypoint.

0.3.6 #

  • Add support for compiling with dart2js by default in release mode.

0.3.5 #

  • Don't ignore cast failures by default. We expect most code to be clean with cast failures, and the option can be manually enabled with config.

0.3.4+2 #

  • Create .packages file and use the new frontend with dart2js.

0.3.4+1 #

  • Use --use-old-frontend with dart2js as a stopgap until we can add support for .packages files.

0.3.4 #

  • Added support for dart2js deferred loading.
  • Added support for bootstrapping code in web workers with dartdevc.

0.3.3 #

  • Added support for --dump-info and the dart2js compiler. If you pass that argument with dart2js_args the .info.json file will be copied the output.

0.3.2 #

  • Dart2JS now has minification (--minify) enabled by default, similar to how it worked in pub build. If you are adding custom dart2js options, make sure you still keep the --minify flag. Here is an example:
        - web/**.dart
          compiler: dart2js
          - --fast-startup
          - --minify
          - --trust-type-annotations
          - --trust-primitives

0.3.1 #

  • Cast failures will now be ignored in dartdevc by default (these were enabled in the latest sdk), and added an ignore_cast_failures option to the build_web_compilers|entrypoint builder which you can set to true to enable them.
    • At some point in the future it is expected that the default for this will flip.

0.3.0+1 #

  • Fixed an issue with dart2js and the --no-source-maps flag.

0.3.0 #

Breaking changes #

  • Split ModuleBuilder, UnlinkedSummaryBuilder and LinkedSummaryBuilder into a separate build_modules package.

0.2.1+1 #

  • Support the latest analyzer package.

0.2.1 #

  • All dart files under test are now compiled by default instead of only the _browser_test.dart files (minus vm/node test bootstrap files). This means the original tests can be debugged directly (prior to package:test bootstrapping).
  • Updated to package:build version 0.12.0.

0.2.0 #

New Features #

  • Added support for dart2js. This can be configured using the top level compiler option for the build_web_compilers|entrypoint builder. The supported options are dartdevc (the default) and dart2js. Args can be passed to dart2js using the dart2js_args option. For example:
          compiler: dart2js
          - --minify

Breaking Changes #

  • Renamed ddc_bootstrap builder to entrypoint, the exposed class also changed from DevCompilerBootstrapBuilder to WebEntrypointBuilder.
  • Renamed jsBootstrapExtension to ddcBootstrapExtension since it is only required when using the dev compiler.

0.1.1 #

  • Mark ddc_bootstrap builder with build_to: cache.
  • Publish as build_web_compilers

0.1.0 #

  • Add builder factories.
  • Fixed temp dir cleanup bug on windows.
  • Enabled support for running tests in --precompiled mode.

0.0.1 #

  • Initial release with support for building analyzer summaries and DDC modules.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:

  build_web_compilers: ^0.4.4+2

2. Install it

You can install packages from the command line:

with pub:

$ pub get

with Flutter:

$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:build_web_compilers/build_web_compilers.dart';
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

We analyzed this package on Jan 29, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.4

Maintenance issues and suggestions

Support latest dependencies. (-30 points)

The version constraint in pubspec.yaml does not support the latest published versions for 3 dependencies (analyzer, build_config, build_modules).

Package is getting outdated. (-30.68 points)

The package was last published 68 weeks ago.

The package description is too short. (-12 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and build_web_compilers.dart. Packages with multiple examples should provide example/

For more information see the pub package layout conventions.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
analyzer >=0.30.0 <0.34.0 0.33.6+1 0.39.4
archive >=1.0.13 <3.0.0 2.0.13
bazel_worker ^0.1.4 0.1.23
build >=0.12.8 <2.0.0 1.1.0 1.2.2
build_config >=0.2.6 <0.4.0 0.3.2 0.4.1+1
build_modules >=0.4.0 <2.0.0 1.0.11 2.8.0
crypto >=0.9.2 <3.0.0 2.1.4
glob ^1.1.0 1.2.0
js ^0.6.1 0.6.1+1
logging ^0.11.2 0.11.4
path ^1.4.2 1.6.4
pool ^1.3.0 1.4.0
pub_semver ^1.3.7 1.4.2
scratch_space ^0.0.2 0.0.4+2
source_maps ^0.10.4 0.10.8
source_span ^1.4.0 1.6.0
stack_trace ^1.9.2 1.9.3
Transitive dependencies
args 1.5.2
async 2.4.0
charcode 1.1.2
checked_yaml 1.0.2
collection 1.14.12
convert 2.1.1
csslib 0.16.1
fixnum 0.10.11
front_end 0.1.6+9 0.1.29
graphs 0.2.0
html 0.14.0+3
json_annotation 2.4.0 3.0.1
kernel 0.3.6+9 0.3.29
meta 1.1.8
node_interop 1.0.3
node_io 1.0.1+2
package_config 1.1.0 2.0.0
pedantic 1.9.0
plugin 0.2.0+3
protobuf 1.0.1
pubspec_parse 0.1.5
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
watcher 0.9.7+13
yaml 2.2.0
Dev dependencies
build_test ^0.10.0
test ^1.0.0