enhance: parse method doc comments enhance

Author: inhere

src/Annotate/DocblockRules.php

@@ -8,6 +8,8 @@
 use function array_merge;
 use function explode;
 use function preg_match;
+use function strlen;
+use function substr;
 use function trim;
 
 /**
@@ -139,7 +141,7 @@ protected function parseMultiLines(array $lines): array
  $index = 0;
  $rules = $kvRules = [];
 
- // $keyWidth = 16;
+ $keyWidth = 16; // with an default value.
  foreach ($lines as $line) {
  $trimmed = trim($line);
  if (!$trimmed) {
@@ -157,6 +159,12 @@ protected function parseMultiLines(array $lines): array
  continue;
  }
 
+ // TIP: special - if line indent space len gt keyWidth, is desc message of multi line.
+ if (!trim(substr($line, 0, $keyWidth))) {
+ $rules[$index - 1][1] .= "\n" . $trimmed; // multi desc message.
+ continue;
+ }
+
  $name = trim($nodes[0], '.');
  if (!preg_match('/^[\w ,-]{0,48}$/', $name)) {
  if ($index === 0) { // invalid first line
@@ -168,10 +176,15 @@ protected function parseMultiLines(array $lines): array
  continue;
  }
 
+ $nameLen = strlen($name);
+ $keyWidth = $nameLen > $keyWidth ? $nameLen : $keyWidth;
+
+ // append
  $rules[$index] = [$name, $nodes[1]];
  $index++;
  }
 
+ // convert to k-v data.
  if ($rules) {
  foreach ($rules as [$name, $rule]) {
  $kvRules[$name] = $rule;

test/Annotate/DocblockRulesTest.php

@@ -4,15 +4,17 @@
 
 use Inhere\Console\Annotate\DocblockRules;
 use Inhere\ConsoleTest\BaseTestCase;
+use ReflectionException;
 use ReflectionMethod;
+use function vdump;
 
 /**
  * class DocblockRulesTest
  */
 class DocblockRulesTest extends BaseTestCase
 {
  /**
- * @throws \ReflectionException
+ * @throws ReflectionException
  */
  public function testParse_byReflect(): void
  {
@@ -53,7 +55,7 @@ public function testParse_byDocComment(): void
  *
  */
 DOC
-);
+ );
  $dr->parse();
 
  $this->assertNotEmpty($dr->getTagValue('desc'));
@@ -66,4 +68,69 @@ public function testParse_byDocComment(): void
  $this->assertArrayHasKey('--main', $opts);
  $this->assertArrayHasKey('repoPath', $args);
  }
+
+ public function testParse_byDocComment_complex(): void
+ {
+ $dr = DocblockRules::new();
+ $dr->setDocTagsByDocblock(<<<DOC
+ /**
+ * collect git change log information by `git log`
+ *
+ * @arguments
+ * oldVersion string;The old version. eg: v1.0.2
+ * - keywords `last/latest` will auto use latest tag.
+ * - keywords `prev/previous` will auto use previous tag.;required
+ * newVersion string;The new version. eg: v1.2.3
+ * - keywords `head` will use `Head` commit.;required
+ *
+ * @options
+ * --exclude Exclude contains given sub-string. multi by comma split.
+ * --fetch-tags bool;Update repo tags list by `git fetch --tags`
+ * --file Export changelog message to file
+ * --filters Apply built in log filters. multi by `|` split
+ * allow:
+ * kw keyword filter. eg: `kw:tom`
+ * kws keywords filter.
+ * ml msg length filter.
+ * wl word length filter.
+ * --format The git log option `--pretty` value.
+ * can be one of oneline, short, medium, full, fuller, reference, email, raw, format:<string> and tformat:<string>.
+ * --style The style for generate for changelog.
+ * allow: markdown(<cyan>default</cyan>), simple, gh-release
+ * --repo-url The git repo URL address. eg: https://github.com/inhere/kite
+ * default will auto use current git origin remote url
+ * --no-merges bool;No contains merge request logs
+ * --unshallow bool;Convert to a complete warehouse, useful on GitHub Action.
+ * --with-author bool;Display commit author name
+ *
+ * @example
+ * {binWithCmd} last head
+ * {binWithCmd} last head --style gh-release --no-merges
+ * {binWithCmd} v2.0.9 v2.0.10 --no-merges --style gh-release --exclude "cs-fixer,format codes"
+ */
+DOC
+ );
+
+ $dr->parse();
+
+ $this->assertNotEmpty($dr->getTagValue('desc'));
+ $this->assertNotEmpty($dr->getTagValue('example'));
+
+ $this->assertNotEmpty($opts = $dr->getOptRules());
+ $this->assertArrayHasKey('--exclude', $opts);
+ $this->assertArrayHasKey('--with-author', $opts);
+ $this->assertArrayHasKey('--format', $opts);
+ $this->assertArrayHasKey('--style', $opts);
+ $this->assertArrayHasKey('--filters', $opts);
+
+ $this->assertStringContainsString('can be one of oneline, short', $opts['--format']);
+ $this->assertStringContainsString('kw keyword filter', $opts['--filters']);
+ $this->assertStringContainsString('wl word length filter', $opts['--filters']);
+ vdump($opts);
+
+ $this->assertNotEmpty($args = $dr->getArgRules());
+ $this->assertCount(2, $args);
+ $this->assertArrayHasKey('oldVersion', $args);
+ $this->assertArrayHasKey('newVersion', $args);
+ }
 }