README

When you have an extensive README.md or a bunch of documentation files, it is sometimes hard to keep all documentation up to date with the actual code. Why not also analyze code blocks in those files with PHPStan?

Getting started

composer require --dev prinsfrank/phpstan-doc-code-analyzer

Configuration

Configuring paths to look for Markdown files

You can configure the paths to analyze with glob patterns. By default, these are configured like this:

parameters:
    docCodeAnalyzer:
        paths:
            - docs/**.md
            - README.md

If one of the glob patterns doesn't match any files, this is likely a misconfiguration, so this will cause an error.

Auto prepend open tag when missing

When using PHP snippets in your documentation, you might not have all snippets start with the <?php open tag. So Instead of:

```php
<?php

echo 123;

You might start your code blocks without that open tag:

```php
echo 123;

In that case this extension will automatically prepend that opening tag. If you don't want that (and want php codeblocks without an open tag to fail), you can disable this:

parameters:
    docCodeAnalyzer:
        prependOpenTagWhenMissing: false

Set strict_types to true when adding missing opening tag

When the opening tag is not present, Besides automatically adding the tag, it will also enable strict_types. If you just want the automatic open tag without strict types, you can disable this:

parameters:
    docCodeAnalyzer:
        setStrictTypesWhenOpenTagMissing: false

prinsfrank / phpstan-doc-code-analyzer

Maintainers

Details