Merge branch 'release/1.2.0'

CHANGELOG.md

@@ -6,7 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [1.1.1] 2021-06-10
+## [1.2.0] - 2022-01-27
+### Fixed
+- List of arguments is empty when `apply_filters` is returned instead of assigned to variable (props [@LuigiPulcini](https://github.com/LuigiPulcini)). ( [#11](https://github.com/pronamic/wp-documentor/issues/11) )
+
+### Added
+- Added `--prefix` option (props [@LuigiPulcini](https://github.com/LuigiPulcini)). ( [#10](https://github.com/pronamic/wp-documentor/pull/10) )
+
+## [1.1.1] - 2021-06-10
 ### Changed
 - Progress bar now shows the file being processed.
 
@@ -23,7 +30,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - First Release.
 
-[Unreleased]: https://github.com/pronamic/wp-documentor/compare/1.1.1...HEAD
-[1.1.1]: https://github.com/pronamic/wp-documentor/releases/tag/1.2.0
-[1.1.0]: https://github.com/pronamic/wp-documentor/releases/tag/1.1.0
+[Unreleased]: https://github.com/pronamic/wp-documentor/compare/1.2.0...HEAD
+[1.2.0]: https://github.com/pronamic/wp-documentor/compare/1.1.1...1.2.0
+[1.1.1]: https://github.com/pronamic/wp-documentor/compare/1.1.0...1.1.1
+[1.1.0]: https://github.com/pronamic/wp-documentor/compare/1.0.0...1.1.0
 [1.0.0]: https://github.com/pronamic/wp-documentor/releases/tag/1.0.0

README.md

@@ -93,6 +93,12 @@ If the search directory contains a `.gitignore` file, you can reuse those rules
 
 Example: `--ignore-vcs-ignored`
 
+### `--prefix=PREFIX`
+
+Only parse hooks starting with the specified prefixes.
+
+Example: `--prefix=my_theme --prefix=my_plugin`
+
 ### Examples
 
 ```

bin/wp-documentor

@@ -49,7 +49,13 @@ $application->register( 'parse' )
 		null
 	)
 	->addOption( 'relative', null, InputOption::VALUE_REQUIRED, 'Relative to directory.', null )
-	->addOption( 'prefix', null, InputOption::VALUE_REQUIRED, 'Comma-separated list of prefixes hooks must match.', null )
+	->addOption(
+		'prefix',
+		null,
+		InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
+		'Comma-separated list of prefixes hooks must match.',
+		null
+	)
 	->addOption( 'output', 'o', InputOption::VALUE_REQUIRED, 'Write output to file instead of stdout.', null )
 	->addOption( 'memory-limit', null, InputOption::VALUE_REQUIRED, 'Memory limit for the run.', null )
 	->addOption(
@@ -126,9 +132,12 @@ $application->register( 'parse' )
 
 		$documentor->relative = ( null === $relative ) ? $source : $relative;
 
-		$prefix = $input->getOption( 'prefix' );
-
-		$documentor->prefix = ( null === $prefix ) ? null : $prefix;
+		/**
+		 * Prefixes.
+		 * 
+		 * @link https://github.com/pronamic/wp-documentor/pull/10
+		 */
+		$documentor->prefixes = (array) $input->getOption( 'prefix' );
 
 		/**
 		 * Output.

composer.json

@@ -26,15 +26,21 @@
         "bin/wp-documentor"
     ],
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "roots/wordpress-core-installer": true,
+            "bamarni/composer-bin-plugin": true
+        }
     },
     "require": {
-		"phpdocumentor/reflection": "^4.0",
-		"phpdocumentor/reflection-docblock": "^5.2",
-		"symfony/console": "^5.2",
-		"symfony/filesystem": "^5.2",
-		"symfony/finder": "^5.2"
-	},
+        "phpdocumentor/reflection": "^4.0",
+        "phpdocumentor/reflection-docblock": "^5.2",
+        "symfony/console": "^5.2",
+        "symfony/filesystem": "^5.2",
+        "symfony/finder": "^5.2",
+        "symfony/polyfill-php80": "^1.24"
+    },
     "scripts": {
         "post-install-cmd": "echo 'Optionally run: composer bin all install'",
         "post-update-cmd": "echo 'Optionally run: composer bin all update'",
@@ -45,7 +51,9 @@
             "bin/wp-documentor parse tests/source --format=markdown --relative=tests/docs --output=tests/docs/hooks.md",
             "bin/wp-documentor parse tests/source --format=phpdocumentor-rst --type=actions --relative=tests/docs --output=tests/docs/phpdocumentor-actions.rst",
             "bin/wp-documentor parse tests/source --format=phpdocumentor-rst --type=filters --relative=tests/docs --output=tests/docs/phpdocumentor-filters.rst",
-            "bin/wp-documentor parse wordpress --format=markdown --relative=tests/docs --memory-limit=-1 --output=tests/docs/wordpress-hooks.md"
+            "bin/wp-documentor parse wordpress --format=markdown --relative=tests/docs --memory-limit=-1 --output=tests/docs/wordpress-hooks.md",
+            "bin/wp-documentor parse tests/issue-10 --format=markdown --output=tests/issue-10/hooks.md --prefix=prefix_1 --prefix=prefix_2",
+            "bin/wp-documentor parse tests/issue-11 --format=markdown --output=tests/issue-11/hooks.md"
         ]
     },
 	"require-dev": {

src/Argument.php

@@ -3,7 +3,7 @@
  * Argument
  *
  * @author    Pronamic <[email protected]>
- * @copyright 2005-2021 Pronamic
+ * @copyright 2005-2022 Pronamic
  * @license   GPL-3.0-or-later
  * @package   Pronamic\WordPress\Documentor
  */

src/Changelog.php

@@ -3,7 +3,7 @@
  * Changelog
  *
  * @author    Pronamic <[email protected]>
- * @copyright 2005-2021 Pronamic
+ * @copyright 2005-2022 Pronamic
  * @license   GPL-3.0-or-later
  * @package   Pronamic\WordPress\Documentor
  */

src/ChangelogFactory.php

@@ -3,7 +3,7 @@
  * Changelog Factory
  *
  * @author    Pronamic <[email protected]>
- * @copyright 2005-2021 Pronamic
+ * @copyright 2005-2022 Pronamic
  * @license   GPL-3.0-or-later
  * @package   Pronamic\WordPress\Documentor
  */

src/DefaultPrinter.php

@@ -3,7 +3,7 @@
  * Default Printer
  *
  * @author    Pronamic <[email protected]>
- * @copyright 2005-2021 Pronamic
+ * @copyright 2005-2022 Pronamic
  * @license   GPL-3.0-or-later
  * @package   Pronamic\WordPress\Documentor
  */

src/Documentor.php

@@ -3,7 +3,7 @@
  * Documentor
  *
  * @author    Pronamic <[email protected]>
- * @copyright 2005-2021 Pronamic
+ * @copyright 2005-2022 Pronamic
  * @license   GPL-3.0-or-later
  * @package   Pronamic\WordPress\Documentor
  */
@@ -32,11 +32,19 @@ class Documentor {
 	 */
 	private $hooks;
 
+	/**
+	 * Prefixes.
+	 *
+	 * @var string[]
+	 */
+	public $prefixes;
+
 	/**
 	 * Construct documentor.
 	 */
 	public function __construct() {
-		$this->hooks = array();
+		$this->hooks    = array();
+		$this->prefixes = array();
 	}
 
 	/**
@@ -91,6 +99,26 @@ public function relative( \SplFileInfo $file ) {
 		return \trim( $filesystem->makePathRelative( $end->getRealPath(), $start->getRealPath() ), '/' );
 	}
 
+	/**
+	 * Check if the specified tag name should be parsed.
+	 *
+	 * @param string $name Tag name.
+	 * @return bool True if should parse, false otherwise.
+	 */
+	private function should_parse_tag( $name ) {
+		if ( 0 === \count( $this->prefixes ) ) {
+			return true;
+		}
+
+		foreach ( $this->prefixes as $prefix ) {
+			if ( \str_starts_with( $name, $prefix ) ) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
 	/**
 	 * Parse.
 	 *
@@ -173,24 +201,19 @@ function( Node $node ) {
 				);
 			}
 
-			if ( ! is_null( $this->prefix ) ) {
-				$pattern = sprintf( '/^(%s)/', implode( '|', explode( ',', $this->prefix ) ) );
-				preg_match( $pattern, $tag_name, $matches );
-
-				if ( empty( $matches ) ) {
-					continue;
-				}
+			if ( ! $this->should_parse_tag( $tag_name ) ) {
+				continue;
 			}
 
 			$tag = new Tag( $tag_name, $tag_arg );
 
 			$doc_comment = $statement->getDocComment();
 
 			if ( null === $doc_comment ) {
-				$previous = $statement->getAttribute( 'previous' );
+				$parent = $statement->getAttribute( 'parent' );
 
-				if ( null !== $previous ) {
-					$doc_comment = $previous->getDocComment();
+				if ( null !== $parent ) {
+					$doc_comment = $parent->getDocComment();
 				}
 			}
 

src/Hook.php

@@ -3,7 +3,7 @@
  * Hook
  *
  * @author    Pronamic <[email protected]>
- * @copyright 2005-2021 Pronamic
+ * @copyright 2005-2022 Pronamic
  * @license   GPL-3.0-or-later
  * @package   Pronamic\WordPress\Documentor
  */

src/HooksterPrinter.php

@@ -3,7 +3,7 @@
  * Hookster Printer
  *
  * @author    Pronamic <[email protected]>
- * @copyright 2005-2021 Pronamic
+ * @copyright 2005-2022 Pronamic
  * @license   GPL-3.0-or-later
  * @package   Pronamic\WordPress\Documentor
  */

src/NamespaceResolver.php

@@ -3,7 +3,7 @@
  * Namespace Resolver
  *
  * @author    Pronamic <[email protected]>
- * @copyright 2005-2021 Pronamic
+ * @copyright 2005-2022 Pronamic
  * @license   GPL-3.0-or-later
  * @package   Pronamic\WordPress\Documentor
  */

src/Since.php

@@ -3,7 +3,7 @@
  * Since
  *
  * @author    Pronamic <[email protected]>
- * @copyright 2005-2021 Pronamic
+ * @copyright 2005-2022 Pronamic
  * @license   GPL-3.0-or-later
  * @package   Pronamic\WordPress\Documentor
  */

src/Tag.php

@@ -3,7 +3,7 @@
  * Tag
  *
  * @author    Pronamic <[email protected]>
- * @copyright 2005-2021 Pronamic
+ * @copyright 2005-2022 Pronamic
  * @license   GPL-3.0-or-later
  * @package   Pronamic\WordPress\Documentor
  */

src/TagPrinter.php

@@ -3,7 +3,7 @@
  * Tag Printer
  *
  * @author    Pronamic <[email protected]>
- * @copyright 2005-2021 Pronamic
+ * @copyright 2005-2022 Pronamic
  * @license   GPL-3.0-or-later
  * @package   Pronamic\WordPress\Documentor
  */

src/TemplatePrinter.php

@@ -3,7 +3,7 @@
  * Template Printer
  *
  * @author    Pronamic <[email protected]>
- * @copyright 2005-2021 Pronamic
+ * @copyright 2005-2022 Pronamic
  * @license   GPL-3.0-or-later
  * @package   Pronamic\WordPress\Documentor
  */

templates/default.php

@@ -4,7 +4,7 @@
  *
  * @link      https://github.com/themeblvd/hookster
  * @author    Pronamic <[email protected]>
- * @copyright 2005-2021 Pronamic
+ * @copyright 2005-2022 Pronamic
  * @license   GPL-3.0-or-later
  * @package   Pronamic\WordPress\Documentor
  */

templates/markdown.php

@@ -4,7 +4,7 @@
  *
  * @link      https://guides.github.com/features/mastering-markdown/
  * @author    Pronamic <[email protected]>
- * @copyright 2005-2021 Pronamic
+ * @copyright 2005-2022 Pronamic
  * @license   GPL-3.0-or-later
  * @package   Pronamic\WordPress\Documentor
  */
@@ -70,7 +70,7 @@
 printf(
 	'<em>Generated by <a href="%s">Pronamic WordPress Documentor</a> <code>%s</code></em>',
 	'https://github.com/pronamic/wp-documentor',
-	'1.1.1'
+	'1.2.0'
 );
 
 echo '<p>';

templates/parts/markdown-hook.php

@@ -3,7 +3,7 @@
  * Markdown Hook Template.
  *
  * @author    Pronamic <[email protected]>
- * @copyright 2005-2021 Pronamic
+ * @copyright 2005-2022 Pronamic
  * @license   GPL-3.0-or-later
  * @package   Pronamic\WordPress\Documentor
  */