rewrites 0.1.0

  • README.md
  • Installing
  • Versions
  • 53

PubServe Rewrites

This library is highly experimental and its purpose is to be used during development.

Feedback and PR's are welcome

Why

To help pub serve to support apps using HTML5 pushState for navigation during development.

Rewrite uses pattern matching to check if a given URL will be ignored or if changed to a new destination URL.

Install

> pub global activate --source git https://github.com/adaojunior/pub_serve_rewrites.git

How to use

Create a rewrites.yaml file in the root of your project (same folder as your pubspec.yaml) and setup your rewrite rules.

In the example bellow all json|html|js|dart|css|png will be ignored and the server proxied decide what will be served.

When the browser makes a request to eg: /admin/dashboard it will receive the content of admin.html.

All others requests that are not ignored or that matches with /admin/(.*) will be proxied to index.html.

# rewrites.yaml
ignore:
- ^(\S+\.(json|html|js|dart|css|png))$
rewrites:
- rewrite: /admin/(.*)
  to: admin.html
- rewrite: (.*)
  to: index.html

Run the following code in your terminal

> rewrites

If you need help run the command bellow

> rewrites --help

Use this package as an executable

1. Install it

You can install the package from the command line:


$ pub global activate rewrites

2. Use it

The package has the following executables:


$ rewrites

Use this package as a library

1. Depend on it

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


dependencies:
  rewrites: "^0.1.0"

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:rewrites/rewrites.dart';
  
Version Uploaded Documentation Archive
0.1.0 Nov 29, 2016 Go to the documentation of rewrites 0.1.0 Download rewrites 0.1.0 archive

Analysis

We analyzed this package on Jun 19, 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]
34 / 100
Health:
Code health derived from static analysis. [more]
97 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
36 / 100
Overall score:
Weighted score of the above. [more]
53
Learn more about scoring.

Platforms

Detected platforms: Flutter, other

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

Suggestions

  • Maintain CHANGELOG.md.

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

  • Package is getting outdated.

    The package was released 81 weeks ago.

  • 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.

  • 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 rewrites.dart.

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 4 hints.

    Run dartfmt to format lib/src/parser.dart.

    Run dartfmt to format lib/src/proxy.dart.

    Similar analysis of the following files failed:

    • lib/src/pubserve.dart (hint)

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.8.0 <2.0.0
args ^0.13.2 0.13.7 1.4.3
shelf_proxy ^0.1.0+2 0.1.0+4
yaml ^2.1.7 2.1.14
Transitive dependencies
async 2.0.7
charcode 1.1.1
collection 1.14.10
http 0.11.3+16
http_parser 3.1.2
path 1.6.1
shelf 0.7.3+1
source_span 1.4.0
stack_trace 1.9.2
stream_channel 1.6.7+1
string_scanner 1.0.2
typed_data 1.1.5
Dev dependencies
test >=0.12.0 <0.13.0