Merge pull request #115 from bearsunday/apidoc

Add doc command

README.proj.md

@@ -17,6 +17,7 @@
     composer tests             // test and quality checks
     composer coverage          // test coverage
     composer cs-fix            // fix the coding standard
+    composer doc               // generate API document
     composer run-script --list // list all commands
 
 ## Links

apidoc.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<apidoc
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="./vendor/bear/api-doc/apidoc.xsd">
+    <appName>BEAR\Skeleton</appName>
+    <scheme>app</scheme>
+    <docDir>docs</docDir>
+    <format>html</format>
+    <title>BEAR.Skeleton API</title>
+    <description>API Document</description>
+</apidoc>

composer.json

@@ -14,6 +14,7 @@
         "ray/di": "^2.11"
     },
     "require-dev": {
+        "bear/api-doc": "1.x-dev",
         "bear/devtools": "^0.1",
         "bamarni/composer-bin-plugin": "^1.4",
         "composer/composer": "^1.10",
@@ -36,6 +37,7 @@
         "post-install-cmd": "@setup",
         "setup": "php bin/setup.php",
         "compile": "bear.compile 'BEAR\\Skeleton' prod-app ./",
+        "doc": "./vendor/bin/apidoc",
         "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",
@@ -53,6 +55,7 @@
     "scripts-descriptions": {
         "setup": "Setup the project",
         "compile": "Compile scripts for the production",
+        "doc": "Generate API document",
         "test": "Run unit tests",
         "tests": "Run tests and quality checks",
         "coverage": "Generate test coverage report",

src/Install.php

@@ -65,7 +65,7 @@ private function recursiveJob(string $path, callable $job): void
     {
         $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path), RecursiveIteratorIterator::SELF_FIRST);
         foreach ($iterator as $file) {
-            if (! in_array($file->getExtension(), ['php', 'md', 'xml'], true)) {
+            if (! in_array($file->getExtension(), ['php', 'md', 'xml', 'dist'], true)) {
                 continue;
             }