Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

build: replace phpDoc dependency

Browse source
This commit is contained in:
Ben Goldsworthy 2021-05-02 21:30:13 +01:00
parent 5afd55dba6
commit 4186eea797
2 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -92,8 +92,8 @@ _NB: `npm` can also be used in place of `composer`._
#### PHP #### PHP
PHP code must follow the [WordPress PHP Coding Standards][wpcs-php] and be PHP code must follow the [WordPress PHP Coding Standards][wpcs-php]. PHP code
compatible with PHP 7.0+. is written for compatability with PHP 8.0.
1. Run `composer run lint:php` to lint all PHP files with 1. Run `composer run lint:php` to lint all PHP files with
[PHP CodeSniffer][phpcs]; and [PHP CodeSniffer][phpcs]; and
@ -159,6 +159,8 @@ the `git push` command.
### Tooling ### Tooling
HTML documentation of the codebase is generated using [phpDocumentor][phpdocumentor]. 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`. phpDocumentor configuration settings are found in `phpdoc.dist.xml`.

2
composer.json
View file

@ -20,7 +20,7 @@
"lint:md": "npm run lint:md", "lint:md": "npm run lint:md",
"lint:md:fix": "npm run lint:md:fix", "lint:md:fix": "npm run lint:md:fix",
"lint:html": "npm run lint:html", "lint:html": "npm run lint:html",
"docs": "./vendor/bin/phpdoc", "docs": "phpDocumentor",
"post-install-cmd": "npm install", "post-install-cmd": "npm install",
"minify": "npm run minify", "minify": "npm run minify",
"minify:css": "npm run minify:css", "minify:css": "npm run minify:css",