klitsche/dog

View on GitHub
composer.json

Summary

Maintainability
Test Coverage
{
    "name": "klitsche/dog",
    "type": "library",
    "description": "Source code documentation generator for PHP libraries",
    "keywords": [
        "documentation",
        "generator",
        "source code",
        "phpdoc",
        "api",
        "twig",
        "markdown"
    ],
    "homepage": "https://klitsche.github.io/dog/",
    "license": "MIT",
    "authors": [
        {
            "name": "Dirk Adler",
            "email": "dirx@klitsche.de"
        }
    ],
    "require": {
        "php": "^8.0",
        "phpdocumentor/reflection": "^4.0 || ^5.0",
        "twig/twig": "^3.0",
        "symfony/console": "^5.0 || ^6.0",
        "symfony/event-dispatcher": "^5.0 || ^6.0",
        "symfony/filesystem": "^5.0 || ^6.0",
        "symfony/finder": "^5.0 || ^6.0",
        "symfony/stopwatch": "^5.0 || ^6.0",
        "symfony/yaml": "^5.0 || ^6.0"
    },
    "suggest": {
        "ext-json": "To use enricher PHPLOC",
        "ext-simplexml": "To use enricher Clover"
    },
    "autoload": {
        "psr-4": {
            "Klitsche\\Dog\\": "src"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "Klitsche\\Dog\\": "tests"
        }
    },
    "bin": [
        "bin/dog"
    ],
    "require-dev": {
        "phpunit/phpunit": "^9.4",
        "symplify/easy-coding-standard": "^10.3",
        "humbug/box": "4.2.0"
    },
    "scripts": {
        "test": "vendor/bin/phpunit",
        "test-coverage": "vendor/bin/phpunit --coverage-text --coverage-clover=clover.xml",
        "cs": "vendor/bin/ecs check src tests --ansi",
        "cs-fix": "vendor/bin/ecs check src tests --ansi --fix",
        "prepare-docs": [
            "echo '---\ntitle: Getting started\n---\n' > docs/index.md",
            "sed 's/docs\\/img/img/g' README.md >> docs/index.md",
            "cp LICENSE.md docs/license.md",
            "rm -fr docs/api/",
            "bin/dog --ansi"
        ],
        "build-docs": [
            "@prepare-docs",
            "docker-compose run --rm mkdocs build"
        ],
        "build-phar": [
            "composer config autoloader-suffix KlitscheDog",
            "vendor/bin/box.phar compile",
            "composer config autoloader-suffix --unset"
        ]
    },
    "config": {
        "optimize-autoloader": true,
        "sort-packages": true
    },
    "repositories": [
        {
            "type": "package",
            "package": {
                "name": "humbug/box",
                "version": "4.2.0",
                "bin": [
                    "box.phar"
                ],
                "dist": {
                    "type": "file",
                    "url": "https://github.com/box-project/box/releases/download/4.2.0/box.phar",
                    "reference": "4.2.0"
                }
            }
        }
    ]
}