angel_hot 1.1.1+1

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 81

hot

Pub

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_hot: ^1.0.0

Usage

This package is dependent on the Dart VM service, so you must run Dart with the --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 pointless.

You can watch:

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

main() async {
  var hot = new HotReloader(createServer, [
    new Directory('config'),
    new Directory('lib'),
    new Directory('web'),
    new Directory('src'),
    'bin/server.dart',
    Uri.parse('some_file.dart'),
    Uri.parse('package:angel_hot/angel_hot.dart')
  ]);
  
  var server = await hot.startServer(InternetAddress.LOOPBACK_IP_V4, 3000);
  print(
      'Hot server listening at http://${server.address.address}:${server.port}');
}

Future<Angel> createServer() async {
  var app = new Angel();

  app.lazyParseBodies = true;
  app.injectSerializer(JSON.encode);

  app.get('/', {'hello': 'hot world!'});
  
  app.post('/foo/bar', (req, res) async {
    var result = await someLengthyOperation();
    return {'status': result};
  });

  app.after.add(() => throw new AngelHttpException.notFound());

  app.responseFinalizers.add(gzip());
  await app.configure(logRequests());
  return app;
}

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.

Use this package as a library

1. Depend on it

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


dependencies:
  angel_hot: ^1.1.1+1

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
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
1.0.0-rc.3 Jun 6, 2017 Go to the documentation of angel_hot 1.0.0-rc.3 Download angel_hot 1.0.0-rc.3 archive
1.0.0-rc.2 Jun 6, 2017 Go to the documentation of angel_hot 1.0.0-rc.2 Download angel_hot 1.0.0-rc.2 archive
1.0.0-rc.1 Jun 6, 2017 Go to the documentation of angel_hot 1.0.0-rc.1 Download angel_hot 1.0.0-rc.1 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
71
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
81
Learn more about scoring.

We analyzed this package on Aug 10, 2018, and provided a score, details, and suggestions below. Analysis was completed with status tool failures using:

  • Dart: 2.0.0
  • pana: 0.11.8

Platforms

Detected platforms: unsure

Error(s) prevent platform classification:

Fix dependencies in pubspec.yaml.

Issues and suggestions

Fix dependencies in pubspec.yaml.

Running pub upgrade failed with the following output:

ERR: The current Dart SDK version is 2.0.0.
 
 Because angel_websocket >=1.0.0-dev+1 <1.1.2 requires SDK version <2.0.0 and angel_websocket >=1.1.2 depends on uuid ^0.5.3, angel_websocket >=1.0.0-dev+1 requires uuid ^0.5.3.
 So, because uuid >=0.0.7 <1.0.3 requires SDK version <2.0.0 and angel_hot depends on angel_websocket ^1.1.0-alpha, version solving failed.

Fix platform conflicts.

Error(s) prevent platform classification:

Fix dependencies in pubspec.yaml.

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.

Format lib/angel_hot.dart.

Run dartfmt to format lib/angel_hot.dart.

Maintain an example.

None of the files in your example/ directory matches a known example patterns. Common file name patterns include: main.dart, example.dart or you could also use angel_hot.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.19.0 <3.0.0