angel_hot 2.0.3

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 78

hot

Pub

Screenshot of terminal

Supports hot reloading of Angel servers on file changes. This is faster and more reliable than merely reactively restarting a Process.

This package only works with the Angel framework.

Installation

In your pubspec.yaml:

dependencies:
  angel_framework: ^2.0.0-alpha
  angel_hot: ^2.0.0

Usage

This package is dependent on the Dart VM service, so you must run Dart with the --observe (or --enable-vm-service) argument!!!

Usage is fairly simple. Pass a function that creates an Angel server, along with a collection of paths to watch, to the HotReloader constructor. The rest is history!!!

The recommended pattern is to only use hot-reloading in your application entry point. Create your Angel instance within a separate function, conventionally named createServer.

Using this in production mode is not recommended, unless you are specifically intending for a "hot code push" in production..

You can watch:

  • Files
  • Directories
  • Globs
  • URI's
  • package: URI's
import 'dart:async';
import 'dart:convert';
import 'dart:io';
import 'package:angel_framework/angel_framework.dart';
import 'package:angel_hot/angel_hot.dart';
import 'package:logging/logging.dart';
import 'src/foo.dart';

main() async {
  var hot = new HotReloader(createServer, [
    new Directory('src'),
    new Directory('src'),
    'main.dart',
    Uri.parse('package:angel_hot/angel_hot.dart')
  ]);
  await hot.startServer('127.0.0.1', 3000);
}

Future<Angel> createServer() async {
  var app = new Angel()..serializer = json.encode;

  // Edit this line, and then refresh the page in your browser!
  app.get('/', (req, res) => {'hello': 'hot world!'});
  app.get('/foo', (req, res) => new Foo(bar: 'baz'));

  app.fallback((req, res) => throw new AngelHttpException.notFound());

  app.encoders.addAll({
    'gzip': gzip.encoder,
    'deflate': zlib.encoder,
  });

  app.logger = new Logger('angel')
    ..onRecord.listen((rec) {
      print(rec);
      if (rec.error != null) {
        print(rec.error);
        print(rec.stackTrace);
      }
    });

  return app;
}

2.0.3

  • Fixed up manual restart.
  • Remove stutter on hotkey press.

2.0.2

  • Fixed for compatibility with package:angel_websocket@^2.0.0-alpha.5.

2.0.1

2.0.0

  • Update for Dart 2 + Angel 2.

1.1.1+1

  • Fix a bug that threw when --observe was not present.

1.1.1

  • Disable the observatory from pausing the isolate on exceptions, because Angel already handles all exceptions by itself.

example/main.dart

import 'dart:async';
import 'dart:convert';
import 'dart:io';
import 'package:angel_framework/angel_framework.dart';
import 'package:angel_hot/angel_hot.dart';
import 'package:logging/logging.dart';
import 'src/foo.dart';

main() async {
  var hot = new HotReloader(createServer, [
    new Directory('src'),
    new Directory('src'),
    'main.dart',
    Platform.script,
    Uri.parse('package:angel_hot/angel_hot.dart')
  ]);
  await hot.startServer('127.0.0.1', 3000);
}

Future<Angel> createServer() async {
  var app = new Angel()..serializer = json.encode;

  // Edit this line, and then refresh the page in your browser!
  app.get('/', (req, res) => {'hello': 'hot world!'});
  app.get('/foo', (req, res) => new Foo(bar: 'baz'));

  app.fallback((req, res) => throw new AngelHttpException.notFound());

  app.encoders.addAll({
    'gzip': gzip.encoder,
    'deflate': zlib.encoder,
  });

  app.logger = new Logger('angel')
    ..onRecord.listen((rec) {
      print(rec);
      if (rec.error != null) {
        print(rec.error);
        print(rec.stackTrace);
      }
    });

  return app;
}

Use this package as a library

1. Depend on it

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


dependencies:
  angel_hot: ^2.0.3

2. Install it

You can install packages from the command line:

with pub:


$ pub get

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

3. Import it

Now in your Dart code, you can use:


import 'package:angel_hot/angel_hot.dart';
  
Version Uploaded Documentation Archive
2.0.3 Nov 9, 2018 Go to the documentation of angel_hot 2.0.3 Download angel_hot 2.0.3 archive
2.0.2 Nov 6, 2018 Go to the documentation of angel_hot 2.0.2 Download angel_hot 2.0.2 archive
2.0.1 Nov 2, 2018 Go to the documentation of angel_hot 2.0.1 Download angel_hot 2.0.1 archive
2.0.0 Oct 2, 2018 Go to the documentation of angel_hot 2.0.0 Download angel_hot 2.0.0 archive
1.1.1+1 Jun 8, 2018 Go to the documentation of angel_hot 1.1.1+1 Download angel_hot 1.1.1+1 archive
1.1.1 Jun 7, 2018 Go to the documentation of angel_hot 1.1.1 Download angel_hot 1.1.1 archive
1.1.0 Dec 7, 2017 Go to the documentation of angel_hot 1.1.0 Download angel_hot 1.1.0 archive
1.0.1 Jun 14, 2017 Go to the documentation of angel_hot 1.0.1 Download angel_hot 1.0.1 archive
1.0.0 Jun 12, 2017 Go to the documentation of angel_hot 1.0.0 Download angel_hot 1.0.0 archive
1.1.0-alpha Oct 19, 2017 Go to the documentation of angel_hot 1.1.0-alpha Download angel_hot 1.1.0-alpha archive

All 13 versions...

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

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

  • Dart: 2.1.0
  • pana: 0.12.7

Platforms

Detected platforms: other

Primary library: package:angel_hot/angel_hot.dart with components: io, isolate, mirrors.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev <3.0.0
angel_framework ^2.0.0-alpha 2.0.0-alpha.14
angel_websocket ^2.0.0-alpha 2.0.0-alpha.7
charcode ^1.0.0 1.1.2
glob ^1.0.0 1.1.7
html_builder ^1.0.0 1.0.5
io ^0.3.2 0.3.3
vm_service_lib ^0.3.5 0.3.10
watcher ^0.9.0 0.9.7+10
Transitive dependencies
angel_auth 2.0.2
angel_client 2.0.0-alpha.2
angel_container 1.0.0
angel_http_exception 1.0.0+3
angel_model 1.0.0+1
angel_route 3.0.0
async 2.0.8
body_parser 1.1.1
code_buffer 1.0.1
collection 1.14.11
combinator 1.0.0+3
convert 2.0.2
crypto 2.0.6
dart2_constant 1.0.2+dart2
file 5.0.6
http2 0.1.9
http_parser 3.1.3
http_server 0.9.8+1
intl 0.15.7
json_god 2.0.0-beta+3
matcher 0.12.4
merge_map 1.0.1
meta 1.1.6
mime 0.9.6+2
mock_request 1.0.4
path 1.6.2
quiver 2.0.1
source_span 1.4.1
stack_trace 1.9.3
stream_channel 1.6.8
string_scanner 1.0.4
tuple 1.0.2
typed_data 1.1.6
uuid 1.0.3
web_socket_channel 1.0.9
Dev dependencies
http ^0.11.3 0.12.0
logging ^0.11.0 0.11.3+2