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.

Sign up for GitHub

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

Jump to bottom

Added configuration for commonmark use in twig-extra-bundle. #3737

Open
wants to merge 1 commit into
base: 3.x
Choose a base branch
from
Open

Added configuration for commonmark use in twig-extra-bundle. #3737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions extra/twig-extra-bundle/DependencyInjection/Configuration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

namespace Twig\Extra\TwigExtraBundle\DependencyInjection;

use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
use Twig\Extra\TwigExtraBundle\Extensions;
Expand All @@ -35,6 +36,63 @@ public function getConfigTreeBuilder()
;
}

$this->addCommonMarkConfiguration($rootNode);

return $treeBuilder;
}

/**
* Full configuration from {@link https://commonmark.thephpleague.com/2.3/configuration}.
*/
private function addCommonMarkConfiguration(ArrayNodeDefinition $rootNode): void
{
$rootNode
->children()
->arrayNode('commonmark')
->ignoreExtraKeys()
->children()
->arrayNode('renderer')
->info('Array of options for rendering HTML.')
->children()
->scalarNode('block_separator')->end()
->scalarNode('inner_separator')->end()
->scalarNode('soft_break')->end()
->end()
->end()
->enumNode('html_input')
->info('How to handle HTML input.')
->values(['strip','allow','escape'])
->end()
->booleanNode('allow_unsafe_links')
->info('Remove risky link and image URLs by setting this to false.')
->defaultTrue()
->end()
->integerNode('max_nesting_level')
->info('The maximum nesting level for blocks.')
->defaultValue(PHP_INT_MAX)
->end()
->arrayNode('slug_normalizer')
->info('Array of options for configuring how URL-safe slugs are created.')
->children()
->variableNode('instance')->end()
->integerNode('max_length')->defaultValue(255)->end()
->variableNode('unique')->end()
->end()
->end()
->arrayNode('commonmark')
->info('Array of options for configuring the CommonMark core extension.')
->children()
->booleanNode('enable_em')->defaultTrue()->end()
->booleanNode('enable_strong')->defaultTrue()->end()
->booleanNode('use_asterisk')->defaultTrue()->end()
->booleanNode('use_underscore')->defaultTrue()->end()
->arrayNode('unordered_list_markers')
->scalarPrototype()->end()
->defaultValue([['-', '*', '+']])->end()
->end()
->end()
->end()
->end()
->end();
}
}
6 changes: 6 additions & 0 deletions extra/twig-extra-bundle/DependencyInjection/TwigExtraExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ public function load(array $configs, ContainerBuilder $container)

if ('markdown' === $extension && \class_exists(CommonMarkConverter::class)) {
$loader->load('markdown_league.php');

if ($container->hasDefinition('twig.markdown.league_common_mark_converter_factory')) {
$container
->getDefinition('twig.markdown.league_common_mark_converter_factory')
->setArgument('$config', $config['commonmark'] ?? []);
}
}
}
}
Expand Down
7 changes: 5 additions & 2 deletions extra/twig-extra-bundle/LeagueCommonMarkConverterFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,20 @@ final class LeagueCommonMarkConverterFactory
{
private $extensions;

private $config;

/**
* @param ExtensionInterface[] $extensions
*/
public function __construct(iterable $extensions)
public function __construct(iterable $extensions, array $config = [])
{
$this->extensions = $extensions;
$this->config = $config;
}

public function __invoke(): CommonMarkConverter
{
$converter = new CommonMarkConverter();
$converter = new CommonMarkConverter($this->config);

foreach ($this->extensions as $extension) {
$converter->getEnvironment()->addExtension($extension);
Expand Down
24 changes: 23 additions & 1 deletion extra/twig-extra-bundle/Tests/DependencyInjection/TwigExtraExtensionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,29 @@ public function testDefaultConfiguration()
'kernel.debug' => false,
]));
$container->registerExtension(new TwigExtraExtension());
$container->loadFromExtension('twig_extra');
$container->loadFromExtension('twig_extra', [
'commonmark' => [
'extra_key' => true,
'renderer' => [
'block_separator' => "\n",
'inner_separator' => "\n",
'soft_break' => "\n",
],
'commonmark' => [
'enable_em' => true,
'enable_strong' => true,
'use_asterisk' => true,
'use_underscore' => true,
'unordered_list_markers' => ['-', '*', '+'],
],
'html_input' => 'escape',
'allow_unsafe_links' => false,
'max_nesting_level' => PHP_INT_MAX,
'slug_normalizer' => [
'max_length' => 255,
],
],
]);
$container->getCompilerPassConfig()->setOptimizationPasses([]);
$container->getCompilerPassConfig()->setRemovingPasses([]);
$container->getCompilerPassConfig()->setAfterRemovingPasses([]);
Expand Down