symfony-tools/code-block-checker

0.3.0 2023-08-20 18:02 UTC

Requires

• php: >=8.0
• ext-ctype: *
• ext-iconv: *
• ext-libxml: *
• doctrine/rst-parser: ^0.4
• nikic/php-parser: ^4.10
• symfony-tools/docs-builder: ^0.15.0
• symfony/console: ^5.2
• symfony/dotenv: ^5.2
• symfony/event-dispatcher: ^5.2
• symfony/filesystem: ^5.2
• symfony/finder: ^5.2
• symfony/flex: ^1.3.1
• symfony/framework-bundle: ^5.2
• symfony/process: ^5.2
• symfony/twig-bridge: ^5.4
• symfony/yaml: ^5.2
• twig/twig: ^3.3

Requires (Dev)

• bamarni/composer-bin-plugin: ^1.4.1
• phpunit/phpunit: ^9.3.10

Replaces

• symfony/polyfill-ctype: *
• symfony/polyfill-iconv: *

proprietary

README

Makes sure that code blocks have valid syntax and can actually run.

$ php ./code-block-checker.php verify:docs /path/to/docs cache.rst controller.rst --env=dev

::error file=cache,line=377::[Invalid syntax] PHP Parse error:  syntax error, unexpected token "}"

 [ERROR] Build completed with 1 errors


$ php ./code-block-checker.php verify:docs /path/to/docs cache.rst controller.rst --env=dev --generate-baseline=baseline.json
$ php ./code-block-checker.php verify:docs /path/to/docs cache.rst controller.rst --env=dev --baseline=baseline.json

 [OK] Build completed successfully!

This project is considered an internal tool and therefore, you shouldn't use this project in your application. Unlike the rest of the Symfony projects, this repository doesn't provide any support and it doesn't guarantee backward compatibility. Any file or the entire project can change, or even disappear, at any moment without prior notice.