jael 1.0.4

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

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

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

  • Skip HTML comments in free text.

1.0.3

  • Fix a scanner bug that prevented proper parsing of HTML nodes followed by free text.
  • Don't trim <textarea> content.

1.0.2

  • Use package:dart2_constant.
  • Upgrade package:symbol_table.
  • Added Renderer.errorDocument.

1.0.1

  • Reworked the scanner; thereby fixing an extremely pesky bug that prevented successful parsing of Jael files containing JavaScript.

example/main.dart

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

main() {
  while (true) {
    var buf = new StringBuffer();
    int ch;
    print('Enter lines of Jael text, terminated by CTRL^D.');
    print('All environment variables are injected into the template scope.');

    while ((ch = stdin.readByteSync()) != $eot && ch != -1) {
      buf.writeCharCode(ch);
    }

    var document = jael.parseDocument(
      buf.toString(),
      sourceUrl: 'stdin',
      onError: stderr.writeln,
    );

    if (document == null) {
      stderr.writeln('Could not parse the given text.');
    } else {
      var output = new CodeBuffer();
      const jael.Renderer().render(
        document,
        output,
        new SymbolTable(values: Platform.environment),
        strictResolution: false,
      );
      print('GENERATED HTML:\n$output');
    }
  }
}

1. Depend on it

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


dependencies:
  jael: "^1.0.4"

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.4 Apr 3, 2018 Go to the documentation of jael 1.0.4 Download jael 1.0.4 archive
1.0.3 Apr 3, 2018 Go to the documentation of jael 1.0.3 Download jael 1.0.3 archive
1.0.2 Apr 3, 2018 Go to the documentation of jael 1.0.2 Download jael 1.0.2 archive
1.0.1 Apr 3, 2018 Go to the documentation of jael 1.0.1 Download jael 1.0.1 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

All 15 versions...

Analysis

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

  • Dart: 2.0.0-dev.46.0
  • pana: 0.10.6

Scores

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

Platforms

Detected platforms: web, other

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

Suggestions

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

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 1 hint.

    Strong-mode analysis of lib/src/renderer.dart gave the following hint:

    line: 276 col: 26
    Equality operator == invocation with references of unrelated types.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.19.0 <=2.0.0
charcode ^1.0.0 1.1.1
code_buffer ^1.0.0 1.0.0
dart2_constant ^1.0.0 1.0.1+dart2
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