Skip to content

Commit f54337d

Browse files
Merge branch 'release/0.7.25'
2 parents 94eaff8 + f20c1f1 commit f54337d

11 files changed

Lines changed: 130 additions & 201 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,95 +1,5 @@
11
# Contributing
22

3-
Thanks for considering contributing to this extension! :slightly_smiling_face:
3+
Please have a look in the [official documentation][1].
44

5-
Since it is an open source product, its successful further development
6-
depends largely on improving and optimizing it together.
7-
8-
The development of this extension follows the official
9-
[TYPO3 coding standards](https://github.com/TYPO3/coding-standards).
10-
To ensure the stability and cleanliness of the code, various code
11-
quality tools are used and most components are covered with test
12-
cases.
13-
14-
## Create an issue first
15-
16-
Before you start working on the extension, please create an issue on
17-
GitHub: https://github.com/CPS-IT/handlebars/issues
18-
19-
Also, please check if there is already an issue on the topic you want
20-
to address.
21-
22-
## Contribution workflow
23-
24-
**Note: This extension follows [Semantic Versioning](https://semver.org/).**
25-
26-
### Preparation
27-
28-
Clone the repository first:
29-
30-
```bash
31-
git clone https://github.com/CPS-IT/handlebars.git
32-
cd handlebars
33-
```
34-
35-
Now install all Composer dependencies:
36-
37-
```bash
38-
composer install
39-
```
40-
41-
### Check code quality
42-
43-
[![CGL](https://github.com/CPS-IT/handlebars/actions/workflows/cgl.yaml/badge.svg)](https://github.com/CPS-IT/handlebars/actions/workflows/cgl.yaml)
44-
45-
```bash
46-
# Run all linters
47-
composer lint
48-
49-
# Run Composer normalization
50-
composer lint:composer
51-
52-
# Run PHP linter only
53-
composer lint:php
54-
55-
# Run TypoScript linter only
56-
composer lint:typoscript
57-
58-
# Run PHP static code analysis
59-
composer sca
60-
```
61-
62-
### Run tests
63-
64-
[![Tests](https://github.com/CPS-IT/handlebars/actions/workflows/tests.yaml/badge.svg)](https://github.com/CPS-IT/handlebars/actions/workflows/tests.yaml)
65-
[![Coverage](https://codecov.io/gh/CPS-IT/handlebars/branch/develop/graph/badge.svg?token=6TDD6TVHQH)](https://codecov.io/gh/CPS-IT/handlebars)
66-
67-
```bash
68-
# Run tests
69-
composer test
70-
71-
# Run tests with code coverage
72-
composer test:coverage
73-
```
74-
75-
The code coverage reports will be stored in `.Build/log/coverage`.
76-
77-
### Build documentation
78-
79-
```bash
80-
# Rebuild and open documentation
81-
composer docs
82-
83-
# Build documentation (from cache)
84-
composer docs:build
85-
86-
# Open rendered documentation
87-
composer docs:open
88-
```
89-
90-
The built docs will be stored in `.Build/docs`.
91-
92-
### Pull Request
93-
94-
When you have finished developing your contribution, simply submit a
95-
pull request on GitHub: https://github.com/CPS-IT/handlebars/pulls
5+
[1]: https://docs.typo3.org/p/cpsit/typo3-handlebars/main/en-us/Contributing/Index.html

Classes/Exception/TemplateCompilationException.php

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,4 @@
2929
* @author Elias Häußler <e.haeussler@familie-redlich.de>
3030
* @license GPL-2.0-or-later
3131
*/
32-
final class TemplateCompilationException extends \RuntimeException
33-
{
34-
}
32+
final class TemplateCompilationException extends \RuntimeException {}

Classes/Exception/UnableToPresentException.php

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,4 @@
2929
* @author Elias Häußler <e.haeussler@familie-redlich.de>
3030
* @license GPL-2.0-or-later
3131
*/
32-
final class UnableToPresentException extends \RuntimeException
33-
{
34-
}
32+
final class UnableToPresentException extends \RuntimeException {}

Classes/Renderer/Helper/HelperInterface.php

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,4 @@
2929
* @author Elias Häußler <e.haeussler@familie-redlich.de>
3030
* @license GPL-2.0-or-later
3131
*/
32-
interface HelperInterface
33-
{
34-
}
32+
interface HelperInterface {}

Documentation/Contributing/Index.rst

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,18 +69,26 @@ Check code quality
6969
# Run all linters
7070
composer lint
7171
72-
# Run Composer normalization
72+
# Run specific linters
7373
composer lint:composer
74-
75-
# Run PHP linter only
74+
composer lint:editorconfig
7675
composer lint:php
77-
78-
# Run TypoScript linter only
7976
composer lint:typoscript
8077
81-
# Run PHP static code analysis
78+
# Fix all CGL issues
79+
composer fix
80+
81+
# Fix specific CGL issues
82+
composer fix:composer
83+
composer fix:editorconfig
84+
composer fix:php
85+
86+
# Run all static code analyzers
8287
composer sca
8388
89+
# Run specific static code analyzers
90+
composer sca:php
91+
8492
.. _run-tests:
8593

8694
Run tests

Documentation/Settings.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[general]
22
project = Handlebars
3-
release = 0.7.24
3+
release = 0.7.25
44
copyright = since 2020 by coding. powerful. systems. CPS GmbH
55
author = Elias Häußler
66

Resources/Private/Libs/Build/composer.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

composer.json

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,15 +88,23 @@
8888
"docs:build": "docker-compose run --rm docs",
8989
"docs:cleanup": "rm -rf .Build/docs",
9090
"docs:open": "open .Build/docs/Result/project/0.0.0/Index.html",
91+
"fix": [
92+
"@fix:composer",
93+
"@fix:editorconfig",
94+
"@fix:php"
95+
],
96+
"fix:composer": "@composer normalize",
97+
"fix:editorconfig": "@lint:editorconfig --fix",
98+
"fix:php": "php-cs-fixer fix",
9199
"lint": [
92100
"@lint:composer",
93101
"@lint:editorconfig",
94102
"@lint:php",
95103
"@lint:typoscript"
96104
],
97-
"lint:composer": "@composer normalize",
98-
"lint:editorconfig": "ec --fix -e .Build",
99-
"lint:php": "php-cs-fixer fix",
105+
"lint:composer": "@fix:composer --dry-run",
106+
"lint:editorconfig": "ec -e .Build",
107+
"lint:php": "@fix:php --dry-run",
100108
"lint:typoscript": "typoscript-lint -c typoscript-lint.yml",
101109
"migration": [
102110
"@migration:rector"

0 commit comments

Comments
 (0)