mirror of
https://github.com/ramsey/uuid.git
synced 2026-06-13 15:46:53 +03:00
Add Composer scripts as shortcuts to tests and doc generation
This commit is contained in:
+1
-3
@@ -56,9 +56,7 @@ When you do begin working on your feature, here are some guidelines to consider:
|
||||
The following tests must pass before we will accept a pull request. If any of these do not pass, it will result in a complete build failure. Before you can run these, be sure to `composer install`.
|
||||
|
||||
```
|
||||
./vendor/bin/parallel-lint src tests
|
||||
./vendor/bin/phpcs src tests --standard=psr2 -sp
|
||||
./vendor/bin/phpunit --verbose
|
||||
composer test
|
||||
```
|
||||
|
||||
### Locally Test With Emulated MIPS Architecture
|
||||
|
||||
@@ -77,7 +77,7 @@ The [latest class API documentation][apidocs] is available online.
|
||||
This project uses [ApiGen](http://apigen.org/) to generate this documentation. To generate the documentation on your own, install dev dependencies and run the following command from the root of the project:
|
||||
|
||||
```
|
||||
./vendor/bin/apigen generate --source="src" --destination="build/apidocs" --title="ramsey/uuid" --template-theme="bootstrap" --deprecated --todo
|
||||
composer build-docs
|
||||
```
|
||||
|
||||
This will generate documentation in the `build/apidocs/` folder.
|
||||
|
||||
@@ -63,5 +63,16 @@
|
||||
"branch-alias": {
|
||||
"dev-master": "3.x-dev"
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
"lint": "parallel-lint src tests",
|
||||
"phpunit": "phpunit --verbose --colors=always",
|
||||
"phpcs": "phpcs src tests --standard=psr2 -sp --colors",
|
||||
"test": [
|
||||
"@lint",
|
||||
"@phpunit",
|
||||
"@phpcs"
|
||||
],
|
||||
"build-docs": "apigen generate --source='src' --destination='build/apidocs' --template-theme='bootstrap' --deprecated --todo"
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user