symplify/markdown-diff

This package is abandoned and no longer maintained. The author suggests using the symplify/rule-doc-generator package instead.

Package to print diffs for Markdown

10.1.0 2022-02-21 11:15 UTC

Requires

• php: >=8.0
• nette/utils: ^3.2
• sebastian/diff: ^4.0
• symfony/dependency-injection: ^5.4|^6.0
• symplify/package-builder: ^10.1

Requires (Dev)

• phpunit/phpunit: ^9.5

Conflicts

• symplify/amnesia: <10.1.0
• symplify/astral: <10.1.0
• symplify/autowire-array-parameter: <10.1.0
• symplify/coding-standard: <10.1.0
• symplify/composer-json-manipulator: <10.1.0
• symplify/config-transformer: <10.1.0
• symplify/easy-ci: <10.1.0
• symplify/easy-coding-standard: <10.1.0
• symplify/easy-parallel: <10.1.0
• symplify/easy-testing: <10.1.0
• symplify/git-wrapper: <10.1.0
• symplify/latte-phpstan-compiler: <10.1.0
• symplify/monorepo-builder: <10.1.0
• symplify/neon-config-dumper: <10.1.0
• symplify/php-config-printer: <10.1.0
• symplify/phpstan-extensions: <10.1.0
• symplify/phpstan-latte-rules: <10.1.0
• symplify/phpstan-rules: <10.1.0
• symplify/rule-doc-generator: <10.1.0
• symplify/rule-doc-generator-contracts: <10.1.0
• symplify/skipper: <10.1.0
• symplify/smart-file-system: <10.1.0
• symplify/symfony-static-dumper: <10.1.0
• symplify/symplify-kernel: <10.1.0
• symplify/template-phpstan-compiler: <10.1.0
• symplify/vendor-patches: <10.1.0

MIT

README

Install

composer require symplify/markdown-diff

Add to config/config.php:

use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Symplify\MarkdownDiff\ValueObject\MarkdownDiffConfig;

return static function (ContainerConfigurator $containerConfigurator): void {
    $containerConfigurator->import(MarkdownDiffConfig::class);
};

Usage

namespace App;

use Symplify\MarkdownDiff\Differ\MarkdownDiffer;

final class SomeClass
{
    /**
     * @var MarkdownDiffer
     */
    private $markdownDiffer;

    public function __construct(MarkdownDiffer $markdownDiffer)
    {
        $this->markdownDiffer = $markdownDiffer;
    }

    public function run(): void
    {
        $markdownDiff = $this->markdownDiffer->diff('oldContent', 'newContent');
        // ...
    }
}

Report Issues

In case you are experiencing a bug or want to request a new feature head over to the Symplify monorepo issue tracker

Contribute

The sources of this package are contained in the Symplify monorepo. We welcome contributions for this package on symplify/symplify.