Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ergebnis/twig-front-matter
🌱 + 👀 Provides a composer package with a Twig loader for files with YAML front-matter.
https://github.com/ergebnis/twig-front-matter
front-matter loader php twig yaml
Last synced: about 2 months ago
JSON representation
🌱 + 👀 Provides a composer package with a Twig loader for files with YAML front-matter.
- Host: GitHub
- URL: https://github.com/ergebnis/twig-front-matter
- Owner: ergebnis
- License: mit
- Created: 2023-07-06T20:54:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-25T04:57:00.000Z (9 months ago)
- Last Synced: 2024-05-01T11:41:19.988Z (8 months ago)
- Topics: front-matter, loader, php, twig, yaml
- Language: PHP
- Size: 697 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# twig-front-matter
[](https://github.com/ergebnis/twig-front-matter/actions)
[](https://github.com/ergebnis/twig-front-matter/actions)
[](https://github.com/ergebnis/twig-front-matter/actions)
[](https://github.com/ergebnis/twig-front-matter/actions)
[](https://codecov.io/gh/ergebnis/twig-front-matter)
[](https://shepherd.dev/github/ergebnis/twig-front-matter)
[](https://packagist.org/packages/ergebnis/twig-front-matter)
[](https://packagist.org/packages/ergebnis/twig-front-matter)
[](https://packagist.org/packages/ergebnis/twig-front-matter)
This project provides a [`composer`](https://getcomposer.org) package with a [Twig](https://twig.symfony.com) loader for files with [YAML front-matter](https://github.com/ergebnis/front-matter).
## Installation
Run
```sh
composer require ergebnis/twig-front-matter
```
## Usage
### Loading Twig templates with the `FrontMatterLoader`
This project ships with a [`FrontMatterLoader`](/src/FrontMatterLoader.php) that you can use to load Twig templates with YAML front-matter.
The `FrontMatterLoader`
- parses a Twig template and separates the front-matter from the body-matter using [`ergebnis/front-matter](https://github.com/ergebnis/front-matter)
- converts the front-matter data to Twig assignments using an implementation of [`Converter\FrontMatterConverter`](/src/Converter/FrontMatterConverter.php)
- returns a new Twig Source that merges the Twig assignments from the front-matter data with the body-matter from the Twig template
### YAML front-matter
Assume that you have a Twig template with the following YAML front-matter:
```yaml
foo: bar
number: 1234
pi: 3.14159
date: 2016-05-27
empty: ~
invalid-key: "hmm"
multiline: |
Multiple
Line
String
object:
key: value
datetime: 2020-11-12 12:54:12
values:
- one
- two
```
### Converting YAML front-matter to Twig assignments with the `Converter/ToMultipleAssignmentsFrontMatterConverter`
This project ships with a [`Converter/ToMultipleAssignmentsFrontMatterConverter.php`](/src/Converter/ToMultipleAssignmentsFrontMatterConverter.php) that you can use to convert the YAML front-matter to multiple Twig assignments.
The example below will convert the parsed YAML front-matter data to multiple Twig assignments that will assign data to Twig variables with force:
```php
declare(strict_types=1);
use Ergebnis\Twig;
$frontMatterConverter = new Twig\FrontMatter\Converter\ToMultipleAssignmentsFrontMatterConverter(true);
echo $frontMatterConverter->convert($data);
```
```twig
{% set foo = "bar" %}
{% set number = 1234 %}
{% set pi = 3.14159 %}
{% set date = (1464307200|date_modify('0sec')) %}
{% set empty = null %}
{% set multiline = "Multiple\nLine\nString\n" %}
{% set object = { key: "value", datetime: (1605185652|date_modify('0sec')), values: { 0: "one", 1: "two" } } %}
```
The example below will convert the parsed YAML front-matter data to multiple Twig assignments that will assign data to Twig variables without force (taking into account that you may pass variables to the template and prefer not to override these variables with front-matter):
```php
declare(strict_types=1);
use Ergebnis\Twig;
$frontMatterConverter = new Twig\FrontMatter\Converter\ToMultipleAssignmentsFrontMatterConverter(false);
echo $frontMatterConverter->convert($data);
```
```twig
{% set foo = foo is defined ? foo : "bar" %}
{% set number = number is defined ? number : 1234 %}
{% set pi = pi is defined ? pi : 3.14159 %}
{% set date = date is defined ? date : (1464307200|date_modify('0sec')) %}
{% set empty = empty is defined ? empty : null %}
{% set multiline = multiline is defined ? multiline : "Multiple\nLine\nString\n" %}
{% set object = object is defined ? object|merge({ key: "value", datetime: (1605185652|date_modify('0sec')), values: { 0: "one", 1: "two" } }) : { key: "value", datetime: (1605185652|date_modify('0sec')), values: { 0: "one", 1: "two" } } %}
```
### Converting YAML front-matter to a Twig assignment with the `Converter/ToSingleAssignmentFrontMatterConverter`
This project ships with a [`Converter/ToSingleAssignmentFrontMatterConverter.php`](/src/Converter/ToSingleAssignmentFrontMatterConverter.php) that you can use to convert the YAML front-matter to a single Twig assignment.
The example below will convert the parsed YAML front-matter data to a single Twig assignment that will assign data to a Twig variable with force:
```php
declare(strict_types=1);
use Ergebnis\Twig;
$frontMatterConverter = new Twig\FrontMatter\Converter\ToSingleAssignmentFrontMatterConverter(
Twig\Expression\Name::fromString('data'),
false,
);
echo $frontMatterConverter->convert($data);
```
```twig
{% set data = { foo: "bar", number: 1234, pi: 3.14159, date: (1464307200|date_modify('0sec')), empty: null, invalid-key: "hmm", multiline: "Multiple\\nLine\\nString\\n", object: { key: "value", datetime: (1605185652|date_modify('0sec')), values: { 0: "one", 1: "two" } } } %}
```
The example below will convert the parsed YAML front-matter data to a single Twig assignment that will assign data to a Twig variables without force (taking into account that you may pass a variable to the template and prefer not to override this variable with front-matter):
```php
declare(strict_types=1);
use Ergebnis\Twig;
$frontMatterConverter = new Twig\FrontMatter\Converter\ToSingleAssignmentFrontMatterConverter(
Twig\Expression\Name::fromString('data'),
false,
);
echo $frontMatterConverter->convert($data);
```
```twig
{% set data = data is defined ? data|merge({ foo: "bar", number: 1234, pi: 3.14159, date: (1464307200|date_modify('0sec')), empty: null, invalid-key: "hmm", multiline: "Multiple\\nLine\\nString\\n", object: { key: "value", datetime: (1605185652|date_modify('0sec')), values: { 0: "one", 1: "two" } } }) : { foo: "bar", number: 1234, pi: 3.14159, date: (1464307200|date_modify('0sec')), empty: null, invalid-key: "hmm", multiline: "Multiple\\nLine\\nString\\n", object: { key: "value", datetime: (1605185652|date_modify('0sec')), values: { 0: "one", 1: "two" } } } %}
```
### Configuring services in a Symfony project
Adjust your `config/services.php` as follows to register a `FrontMatterLoader` with a `Converter\ToMultipleAssignmentsFrontMatterConverter`:
```php
services();
$services->defaults()
->autoconfigure()
->autowire();
$services->alias(
FrontMatter\Parser::class,
FrontMatter\YamlParser::class,
);
$services->set(FrontMatter\YamlParser::class)
->class(FrontMatter\YamlParser::class);
$services->set(Twig\FrontMatter\Converter\FrontMatterConverter::class)
->class(Twig\FrontMatter\Converter\ToMultipleAssignmentsFrontMatterConverter::class)
->args([
'$force' => false, // or true, as you prefer
]);
$services->set(Twig\FrontMatter\FrontMatterLoader::class)
->args([
'$loader' => new DependencyInjection\Loader\Configurator\ReferenceConfigurator('twig.loader.native_filesystem'),
]);
});
```
## Changelog
The maintainers of this project record notable changes to this project in a [changelog](CHANGELOG.md).
## Contributing
The maintainers of this project suggest following the [contribution guide](.github/CONTRIBUTING.md).
## Code of Conduct
The maintainers of this project ask contributors to follow the [code of conduct](https://github.com/ergebnis/.github/blob/main/CODE_OF_CONDUCT.md).
## General Support Policy
The maintainers of this project provide limited support.
You can support the maintenance of this project by [sponsoring @localheinz](https://github.com/sponsors/localheinz) or [requesting an invoice for services related to this project](mailto:[email protected]?subject=ergebnis/twig-front-matter:%20Requesting%20invoice%20for%20services).
## PHP Version Support Policy
This project supports PHP versions with [active and security support](https://www.php.net/supported-versions.php).
The maintainers of this project add support for a PHP version following its initial release and drop support for a PHP version when it has reached the end of security support.
## Security Policy
This project has a [security policy](.github/SECURITY.md).
## License
This project uses the [MIT license](LICENSE.md).
## Social
Follow [@localheinz](https://twitter.com/intent/follow?screen_name=localheinz) and [@ergebnis](https://twitter.com/intent/follow?screen_name=ergebnis) on Twitter.