stream 2.1.0

  • README.md
  • Installing
  • Versions
  • 75

Stream

Stream is a Dart web server supporting request routing, filtering, template engine, WebSocket, MVC design pattern and file-based static resources.

Stream is distributed under an Apache 2.0 License.

Build Status

Installation

Add this to your pubspec.yaml (or create it):

dependencies:
  stream:

Usage

Compile RSP (Rikulo Stream Page) to dart files

There are two ways to compile RSP files into dart files: automatic building with Dart Editor or manual compiling.

RSP is a template technology allowing developers to create dynamically generated web pages based on HTML, XML or other document types (such as this and this). Please refer to here for more information.

Build with Dart Editor

To compile your RSP files automatically, you just need to add a build.dart file in the root directory of your project, with the following content:

import 'package:stream/rspc.dart';
void main(List<String> arguments) {
  build(arguments);
}

With this build.dart script, whenever your RSP is modified, it will be re-compiled.

Compile Manually

To compile a RSP file manually, run rspc (RSP compiler) to compile it into the dart file with command line interface as follows:

dart -c lib/rspc.dart -n dir1 dir2 file1 fire2...

A dart file is generated for each RSP file you gave. Fore more options, please run:

dart -c lib/rspc.dart -h

Notes to Contributors

Fork Stream

If you'd like to contribute back to the core, you can fork this repository and send us a pull request, when it is ready.

Please be aware that one of Stream's design goals is to keep the sphere of API as neat and consistency as possible. Strong enhancement always demands greater consensus.

If you are new to Git or GitHub, please read this guide first.

Who Uses

  • Quire - a simple, collaborative, multi-level task management tool.
  • Keikai - a sophisticated spreadsheet for big data

Use this package as an executable

1. Install it

You can install the package from the command line:


$ pub global activate stream

2. Use it

The package has the following executables:


$ rspc

Use this package as a library

1. Depend on it

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


dependencies:
  stream: ^2.1.0

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:stream/stream.dart';
  
Version Uploaded Documentation Archive
2.1.0 Nov 14, 2018 Go to the documentation of stream 2.1.0 Download stream 2.1.0 archive
2.0.3 Oct 19, 2018 Go to the documentation of stream 2.0.3 Download stream 2.0.3 archive
2.0.2 Oct 15, 2018 Go to the documentation of stream 2.0.2 Download stream 2.0.2 archive
2.0.1+1 Sep 7, 2018 Go to the documentation of stream 2.0.1+1 Download stream 2.0.1+1 archive
2.0.1 Aug 22, 2018 Go to the documentation of stream 2.0.1 Download stream 2.0.1 archive
2.0.0+1 Aug 14, 2018 Go to the documentation of stream 2.0.0+1 Download stream 2.0.0+1 archive
2.0.0 Aug 10, 2018 Go to the documentation of stream 2.0.0 Download stream 2.0.0 archive
1.7.0+4 Aug 21, 2018 Go to the documentation of stream 1.7.0+4 Download stream 1.7.0+4 archive
1.7.0+3 Jun 22, 2018 Go to the documentation of stream 1.7.0+3 Download stream 1.7.0+3 archive
1.7.0+2 May 23, 2018 Go to the documentation of stream 1.7.0+2 Download stream 1.7.0+2 archive

All 121 versions...

Popularity:
Describes how popular the package is relative to other packages. [more]
65
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
60
Overall:
Weighted score of the above. [more]
75
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:stream/stream.dart with components: io, mirrors.

Health suggestions

Fix lib/src/plugin/loader.dart. (-0.50 points)

Analysis of lib/src/plugin/loader.dart reported 1 hint:

line 83 col 16: Always override hashCode if overriding ==.

Format bin/rspc.dart.

Run dartfmt to format bin/rspc.dart.

Format lib/proxy.dart.

Run dartfmt to format lib/proxy.dart.

Fix additional 12 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/src/connect.dart (Run dartfmt to format lib/src/connect.dart.)
  • lib/src/connect_impl.dart (Run dartfmt to format lib/src/connect_impl.dart.)
  • lib/src/plugin/loader_impl.dart (Run dartfmt to format lib/src/plugin/loader_impl.dart.)
  • lib/src/plugin/router.dart (Run dartfmt to format lib/src/plugin/router.dart.)
  • lib/src/rsp_util.dart (Run dartfmt to format lib/src/rsp_util.dart.)
  • lib/src/rspc/build.dart (Run dartfmt to format lib/src/rspc/build.dart.)
  • lib/src/rspc/compiler.dart (Run dartfmt to format lib/src/rspc/compiler.dart.)
  • lib/src/rspc/main.dart (Run dartfmt to format lib/src/rspc/main.dart.)
  • lib/src/rspc/tag.dart (Run dartfmt to format lib/src/rspc/tag.dart.)
  • lib/src/rspc/tag_util.dart (Run dartfmt to format lib/src/rspc/tag_util.dart.)
  • lib/src/server.dart (Run dartfmt to format lib/src/server.dart.)
  • lib/src/server_impl.dart (Run dartfmt to format lib/src/server_impl.dart.)

Maintenance issues and suggestions

Maintain CHANGELOG.md. (-20 points)

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

Use constrained dependencies. (-20 points)

The pubspec.yaml contains 6 dependencies without version constraints. Specify version ranges for the following dependencies: args, charcode, http, logging, path, rikulo_commons.

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 stream.dart. Packages with multiple examples should use example/readme.md.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev <3.0.0
args any 1.5.1
charcode any 1.1.2
http any 0.12.0
logging any 0.11.3+2
path any 1.6.2
rikulo_commons any 3.1.0+1
Transitive dependencies
async 2.0.8
collection 1.14.11
http_parser 3.1.3
meta 1.1.6
mime 0.9.6+2
source_span 1.4.1
string_scanner 1.0.4
typed_data 1.1.6