README.md

TYPO3 extension handlebars_components

Additional components for the TYPO3 CMS extension "handlebars"

Installation

First, register the Git repository in your composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "[email protected]:typo3/handlebars-components.git"
    }
  ]
}

Now require the package with Composer:

composer require fr/typo3-handlebars-components

Features

Handlebars components

• Page rendering
• Pagination

Handlebars helpers

• block, content and extend helpers from handlebars-layouts
• render helper from Fractal

Handlebars template resolvers

• Flat template resolver from Fractal

Services

• Configuration service
• Media service
• Menu service

Configuration

Several features can be enabled or disabled via extension configuration. This includes, for example, helpers and template resolvers.

Please note that all available features are enabled by default!

Contributing

Thank you for considering contributing to this extension! The following quality assurance measures are in place and should be performed before each contribution.

Preparation

Since some tests need to be executed with a full TYPO3 setup, make sure you start the underlying DDEV project:

ddev start
ddev composer install

It is recommended to exclude the .Build directory in your IDE from indexing.

Linting

ddev composer lint
# or
ddev composer lint:php
# or
ddev composer lint:typoscript

Static code analysis

ddev composer sca
# or
ddev composer sca:php

Note: Sometimes it's necessary to increase the PHP memory limit. This can be done by appending -- --memory-limit=2G, for example.

Tests

Without coverage:

ddev composer test
# or
ddev composer test:functional
# or
ddev composer test:unit

With coverage report:

ddev composer test:ci
# or
ddev composer test:ci:functional
# or
ddev composer test:ci:unit

To merge coverage reports, run ddev composer test:ci:merge.

License

This project is licensed under GNU General Public License 2.0 (or later).