kernel 0.3.3

  • README.md
  • Installing
  • Versions
  • 93

Dart Kernel

Dart Kernel is a small high-level language derived from Dart. It is designed for use as an intermediate format for whole-program analysis and transformations, and as a frontend for codegen and execution backends.

The kernel language has in-memory representations in Dart and C++, and can be serialized as binary or text.

Both the kernel language and its implementations are unstable and are under development.

This package contains the Dart part of the implementation and contains:

  • A transformable IR for the kernel language
  • A frontend based on the analyzer
  • Serialization of kernel code

Note: The APIs in this package are in an early state; developers should be careful about depending on this package. In particular, there is no semver contract for release versions of this package. Please depend directly on individual versions.

Getting Kernel

Checkout the repository and run pub get:

git clone https://github.com/dart-lang/kernel
cd kernel
pub get

Command-Line Tool

Run tool/dartk.dart from the command-line to convert between .dart files and the serialized binary and textual formats.

dartk expects the .dill extension for files in the binary format. The textual format has no preferred extension right now.

Example commands:

dartk foo.dart            # print text IR for foo.dart
dartk foo.dart -ofoo.dill # write binary IR for foo.dart to foo.dill
dartk foo.dill            # print text IR for binary file foo.dill

Pass the --link or -l flag to link all transitive dependencies into one file:

dartk myapp.dart -ppackages -l -omyapp.dill # Bundle everything.
dartk myapp.dill # Print it back out in a (very, very long) textual format.

See ast.dart for the in-memory IR, or binary.md for a description of the binary format. For now, the textual format is very ad-hoc and cannot be parsed back in.

Testing

If you plan to make changes to kernel, get a checkout of the Dartk SDK and run:

tool/regenerate_dill_files.dart --sdk <path to SDK checkout>
pub run test

Linking

Linking from binary files is not yet implemented. In order to compile a whole program, currently everything must be compiled from source at once.

Use this package as a library

1. Depend on it

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


dependencies:
  kernel: "^0.3.3"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

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

3. Import it

Now in your Dart code, you can use:


      import 'package:kernel/kernel.dart';
  
Version Uploaded Documentation Archive
0.3.3 Jul 4, 2018 Go to the documentation of kernel 0.3.3 Download kernel 0.3.3 archive
0.3.2 Jun 26, 2018 Go to the documentation of kernel 0.3.2 Download kernel 0.3.2 archive
0.3.1 May 30, 2018 Go to the documentation of kernel 0.3.1 Download kernel 0.3.1 archive
0.3.0 May 14, 2018 Go to the documentation of kernel 0.3.0 Download kernel 0.3.0 archive
0.2.0 Apr 21, 2017 Go to the documentation of kernel 0.2.0 Download kernel 0.2.0 archive
0.1.0 Oct 20, 2016 Go to the documentation of kernel 0.1.0 Download kernel 0.1.0 archive
0.3.0-alpha.12 Apr 30, 2018 Go to the documentation of kernel 0.3.0-alpha.12 Download kernel 0.3.0-alpha.12 archive
0.3.0-alpha.11 Mar 22, 2018 Go to the documentation of kernel 0.3.0-alpha.11 Download kernel 0.3.0-alpha.11 archive
0.3.0-alpha.10 Feb 14, 2018 Go to the documentation of kernel 0.3.0-alpha.10 Download kernel 0.3.0-alpha.10 archive
0.3.0-alpha.9 Feb 9, 2018 Go to the documentation of kernel 0.3.0-alpha.9 Download kernel 0.3.0-alpha.9 archive

All 16 versions...

Analysis

We analyzed this package on Jul 13, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0-dev.63.0
  • pana: 0.11.3

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
94 / 100
Health:
Code health derived from static analysis. [more]
100 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80 / 100
Overall score:
Weighted score of the above. [more]
93
Learn more about scoring.

Platforms

Detected platforms: Flutter, other

Primary library: package:kernel/kernel.dart with components: io.

Suggestions

  • Maintain CHANGELOG.md.

    Changelog entries help clients to follow the progress in your code.

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 7 hints.

    Strong-mode analysis of lib/ast.dart gave the following hint:

    line: 4593 col: 17
    Always override hashCode if overriding ==.

    Strong-mode analysis of lib/class_hierarchy.dart gave the following hint:

    line: 1410 col: 12
    Invocation of Iterable<E>.contains with references of unrelated types.

  • Maintain an example.

    Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use kernel.dart.

  • Enable strong mode analysis.

    Strong mode helps you to detect bugs and potential issues earlier.Start your analysis_options.yaml file with the following:

    analyzer:
      strong-mode: true
    

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.48.0 <2.0.0
args >=0.13.4 <2.0.0 1.4.3
logging ^0.11.2 0.11.3+1
package_config ^1.0.0 1.0.3
path ^1.3.9 1.6.1
Transitive dependencies
charcode 1.1.2
Dev dependencies
analyzer >=0.31.0 <0.33.0
front_end 0.1.3
stack_trace ^1.6.6
test ^0.12.15+6
test_reflective_loader ^0.1.0
testing