Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation in template files #6

Merged
merged 15 commits into from
Mar 19, 2024
Merged

Conversation

davidhoelzel
Copy link
Member

@davidhoelzel davidhoelzel commented Mar 8, 2024

Dieser PR ermöglicht es, die Komponenten-Konfiguration direkt in den templates anzugeben. Hierfür wird in den templates ein Twig-Comment Block verwendet.
Über einen konfigurierbaren identifier (default: TWIG_DOC) wird dann in einem Compiler-Pass die Konfiguration aus allen templates extrahiert, mit der Konfiguration aus der Bundle-Konfiguration gemerged und dem ComponentService als Konstruktor-Argument übergeben. Es werden nur templates beachtet die einen entsprechenden Block beinhalten.

Es ist nun auch möglich, die Verzeichnisse zu konfigurieren in denen nach Komponenten gesucht wird. Als default wird %twig.default_path%/components verwendet. Zusätzlich können weitere Verzeichnisse angegeben werden. Der Compiler-Pass ignoriert alle Verzeichnisse die nicht existieren.

Die Dokumentation wurde entsprechend angepasst.

- minor fixes
- directories can now be configured
- add directory resources to rebuild container on template changes
add performance test
test componentItemFactory with real services to capture violations
# Conflicts:
#	src/Component/ComponentItemFactory.php
#	tests/Functional/Service/ComponentItemFactoryTest.php
@davidhoelzel davidhoelzel requested a review from y4roc March 8, 2024 12:05
# Conflicts:
#	composer.json
#	src/Component/ComponentItemFactory.php
#	src/Controller/TwigDocController.php
#	src/DependencyInjection/Configuration.php
#	src/DependencyInjection/TwigDocExtension.php
#	src/Service/ComponentService.php
#	src/Twig/TwigDocExtension.php
#	tests/Functional/Service/ComponentItemFactoryTest.php
#	tests/Unit/Component/ComponentItemFactoryTest.php
- merge from main
@davidhoelzel davidhoelzel merged commit f3c1607 into main Mar 19, 2024
2 checks passed
@davidhoelzel davidhoelzel deleted the doc-in-template-parser branch March 19, 2024 07:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide possibility to give component documentation directly in template
1 participant