jael 1.0.0

  • README.md
  • Installing
  • Versions
  • 50

jael

Pub build status

A simple server-side HTML templating engine for Dart.

See documentation.

Installation

In your pubspec.yaml:

dependencies:
  jael: ^1.0.0-beta

API

The core jael package exports classes for parsing Jael templates, an AST library, and a Renderer class that generates HTML on-the-fly.

import 'package:code_buffer/code_buffer.dart';
import 'package:jael/jael.dart' as jael;
import 'package:symbol_table/symbol_table.dart';

void myFunction() {
    const template = '''
<html>
  <body>
    <h1>Hello</h1>
    <img src=profile['avatar']>
  </body>
</html>
''';

    var buf = new CodeBuffer();
    var document = jael.parseDocument(template, sourceUrl: 'test.jl');
    var scope = new SymbolTable(values: {
      'profile': {
        'avatar': 'thosakwe.png',
      }
    });

    const jael.Renderer().render(document, buf, scope);
    print(buf);
}

Pre-processing (i.e. handling of blocks and includes) is handled by package:jael_preprocessor..

1. Depend on it

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


dependencies:
  jael: "^1.0.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:jael/jael.dart';
        
Version Uploaded Documentation Archive
1.0.0 Nov 28, 2017 Go to the documentation of jael 1.0.0 Download jael 1.0.0 archive
1.0.0-beta+3 Oct 17, 2017 Go to the documentation of jael 1.0.0-beta+3 Download jael 1.0.0-beta+3 archive
1.0.0-beta+2 Oct 16, 2017 Go to the documentation of jael 1.0.0-beta+2 Download jael 1.0.0-beta+2 archive
1.0.0-beta+1 Oct 16, 2017 Go to the documentation of jael 1.0.0-beta+1 Download jael 1.0.0-beta+1 archive
1.0.0-beta Oct 2, 2017 Go to the documentation of jael 1.0.0-beta Download jael 1.0.0-beta archive
1.0.0-alpha+5 Oct 2, 2017 Go to the documentation of jael 1.0.0-alpha+5 Download jael 1.0.0-alpha+5 archive
1.0.0-alpha+4 Oct 2, 2017 Go to the documentation of jael 1.0.0-alpha+4 Download jael 1.0.0-alpha+4 archive
1.0.0-alpha+3 Oct 1, 2017 Go to the documentation of jael 1.0.0-alpha+3 Download jael 1.0.0-alpha+3 archive
1.0.0-alpha+2 Oct 1, 2017 Go to the documentation of jael 1.0.0-alpha+2 Download jael 1.0.0-alpha+2 archive
1.0.0-alpha+1 Sep 30, 2017 Go to the documentation of jael 1.0.0-alpha+1 Download jael 1.0.0-alpha+1 archive

All 11 versions...

Analysis

This feature is new.
We welcome feedback.
More details: scoring.

We analyzed this package, and provided a score, details, and suggestions below.

  • completed on Feb 3, 2018
  • Dart: 2.0.0-dev.20.0
  • pana: 0.10.1

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
9 / 100
Health:
Code health derived from static analysis. [more]
99 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80 / 100
Overall score:
Weighted score of the above. [more]
50

Platforms

Detected platforms: web, other

Primary library: package:jael/jael.dart with components: mirrors.

Suggestions

  • Maintain CHANGELOG.md.

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

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

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

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.19.0
charcode ^1.0.0 1.1.1
code_buffer ^1.0.0 1.0.0
source_span ^1.0.0 1.4.0
string_scanner ^1.0.0 1.0.2
symbol_table ^1.0.0 1.0.4
Transitive dependencies
path 1.5.1
Dev dependencies
test ^0.12.0