Skip to content

Commit

Permalink
🔥 Remove deprecated Composer scripts and related 📝
Browse files Browse the repository at this point in the history
  • Loading branch information
nelson6e65 committed Dec 23, 2018
1 parent e5e9941 commit f5d129a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 26 deletions.
28 changes: 9 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# Contributing guidelines for PHP: Nelson Martell Library

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

### Initialization

Expand Down Expand Up @@ -41,23 +40,14 @@ yarn

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

- **`composer build`**: Run this sub-scripts:
1. **`composer build-code-coverage`**: Runs tests and build code coverage reports (XML and HTML formats) in `output/code-coverage/` directory.
- For XML format only (`output/code-coverage/clover.xml`): **`composer build-code-coverage-clover`** or **`composer build-code-coverage-xml`** (alias).
- For HTML format only: **`composer build-code-coverage-html`**.

- **`composer build-api`**: Generates API documentation in `output/api/` directory using [ApiGen](https://github.com/ApiGen/ApiGen).
- **`composer build-code-coverage`**: Runs tests and build code coverage reports (XML and HTML formats) in `output/code-coverage/` directory.
- **`composer build-code-coverage-clover`**: For XML format only (`output/code-coverage/clover.xml`)
- **`composer build-code-coverage-xml`**: Alias for `composer build-code-coverage-clover`.
- **`composer build-code-coverage-html`**: For HTML format only.


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

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

- **`yarn docs:build`**: Build the VuePress documentation to be published.




### Deployment scripts
[DEPRECATED]
- `.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**_.
7 changes: 0 additions & 7 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,6 @@
"test-code": [
"phpunit --color=always"
],
"build": [
"@build-code-coverage",
"@build-api"
],
"build-code-coverage": [
"phpunit --color=always --coverage-clover=\"output/code-coverage/clover.xml\" --coverage-html=\"output/code-coverage\""
],
Expand All @@ -74,9 +70,6 @@
],
"build-code-coverage-html": [
"phpunit --color=always --coverage-html=\"output/code-coverage\""
],
"build-api": [
"apigen generate src --destination output/api --ansi --no-interaction"
]
},
"extra": {
Expand Down

0 comments on commit f5d129a

Please sign in to comment.