6187b80ce6 | ||
---|---|---|
modules | ||
scripts | ||
tools/transpiler | ||
.gitignore | ||
.travis.yml | ||
LICENSE | ||
README.md | ||
file2modulename.js | ||
gulpfile.js | ||
karma-dart.conf.js | ||
karma-js.conf.js | ||
karma.conf.js | ||
package.json | ||
pubspec.yaml | ||
test-main.dart | ||
test-main.js | ||
traceur-runtime-patch.js |
README.md
Build
Prerequisites:
npm install
npm install -g gulp karma karma-cli
- Install the Dart SDK
- Add the Dart SDK's
bin
directory to your system path gulp build
pub get
Folder structure
modules/*
: modules that will be loaded in the browsertools/*
: tools that are needed to build Angular
File endings
*.js
: javascript files that get transpiled to Dart and EcmaScript 5*.es6
: javascript files that get transpiled only to EcmaScript 5*.es5
: javascript files that don't get transpiled*.dart
: dart files that don't get transpiled
Build:
gulp build
-> result is inbuild
folder
- will also run
pub get
for the subfolders inmodules
and rundartanalyzer
for every file that matches<module>/src/<module>.dart
, e.g.di/src/di.dart
gulp clean
-> cleans thebuild
folder
Tests:
karma start karma-js.conf.js
: JS testskarma start karma-dart.conf.js
: Dart tests
Notes for all tests:
The karma preprocessor is setup in a way so that after every test run the transpiler is reloaded. With that it is possible to make changes to the preprocessor and run the tests without exiting karma (just touch a test file that you would like to run).
Restriction for Dart tests (for now):
- Due to a bug
karma-dart
plugin, this will use the files in thebuild
folder for resolvingpackage:
dependencies (created e.g. forimport ... from 'di:di'
). So you need to executegulp build
before this.
Examples:
To see the examples, first build the project as described above.
Hello World Example
This example consists of three basic pieces - a component, a decorator and a service.
They are all constructed via injection. For more information see the comments in the
source modules/examples/src/hello_world/app.js
.
You can build this example as either JS or Dart app:
- (JS)
gulp serve
and openlocalhost:8000/js/examples/lib/hello_world/
in Chrome. - (Dart)
gulp examples/pub.serve
and openlocalhost:8080
in Chrome(for dart2js) or dartium(for dart vm).
Debug the transpiler
If you need to debug the transpiler:
- add a
debugger;
statement in the transpiler code, - from the root folder, execute
node debug node_modules/.bin/gulp build
to enter the node debugger - press "c" to execute the program until you reach the
debugger;
statement, - you can then type "repl" to enter the REPL and inspect variables in the context.
See the Node.js manual for more information.
Notes:
- You can also execute
node node_modules/.bin/karma start karma-dart.conf.js
depending on which code you want to debug (the former will process the "modules" folder while the later processes the transpiler specs), - You can also add
debugger;
statements in the specs (JavaScript). The execution will halt when the developer tools are opened in the browser running Karma.
Debug the tests
If you need to debug the tests:
- add a
debugger;
statement to the test you want to debug (oe the source code), - execute karma
node_modules/karma/bin/karma start karma-js.conf.js
, - press the top right "DEBUG" button,
- open the dev tools and press F5,
- the execution halt at the
debugger;
statement
Note (WebStorm users):
You can create a Karma run config from WebStorm.
Then in the "Run" menu, press "Debug 'karma-js.conf.js'", WebStorm will stop in the generated code
on the debugger;
statement.
You can then step into the code and add watches.
The debugger;
statement is needed because WebStorm will stop in a transpiled file. Breakpoints in
the original source files are not supported at the moment.