BEAR.ApiDoc/composer.json at 1.x · bearsunday/BEAR.ApiDoc · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
{
    "name": "bear/api-doc",
    "description": "",
    "license": "MIT",
    "authors": [
        {
            "name": "Akihito Koriyama",
            "email": "akihito.koriyama@gmail.com"
        }
    ],
    "require": {
        "php": "^8.2",
        "ext-json": "*",
        "ext-filter": "*",
        "ext-simplexml": "*",
        "ext-libxml": "*",
        "ext-dom": "*",
        "phpdocumentor/reflection-docblock": "^4.3 || ^5.2",
        "bear/resource": "^1.16.2",
        "bear/sunday": "^1.4",
        "bear/app-meta": "^1.7",
        "ray/di": "^2.16",
        "rize/uri-template": "^0.3.3 || ^0.4",
        "bear/package": "^1.9",
        "koriym/app-state-diagram": "^0.11 ",
        "michelf/php-markdown": "^1.9.1 || ^2.0",
        "koriym/psr4list": "^1.0.1",
        "ray/aop": "^2.10",
        "ray/input-query": "^1.0"
    },
    "require-dev": {
        "bear/aura-router-module": "^2.0.3",
        "bamarni/composer-bin-plugin": "^1.8.2",
        "koriym/attributes": "^1.0.5",
        "phpunit/phpunit": "^11.0",
        "justinrainbow/json-schema": "^5.3 || ^6.0"
    },
    "autoload": {
        "psr-4": {
            "BEAR\\ApiDoc\\": "src/"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "FakeVendor\\FakeProject\\": "tests/Fake/app/src/",
            "BEAR\\ApiDoc\\": [
                "tests/",
                "tests/Fake"
            ]
        }
    },
    "bin": ["bin/apidoc"],
    "scripts": {
        "setup": "php bin/setup.php",
        "test": "./vendor/bin/phpunit",
        "coverage": "php -dzend_extension=xdebug.so -dxdebug.mode=coverage ./vendor/bin/phpunit --coverage-text --coverage-html=build/coverage",
        "pcov": "php -dextension=pcov.so -d pcov.enabled=1 ./vendor/bin/phpunit --coverage-text --coverage-html=build/coverage  --coverage-clover=coverage.xml",
        "cs": "./vendor/bin/phpcs",
        "cs-fix": "./vendor/bin/phpcbf src tests",
        "metrics": "./vendor/bin/phpmetrics --report-html=build/metrics --exclude=Exception src",
        "clean": [
            "./vendor/bin/phpstan clear-result-cache",
            "./vendor/bin/psalm --clear-cache"
        ],
        "sa": [
            "./vendor/bin/phpstan analyse -c phpstan.neon",
            "./vendor/bin/psalm --show-info=true",
            "./vendor/bin/phpmd src text phpmd.xml"
        ],
        "tests": [
            "@cs",
            "@sa",
            "@test"
        ],
        "build": [
            "@clean",
            "@cs",
            "@sa",
            "@pcov",
            "@metrics"
        ],
        "docs": "php bin/apidoc -ctests/apidoc.html.xml",
        "docs-dev": "php bin/apidoc -ctests/apidoc.html.xml --inline-css",
        "docs-md": "php bin/apidoc -ctests/apidoc.md.xml",
        "docs-openapi": "php bin/apidoc -ctests/apidoc.openapi.xml",
        "docs-all": [
            "@docs",
            "@docs-md",
            "@docs-openapi"
        ],
        "openapi-install": "npm install -g @redocly/cli",
        "openapi-lint": "npx @redocly/cli lint tests/docs/openapi/openapi.json",
        "openapi-html": "npx @redocly/cli build-docs tests/docs/openapi/openapi.json -o tests/docs/openapi/index.html",
        "post-install-cmd": "@composer bin all install --ansi",
        "post-update-cmd": "@composer bin all update --ansi"
    },
    "scripts-descriptions": {
        "test": "Run unit tests",
        "coverage": "Generate test coverage report",
        "pcov": "Generate test coverage report (pcov)",
        "cs": "Check the coding style",
        "cs-fix": "Fix the coding style",
        "clean": "Delete tmp files",
        "sa": "Run static analysis",
        "metrics": "Build metrics report",
        "tests": "Run tests and quality checks",
        "build": "Build project",
        "docs": "Generate HTML API documentation",
        "docs-dev": "Generate HTML API documentation with inline CSS",
        "docs-md": "Generate Markdown API documentation",
        "docs-openapi": "Generate OpenAPI specification",
        "docs-all": "Generate all documentation formats (HTML, Markdown, OpenAPI)",
        "openapi-install": "Install Redocly CLI globally",
        "openapi-lint": "Validate OpenAPI spec with Redocly CLI",
        "openapi-html": "Generate HTML documentation from OpenAPI spec"
    },
    "config": {
        "allow-plugins": {
            "bamarni/composer-bin-plugin": true
        }
    },
    "extra": {
        "bamarni-bin": {
            "bin-links": true,
            "forward-command": true
        }
    }

}