Skip to content

Commit f5d129a

Browse files
committed
🔥 Remove deprecated Composer scripts and related 📝
1 parent e5e9941 commit f5d129a

File tree

2 files changed

+9
-26
lines changed

2 files changed

+9
-26
lines changed

CONTRIBUTING.md

+9-19
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
# Contributing guidelines for PHP: Nelson Martell Library
22

33
## Global requirements
4-
- Git
5-
- PHP 5.6+
6-
- [Composer](https://getcomposer.org/)
7-
- Node.js
8-
- [Yarn](https://yarnpkg.com)
9-
- [phpDocumentor](https://www.phpdoc.org/)
4+
- `git` - [Git](https://git-scm.com/)
5+
- `php` - PHP 5.6+
6+
- `composer` - [Composer](https://getcomposer.org/)
7+
- `yarn` - [Yarn](https://yarnpkg.com) (and `node` v8+)
8+
- `phpdoc` - [phpDocumentor](https://www.phpdoc.org/)
109

1110
### Initialization
1211

@@ -41,23 +40,14 @@ yarn
4140

4241
- **`composer check-all`**: Runs coding standard analisis (PHP: Code Sniffer) + tests (PHPUnit).
4342

44-
- **`composer build`**: Run this sub-scripts:
45-
1. **`composer build-code-coverage`**: Runs tests and build code coverage reports (XML and HTML formats) in `output/code-coverage/` directory.
46-
- For XML format only (`output/code-coverage/clover.xml`): **`composer build-code-coverage-clover`** or **`composer build-code-coverage-xml`** (alias).
47-
- For HTML format only: **`composer build-code-coverage-html`**.
48-
49-
- **`composer build-api`**: Generates API documentation in `output/api/` directory using [ApiGen](https://github.com/ApiGen/ApiGen).
43+
- **`composer build-code-coverage`**: Runs tests and build code coverage reports (XML and HTML formats) in `output/code-coverage/` directory.
44+
- **`composer build-code-coverage-clover`**: For XML format only (`output/code-coverage/clover.xml`)
45+
- **`composer build-code-coverage-xml`**: Alias for `composer build-code-coverage-clover`.
46+
- **`composer build-code-coverage-html`**: For HTML format only.
5047

5148

5249
- **`phpdoc`**: Generates the API documentation files (`*.md`) compatible with VuePress.
5350

5451
- **`yarn docs:dev`**: Generates VuePress documentation in development mode to check changes while writing.
5552

5653
- **`yarn docs:build`**: Build the VuePress documentation to be published.
57-
58-
59-
60-
61-
### Deployment scripts
62-
[DEPRECATED]
63-
- `.travis/deploy-documentation`: Generates documentation and publish it in `gh-pages` brach. **Note:** _This script is used by [Travis CI](travis-ci.org) to publish documentation and **should not be run in local development**_.

composer.json

-7
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,6 @@
5959
"test-code": [
6060
"phpunit --color=always"
6161
],
62-
"build": [
63-
"@build-code-coverage",
64-
"@build-api"
65-
],
6662
"build-code-coverage": [
6763
"phpunit --color=always --coverage-clover=\"output/code-coverage/clover.xml\" --coverage-html=\"output/code-coverage\""
6864
],
@@ -74,9 +70,6 @@
7470
],
7571
"build-code-coverage-html": [
7672
"phpunit --color=always --coverage-html=\"output/code-coverage\""
77-
],
78-
"build-api": [
79-
"apigen generate src --destination output/api --ansi --no-interaction"
8073
]
8174
},
8275
"extra": {

0 commit comments

Comments
 (0)