Allow v2 of commonmark

Author: dereuromark

composer.json

@@ -18,7 +18,7 @@
 	},
 	"require-dev": {
 		"fig-r/psr2r-sniffer": "dev-master",
-		"league/commonmark": "^1.5",
+		"league/commonmark": "^1.5 || ^2.0",
 		"mjohnson/decoda": "^6.12",
 		"dereuromark/media-embed": "^0.5"
 	},

src/Markdown/CommonMarkMarkdown.php

@@ -4,14 +4,19 @@
 
 use Cake\Core\InstanceConfigTrait;
 use League\CommonMark\CommonMarkConverter;
-use League\CommonMark\Environment;
+use League\CommonMark\Environment as LegacyEnvironment;
+use League\CommonMark\Environment\Environment;
+use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
+use League\CommonMark\Extension\GithubFlavoredMarkdownExtension;
+use League\CommonMark\MarkdownConverter;
+use League\CommonMark\MarkdownConverterInterface;
 
 class CommonMarkMarkdown implements MarkdownInterface {
 
 	use InstanceConfigTrait;
 
 	/**
-	 * @var \League\CommonMark\CommonMarkConverter|null
+	 * @var \League\CommonMark\MarkdownConverterInterface|null
 	 */
 	protected $converter;
 
@@ -37,15 +42,15 @@ public function __construct(array $config = []) {
 	public function convert(string $text, array $options = []): string {
 		$converter = $this->converter($options);
 
-		return $converter->convertToHtml($text);
+		return (string)$converter->convertToHtml($text);
 	}
 
 	/**
 	 * @param array $options
 	 *
-	 * @return \League\CommonMark\CommonMarkConverter
+	 * @return \League\CommonMark\MarkdownConverterInterface
 	 */
-	protected function converter(array $options = []): CommonMarkConverter {
+	protected function converter(array $options = []): MarkdownConverterInterface {
 		if ($this->converter === null) {
 			$this->converter = static::defaultConverter($options);
 		}
@@ -56,22 +61,32 @@ protected function converter(array $options = []): CommonMarkConverter {
 	/**
 	 * @param array $options
 	 *
-	 * @return \League\CommonMark\CommonMarkConverter
+	 * @return \League\CommonMark\MarkdownConverterInterface
 	 */
-	public static function defaultConverter(array $options = []): CommonMarkConverter {
-		$environment = Environment::createGFMEnvironment();
+	public static function defaultConverter(array $options = []): MarkdownConverterInterface {
 
 		$options += [
 			'escape' => true,
 		];
-
 		if ($options['escape']) {
-			$environment->mergeConfig([
-				'html_input' => Environment::HTML_INPUT_ESCAPE,
-			]);
+			$options['html_input'] = 'escape';
+		}
+		unset($options['escape']);
+
+		if (!class_exists(Environment::class)) {
+			$environment = LegacyEnvironment::createGFMEnvironment();
+			$environment->mergeConfig($options);
+		} else {
+			$environment = new Environment($options);
+			$environment->addExtension(new CommonMarkCoreExtension());
+			$environment->addExtension(new GithubFlavoredMarkdownExtension());
+		}
+
+		if (!class_exists(MarkdownConverter::class)) {
+			return new CommonMarkConverter([], $environment);
 		}
 
-		return new CommonMarkConverter([], $environment);
+		return new MarkdownConverter($environment);
 	}
 
 }

tests/phpstan.neon

@@ -3,3 +3,6 @@ parameters:
 	bootstrapFiles:
 		- bootstrap.php
 	checkMissingIterableValueType: false
+	ignoreErrors:
+		- '#Call to static method createGFMEnvironment\(\) on an unknown class .+Environment#'
+		- '#Class .+CommonMarkConverter constructor invoked with 2 parameters, 0-1 required#'