composer.json

{
    "name": "tomrf/readme-gen",
    "type": "library",
    "description": "generates readme with public api documentation for php packages",
    "keywords": [ "readme",  "documentation", "readme.md", "markdown" ],
    "homepage": "http://github.com/tomrf/readme-gen",
    "license": "MIT",
    "authors": [
        {
            "name": "Tom Rune Flo",
            "email": "tom@x86.no",
            "homepage": "http://github.com/tomrf/"
        }
    ],
    "extra": {
        "intro": [
            "Automatically generates a 📚 README file with public API documentation for a PHP package, ",
            "based on docblocks and package information from composer.json",
            "",
            "Included formatters:",
            " - Markdown"
        ],
        "example": [
            "$readmeGen = new \\Tomrf\\ReadmeGen\\ReadmeGen('.'); // path to project directory",
            "",
            "echo $readmeGen->generate(",
            "    new Tomrf\\ReadmeGen\\Formatter\\MarkdownFormatter(",
            "        \\phpDocumentor\\Reflection\\DocBlockFactory::createInstance(),",
            "        new \\phpDocumentor\\Reflection\\Types\\ContextFactory()",
            "    ),",
            "    'resources/template.md'",
            ");"
        ]
    },
    "require": {
        "php": "^8.0",
        "haydenpierce/class-finder": "^0.4.3",
        "phpdocumentor/reflection-docblock": "^5.3"
    },
    "require-dev": {
        "phpunit/phpunit": "^9.5",
        "phpstan/phpstan": "^1.6",
        "friendsofphp/php-cs-fixer": "^3.8",
        "phpmd/phpmd": "^2.12",
        "roave/security-advisories": "dev-latest"
    },
    "autoload": {
        "psr-4": {
            "Tomrf\\ReadmeGen\\": "src/"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "Tomrf\\ReadmeGen\\Test\\": "tests/"
        }
    },
    "bin": [
        "bin/readme-gen"
    ],
    "scripts": {
        "phpunit": [
            "phpunit -c .phpunit.dist.xml --colors=auto --coverage-text --stderr"
        ],
        "cs-fixer": [
            "php-cs-fixer fix --allow-risky=yes --diff --verbose src/"
        ],
        "phpstan": [
            "phpstan analyze --level 5 src/"
        ],
        "phpmd": [
            "phpmd src/ ansi .phpmd-ruleset.xml"
        ],
        "test": [
            "@phpunit",
            "@phpmd",
            "@phpstan"
        ],
        "coverage": [
            "@putenv XDEBUG_MODE=coverage",
            "@phpunit --coverage-xml .phpunit.cache/code-coverage/xml",
            "ls -al .phpunit.cache/code-coverage/xml"
        ],
        "coverage-html": [
            "@putenv XDEBUG_MODE=coverage",
            "@phpunit --coverage-html .phpunit.cache/code-coverage/html",
            "php -S localhost:0 -t .phpunit.cache/code-coverage/html"
        ],
        "clean": [
            "rm -rf vendor/ .phpunit.cache .php-cs-fixer.cache"
        ]
    }
}