govuk frontend jinja

gov.uk frontend jinja macros

Gov.uk Frontend Jinjaは、Gov.uk設計システムのコミュニティツールです。設計システムチームはそれに対して責任を負わず、それを使用することであなたをサポートすることはできません。ヘルプが必要な場合、または機能をリクエストする場合は、メンテナーに直接お問い合わせください。

このリポジトリは、元のgov.uk frontend nunjucksマクロに最新の状態に保たれ、100％準拠したジンジャマクロの完全なセットを提供します。ポーティングは、自動化された変換ルーチンを維持するよりもアップデートをより簡単にするために自動化されるのではなく、意図的にマニュアルです。包括的なテストスイートは、最新の、そしてその後のすべてのgov.ukフロントエンドのリリースに対するコンプライアンスを保証します。

gov.uk frontend jinjaおよびgov.uk frontend wtformsと統合された完全に機能するフラスコアプリの構築を検討している場合は、gov.uk frontend flaskテンプレートリポジトリを使用してアプリを生成してください。

互換性

次の表は、gov.uk frontendのターゲットバージョンに使用する必要があるgov.uk frontend jinjaのバージョンを示しています。

gov.uk frontend jinjaバージョン	ターゲットgov.ukフロントエンドバージョン
3.4.0	5.7.1
3.3.0	5.6.0
3.2.0	5.5.0
3.1.0	5.4.0
3.0.0	5.1.0
2.8.0	4.8.0
2.7.0	4.7.0
2.6.0	4.6.0
2.5.0	4.5.0
2.4.0	4.4.1
2.3.0	4.2.0
2.2.0	4.1.0
2.1.0	4.0.1
2.0.0	4.0.0
1.6.0	3.15.0
1.5.1	3.14.0
1.4.0	3.13.0
1.3.0	3.12.0
1.2.1	3.11.0
1.1.0	3.10.2
1.0.0	3.8.1
0.2.1	3.7.0

上記の他のバージョンのgov.uk frontendは、依然として互換性があるかもしれませんが、具体的にテストおよび検証されていません。

使い方

pip install govuk-frontend-jinja実行した後、 PackageLoaderの使用からテンプレートをロードする場所をJinjaに伝えてください。

 from flask import Flask
from jinja2 import ChoiceLoader , PackageLoader , PrefixLoader

app = Flask ( __name__ )

app . jinja_loader = ChoiceLoader (
    [
        PackageLoader ( "app" ),
        PrefixLoader ({ "govuk_frontend_jinja" : PackageLoader ( "govuk_frontend_jinja" )}),
    ]
)

テンプレートでマクロを呼び出します

プロジェクトテンプレートでコンポーネントを使用するには、コンポーネントマクロをインポートして呼び出し、関連するオプションを渡す必要があります。

{%- from 'govuk_frontend_jinja/components/button/macro.html' import govukButton -%}
{{ govukButton({ 'text': "Save and continue" }) }}

各コンポーネントマクロが利用できるオプションは、元のgov.uk設計システムコンポーネントドキュメントにあります。このプロジェクトは同様のポートであるため、Nunjucksの例とJinjaの同等物の唯一の違いは、 textの代わりに'text'などのキー名を引用する必要があります。

テストの実行

テストはGitHubアクションパイプラインで実行されますが、ローカルで実行したい場合は、Govuk-Frontend-Diffをインストールする必要があります。

tests/utils/app.pyにテストサーバーがあり、次のコマンドを使用して実行する必要があります。

(cd tests/utils && python -m flask run --port 3000)

次のように、 govuk-frontend-diffを使用してテストを実行できます。

./govuk-frontend-diff http://localhost:3000 --govuk-frontend-version=v4.8.0

これはすべて、単純化されたランニングのために./test.shに包まれています（Dockerが必要です）。

バージョン化

バージョン化にはSemverを使用しています。利用可能なバージョンについては、このリポジトリのタグを参照してください。

貢献する方法

コミュニティからの貢献を歓迎します。このプロジェクトに貢献したい場合は、行動規範と貢献ガイドラインを確認してください。

方法論を更新します

gov.uk frontendの新しいリリースに続いてこのパッケージを更新する方法：

1. govuk-frontendで、最後の互換性のあるタグと最新のタグ、例：https：//github.com/alphagov/govuk-frontend/compare/v4.3.1...v4.4.0を比較してください。
2. package/govuk/components/<component>/template.njkにテンプレートに変更がある場合は、diffを読み取り、 govuk_frontend_jinja/templates/components/<component>/macro.htmlのJinja同等のテンプレートに同じ変更を適用します。
3. NunjucksとJinjaがそのテンプレートをどのように解釈するかの間の特異性を考慮してください。たとえば、ネストされた属性のチェックNone 、Arrayアイテムの長さまたはis 、 not 、 inのロジック演算子を確認します。
4. 上記のようにテストを実行します
5. 予想されるHTML出力をテストツールによって報告された実際のHTMLと比較することにより、失敗テストを解決します
6. 上記の互換性テーブルに新しい行を追加して、gov.uk Frontendのバージョンを表示します。このパッケージの次のリリースがターゲットになります。
7. すべてのテストが合格したら、貢献ガイドラインに従ってプルリクエストを提起します。
8. プルリクエストがマージされた後、Semverコンベンションに続いて新しいリリースとタグを作成します。
9. GitHubアクションは、新しいタグで実行され、パッケージを構築し、Pypiに公開します。プロジェクトページをチェックして、パッケージが最新リリースタグで更新されたことを確認します

貢献者

• マットショー（プライマリメンテナー）
• アンディ・マンテル（元の著者）

Githubの貢献者の完全なリストを参照してください

サポート

このソフトウェアには、保証なしで「AS-IS」が提供されます。サポートは、メンテナーとオープンソースコミュニティによって「最良の努力」ベースで提供されます。

あなたが公務員の場合は、英国政府のデジタルスラックワークスペースにサインアップして、＃Govuk-Design-System Channelでこのプロジェクトを使用しているメンテナーとこのプロジェクトを使用している人々のコミュニティに連絡してください。

それ以外の場合は、バグレポートまたは機能リクエストを提起する方法については、貢献ガイドラインをご覧ください。