` tags** (#613) - **Heading Permalinks now link to element IDs instead of using `name` attributes** (#602) - **Heading Permalink IDs and URL fragments now have a `content` prefix by default** (#602) - **Changes to configuration options:** - `enable_em` has been renamed to `commonmark/enable_em` - `enable_strong` has been renamed to `commonmark/enable_strong` - `use_asterisk` has been renamed to `commonmark/use_asterisk` - `use_underscore` has been renamed to `commonmark/use_underscore` - `unordered_list_markers` has been renamed to `commonmark/unordered_list_markers` - `mentions/*/symbol` has been renamed to `mentions/*/prefix` - `mentions/*/regex` has been renamed to `mentions/*/pattern` and requires partial regular expressions (without delimiters or flags) - `max_nesting_level` now defaults to `PHP_INT_MAX` and no longer supports floats - `heading_permalink/slug_normalizer` has been renamed to `slug_normalizer/instance` - **Event dispatching is now fully PSR-14 compliant** - **Moved and renamed several classes** - [see the full list here](https://commonmark.thephpleague.com/2.0/upgrading/#classesnamespaces-renamed) - The `HeadingPermalinkExtension` and `FootnoteExtension` were modified to ensure they never produce a slug which conflicts with slugs created by the other extension - `SlugNormalizer::normalizer()` now supports optional prefixes and max length options passed in via the `$context` argument - The `AbstractBlock::$data` and `AbstractInline::$data` arrays were replaced with a `Data` array-like object on the base `Node` class - **Implemented a new approach to block parsing.** This was a massive change, so here are the highlights: - Functionality previously found in block parsers and node elements has moved to block parser factories and block parsers, respectively ([more details](https://commonmark.thephpleague.com/2.0/upgrading/#new-block-parsing-approach)) - `ConfigurableEnvironmentInterface::addBlockParser()` is now `EnvironmentBuilderInterface::addBlockParserFactory()` - `ReferenceParser` was re-implemented and works completely different than before - The paragraph parser no longer needs to be added manually to the environment - **Implemented a new approach to inline parsing** where parsers can now specify longer strings or regular expressions they want to parse (instead of just single characters): - `InlineParserInterface::getCharacters()` is now `getMatchDefinition()` and returns an instance of `InlineParserMatch` - `InlineParserContext::__construct()` now requires the contents to be provided as a `Cursor` instead of a `string` - **Implemented delimiter parsing as a special type of inline parser** (via the new `DelimiterParser` class) - **Changed block and inline rendering to use common methods and interfaces** - `BlockRendererInterface` and `InlineRendererInterface` were replaced by `NodeRendererInterface` with slightly different parameters. All core renderers now implement this interface. - `ConfigurableEnvironmentInterface::addBlockRenderer()` and `addInlineRenderer()` were combined into `EnvironmentBuilderInterface::addRenderer()` - `EnvironmentInterface::getBlockRenderersForClass()` and `getInlineRenderersForClass()` are now just `getRenderersForClass()` - **Completely refactored the Configuration implementation** - All configuration-specific classes have been moved into a new `league/config` package with a new namespace - `Configuration` objects must now be configured with a schema and all options must match that schema - arbitrary keys are no longer permitted - `Configuration::__construct()` no longer accepts the default configuration values - use `Configuration::merge()` instead - `ConfigurationInterface` now only contains a `get(string $key)`; this method no longer allows arbitrary default values to be returned if the option is missing - `ConfigurableEnvironmentInterface` was renamed to `EnvironmentBuilderInterface` - `ExtensionInterface::register()` now requires an `EnvironmentBuilderInterface` param instead of `ConfigurableEnvironmentInterface` - **Added missing return types to virtually every class and interface method** - Re-implemented the GFM Autolink extension using the new inline parser approach instead of document processors - `EmailAutolinkProcessor` is now `EmailAutolinkParser` - `UrlAutolinkProcessor` is now `UrlAutolinkParser` - `HtmlElement` can now properly handle array (i.e. `class`) and boolean (i.e. `checked`) attribute values - `HtmlElement` automatically flattens any attributes with array values into space-separated strings, removing duplicate entries - Combined separate classes/interfaces into one: - `DisallowedRawHtmlRenderer` replaces `DisallowedRawHtmlBlockRenderer` and `DisallowedRawHtmlInlineRenderer` - `NodeRendererInterface` replaces `BlockRendererInterface` and `InlineRendererInterface` - Renamed the following methods: - `Environment` and `ConfigurableEnvironmentInterface`: - `addBlockParser()` is now `addBlockStartParser()` - `ReferenceMap` and `ReferenceMapInterface`: - `addReference()` is now `add()` - `getReference()` is now `get()` - `listReferences()` is now `getIterator()` - Various node (block/inline) classes: - `getContent()` is now `getLiteral()` - `setContent()` is now `setLiteral()` - Moved and renamed the following constants: - `EnvironmentInterface::HTML_INPUT_ALLOW` is now `HtmlFilter::ALLOW` - `EnvironmentInterface::HTML_INPUT_ESCAPE` is now `HtmlFilter::ESCAPE` - `EnvironmentInterface::HTML_INPUT_STRIP` is now `HtmlFilter::STRIP` - `TableCell::TYPE_HEAD` is now `TableCell::TYPE_HEADER` - `TableCell::TYPE_BODY` is now `TableCell::TYPE_DATA` - Changed the visibility of the following properties: - `AttributesInline::$attributes` is now `private` - `AttributesInline::$block` is now `private` - `TableCell::$align` is now `private` - `TableCell::$type` is now `private` - `TableSection::$type` is now `private` - Several methods which previously returned `$this` now return `void` - `Delimiter::setPrevious()` - `Node::replaceChildren()` - `Context::setTip()` - `Context::setContainer()` - `Context::setBlocksParsed()` - `AbstractStringContainer::setContent()` - `AbstractWebResource::setUrl()` - Several classes are now marked `final`: - `ArrayCollection` - `Emphasis` - `FencedCode` - `Heading` - `HtmlBlock` - `HtmlElement` - `HtmlInline` - `IndentedCode` - `Newline` - `Strikethrough` - `Strong` - `Text` - `Heading` nodes no longer directly contain a copy of their inner text - `StringContainerInterface` can now be used for inlines, not just blocks - `ArrayCollection` only supports integer keys - `HtmlElement` now implements `Stringable` - `Cursor::saveState()` and `Cursor::restoreState()` now use `CursorState` objects instead of arrays - `NodeWalker::next()` now enters, traverses any children, and leaves all elements which may have children (basically all blocks plus any inlines with children). Previously, it only did this for elements explicitly marked as "containers". - `InvalidOptionException` was removed - Anything with a `getReference(): ReferenceInterface` method now implements `ReferencableInterface` - The `SmartPunct` extension now replaces all unpaired `Quote` elements with `Text` elements towards the end of parsing, making the `QuoteRenderer` unnecessary - Several changes made to the Footnote extension: - Footnote identifiers can no longer contain spaces - Anonymous footnotes can now span subsequent lines - Footnotes can now contain multiple lines of content, including sub-blocks, by indenting them - Footnote event listeners now have numbered priorities (but still execute in the same order) - Footnotes must now be separated from previous content by a blank line - The line numbers (keys) returned via `MarkdownInput::getLines()` now start at 1 instead of 0 - `DelimiterProcessorCollectionInterface` now extends `Countable` - `RegexHelper::PARTIAL_` constants must always be used in case-insensitive contexts - `HeadingPermalinkProcessor` no longer accepts text normalizers via the constructor - these must be provided via configuration instead - Blocks which can't contain inlines will no longer be asked to render inlines - `AnonymousFootnoteRefParser` and `HeadingPermalinkProcessor` now implement `EnvironmentAwareInterface` instead of `ConfigurationAwareInterface` - The second argument to `TextNormalizerInterface::normalize()` must now be an array - The `title` attribute for `Link` and `Image` nodes is now stored using a dedicated property instead of stashing it in `$data` - `ListData::$delimiter` now returns either `ListBlock::DELIM_PERIOD` or `ListBlock::DELIM_PAREN` instead of the literal delimiter ### Fixed - **Fixed parsing of footnotes without content** - **Fixed rendering of orphaned footnotes and footnote refs** - **Fixed some URL autolinks breaking too early** (#492) - Fixed `AbstractStringContainer` not actually being `abstract` ### Removed - **Removed support for PHP 7.1, 7.2, and 7.3** (#625, #671) - **Removed all previously-deprecated functionality:** - Removed the ability to pass custom `Environment` instances into the `CommonMarkConverter` and `GithubFlavoredMarkdownConverter` constructors - Removed the `Converter` class and `ConverterInterface` - Removed the `bin/commonmark` script - Removed the `Html5Entities` utility class - Removed the `InlineMentionParser` (use `MentionParser` instead) - Removed `DefaultSlugGenerator` and `SlugGeneratorInterface` from the `Extension/HeadingPermalink/Slug` sub-namespace (use the new ones under `./SlugGenerator` instead) - Removed the following `ArrayCollection` methods: - `add()` - `set()` - `get()` - `remove()` - `isEmpty()` - `contains()` - `indexOf()` - `containsKey()` - `replaceWith()` - `removeGaps()` - Removed the `ConfigurableEnvironmentInterface::setConfig()` method - Removed the `ListBlock::TYPE_UNORDERED` constant - Removed the `CommonMarkConverter::VERSION` constant - Removed the `HeadingPermalinkRenderer::DEFAULT_INNER_CONTENTS` constant - Removed the `heading_permalink/inner_contents` configuration option - **Removed now-unused classes:** - `AbstractStringContainerBlock` - `BlockRendererInterface` - `Context` - `ContextInterface` - `Converter` - `ConverterInterface` - `InlineRendererInterface` - `PunctuationParser` (was split into two classes: `DashParser` and `EllipsesParser`) - `QuoteRenderer` - `UnmatchedBlockCloser` - Removed the following methods, properties, and constants: - `AbstractBlock::$open` - `AbstractBlock::$lastLineBlank` - `AbstractBlock::isContainer()` - `AbstractBlock::canContain()` - `AbstractBlock::isCode()` - `AbstractBlock::matchesNextLine()` - `AbstractBlock::endsWithBlankLine()` - `AbstractBlock::setLastLineBlank()` - `AbstractBlock::shouldLastLineBeBlank()` - `AbstractBlock::isOpen()` - `AbstractBlock::finalize()` - `AbstractBlock::getData()` - `AbstractInline::getData()` - `ConfigurableEnvironmentInterface::addBlockParser()` - `ConfigurableEnvironmentInterface::mergeConfig()` - `Delimiter::setCanClose()` - `EnvironmentInterface::getConfig()` - `EnvironmentInterface::getInlineParsersForCharacter()` - `EnvironmentInterface::getInlineParserCharacterRegex()` - `HtmlRenderer::renderBlock()` - `HtmlRenderer::renderBlocks()` - `HtmlRenderer::renderInline()` - `HtmlRenderer::renderInlines()` - `Node::isContainer()` - `RegexHelper::matchAll()` (use the new `matchFirst()` method instead) - `RegexHelper::REGEX_WHITESPACE` - Removed the second `$contents` argument from the `Heading` constructor ### Deprecated **The following things have been deprecated and will not be supported in v3.0:** - `Environment::mergeConfig()` (set configuration before instantiation instead) - `Environment::createCommonMarkEnvironment()` and `Environment::createGFMEnvironment()` - Alternative 1: Use `CommonMarkConverter` or `GithubFlavoredMarkdownConverter` if you don't need to customize the environment - Alternative 2: Instantiate a new `Environment` and add the necessary extensions yourself [unreleased]: https://github.com/thephpleague/commonmark/compare/2.0.0...main [2.0.0]: https://github.com/thephpleague/commonmark/compare/2.0.0-rc2...2.0.0 [2.0.0-rc2]: https://github.com/thephpleague/commonmark/compare/2.0.0-rc1...2.0.0-rc2 [2.0.0-rc1]: https://github.com/thephpleague/commonmark/compare/2.0.0-beta3...2.0.0-rc1 [2.0.0-beta3]: https://github.com/thephpleague/commonmark/compare/2.0.0-beta2...2.0.0-beta3 [2.0.0-beta2]: https://github.com/thephpleague/commonmark/compare/2.0.0-beta1...2.0.0-beta2 [2.0.0-beta1]: https://github.com/thephpleague/commonmark/compare/1.6...2.0.0-beta1