パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v0.7.2

jinja

Dart用のJinja2テンプレートエンジン。変数、式、制御構造、テンプレート継承。

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
4.9万
いいね数
48
Pub ポイント
160

パッケージをインストール

flutter pub add jinja

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

Jinja は Jinja2 テンプレートエンジンの Dart 実装であり、変数、式、制御構造、テンプレート継承を用いた動的コンテンツ生成を可能にします。サーバーサイドレンダリングをサポートし、ウェブフレームワークと良好に統合されます。バックエンドサービスおよびウェブアプリケーションでの使用を想定しており、強力なテンプレート機能によりロジックとプレゼンテーションを分離できます。このパッケージは、モバイル、Web、デスクトップを含むすべての主要プラットフォームで動作します。

用途

  • サーバーサイドレンダリング
  • 動的HTML生成
  • テンプレートベースのコンテンツ作成
  • Webアプリケーションレイアウト
  • API駆動型テンプレート
  • マルチプラットフォームテンプレート

主な機能

  • 変数および式のサポート
  • 制御構造(if、for)
  • テンプレート継承
  • クロスプラットフォーム互換性
  • 軽量で高速
  • Dart アプリとの簡単な統合

適している対象

  • バックエンド開発者
  • フルスタックWeb開発者
  • テンプレート駆動型アプリケーション
  • サーバー側レンダリングされたWebアプリ
  • DartベースのWebフレームワーク

注意事項

  • クライアント側のレンダリングを想定していません
  • 限られたドキュメント
  • Jinja2構文の理解が必要です
  • サーバー環境に最適
  • 組み込みのセキュリティフィルタなし
  • ユーザー入力に対して追加の検証が必要になる場合があります

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

jinja

Pub Package Test Status CodeCov

Jinja (3.x) server-side template engine port for Dart 3. Variables, expressions, control structures and template inheritance.

Documentation

It is mostly similar to Jinja templates documentation, differences provided below.

work in progress.

Differences with Python version

  • Auto-escaping and related statements, filters and tests have been removed due to the impossibility of extending String. Use the escape filter manually or escape values before passing them to the template.
  • The default filter compares values with null.
  • The defined and undefined tests compare values with null.
  • The map filter also compares values with null. Use attribute and item filters for object.attribute and object[item] expressions.
  • If Environment({getAttribute}) is not passed, the getItem method will be used. This allows you to use {{ map.key }} as an expression equivalent to {{ map['key'] }}.
  • String slices and negative indexes are not supported (list slicing [start:stop] with non-negative integers is supported).
  • Macro arguments without default values are required.
  • No FilterArgumentError error class.
  • No *args and **kwargs arguments.
  • No Template module.
  • work in progress

Dynamically invoked members (can increase the size of the JS output)

  • [], +, -, *, /, ~/, % operators
  • object.length getter
  • object.call getter
  • Function.apply(function, ...)

Example

import 'package:jinja/jinja.dart';

// ...

var environment = Environment(blockStart: '...', blockEnd: '...');
var template = environment.fromString('...source...');
print(template.render({'key': value}));
// or write directly to StringSink (IOSink, HttpResponse, ...)
template.renderTo(stringSink, {'key': value});

See also examples with conduit and reflectable.

Status:

TODO:
  • Informative error messages
    • Template name 🔥
    • Source span 🔥
  • Template class:
    • generate method
    • stream method
  • Relative template paths
  • Async Support
  • Template Inheritance
    • Super Blocks
      • {{ super.super() }}
  • List of Control Structures
    • Extends
      • Execute non-block statements and expressions
        {% extends 'base.html' %}
        {% set title = 'Index' %}
        {% macro header() %}
          <h1>{{ title }}</h1>
        {% endmacro %}      ```
        {% block body %}
          {{ header() }}
        {% endblock %}
        
  • Expressions
    • Dart Methods and Properties
      • !./?.
  • Loaders
    • PackageLoader (VM)
    • ...
  • List of Global Functions
    • lipsum
    • cycler
    • joiner
  • Extensions
    • i18n
    • Loop Controls
    • Debug Statement
  • Template compiler (builder)
  • ...
Done:

Note: item - not supported

  • Variables
  • Filters
    • forceescape
    • safe
    • unsafe
  • Tests
    • escaped
  • Comments
  • Whitespace Control
  • Escaping (only escape filter)
  • Line Statements
    • Comments
    • Blocks
  • Template Inheritance
    • Base Template
    • Child Template
    • Super Blocks
    • Nesting extends
    • Named Block End-Tags
    • Block Nesting and Scope
    • Required Blocks
    • Template Objects
  • HTML Escaping
  • List of Control Structures
    • For
    • If
    • Macro
    • Call
    • Filters
    • Assignments
    • Block Assignments
    • Extends
    • Blocks
    • Include
    • Import
    • Try / Catch
  • Import Context Behavior
  • Expressions with filters and tests
    • Literals
      • "Hello World"
      • 42 / 123_456
      • 42.23 / 42.1e2 / 123_456.789
      • ['list', 'of', 'objects']
      • ('tuple', 'of', 'values')
      • {'dict': 'of', 'key': 'and', 'value': 'pairs'}
      • true / false
      • null
    • Math
      • +
      • -
      • /
      • //
      • %
      • *
      • **
    • Comparisons
      • ==
      • !=
      • >
      • >=
      • <
      • <=
    • Logic
      • and
      • or
      • ?? (null-coalescing / fallback)
      • not
      • (expr)
    • Other Operators
      • in
      • is
      • |
      • ~
      • ()
      • ./[]
      • [:] (list slice)
    • Conditional Expressions
      • {{ list.last if list }}
      • {{ user.name if user else 'Guest' }}
      • {{ condition ? 'yes' : 'no' }} (ternary operator)
    • Dart Methods and Properties (if reflection is on)
      • {{ string.toUpperCase() }}
      • {{ list.add(item) }}
  • List of Global Functions
    • dict
    • print
    • range
    • list
    • namespace
  • Loaders
    • FileSystemLoader
    • MapLoader (equivalent to Jinja's DictLoader)
  • Extensions
    • Expression Statement (do)
    • With Statement
  • Autoescape Overrides

Contributing

Contributions are welcome! Please open an issue or pull request on GitHub. Look at the ToDo list and comments in the code for ideas on what to work on. There are no strict rules, but please try to follow the existing code style.

As non-native English speaker and learner, I will be grateful for any corrections in the documentation and code comments.

Support

Post issues and feature requests on the GitHub issue tracker.

カテゴリー

依存関係

依存関係一覧 5 件

ソースリポジトリ

このパッケージを使用しているプロジェクト