From 4186eea79784da53940462a45fab01a4b7332f53 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sun, 2 May 2021 21:30:13 +0100 Subject: [PATCH] build: replace phpDoc dependency --- CONTRIBUTING.md | 6 ++++-- composer.json | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 51c4e49..a7b70aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -92,8 +92,8 @@ _NB: `npm` can also be used in place of `composer`._ #### PHP -PHP code must follow the [WordPress PHP Coding Standards][wpcs-php] and be -compatible with PHP 7.0+. +PHP code must follow the [WordPress PHP Coding Standards][wpcs-php]. PHP code +is written for compatability with PHP 8.0. 1. Run `composer run lint:php` to lint all PHP files with [PHP CodeSniffer][phpcs]; and @@ -159,6 +159,8 @@ the `git push` command. ### Tooling HTML documentation of the codebase is generated using [phpDocumentor][phpdocumentor]. +Due to conflicts, this cannot be included as a project dependency. Please install +the package globally by following the steps on the site. phpDocumentor configuration settings are found in `phpdoc.dist.xml`. diff --git a/composer.json b/composer.json index db020a0..c841804 100644 --- a/composer.json +++ b/composer.json @@ -20,7 +20,7 @@ "lint:md": "npm run lint:md", "lint:md:fix": "npm run lint:md:fix", "lint:html": "npm run lint:html", - "docs": "./vendor/bin/phpdoc", + "docs": "phpDocumentor", "post-install-cmd": "npm install", "minify": "npm run minify", "minify:css": "npm run minify:css",