Paraunit

https://github.com/facile-it/paraunit
Admin
Paraunit is a command-line tool that speeds up PHPUnit test suite execution and coverage collection...
Tokens:33,387
Snippets:237
Trust Score:9.5
License:Apache-2.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install dependencies with Composer

Source: https://github.com/facile-it/paraunit/blob/2.x/CONTRIBUTING.md

Installs all project dependencies inside the container using Composer, which is available globally.

```bash
composer install
```

--------------------------------

### Install via Composer CLI

Source: https://github.com/facile-it/paraunit/blob/2.x/README.md

Install Paraunit as a development dependency using Composer from the command line.

```bash
composer require --dev facile-it/paraunit
```

--------------------------------

### Clone the repository

Source: https://github.com/facile-it/paraunit/blob/2.x/CONTRIBUTING.md

Clones the Paraunit repository from GitHub. Use this as the first step to start contributing.

```bash
git clone git@github.com:facile-it/paraunit.git
```

--------------------------------

### Run the test suite with PHPUnit

Source: https://github.com/facile-it/paraunit/blob/2.x/CONTRIBUTING.md

Launches the test suite to verify the environment is ready. The shell has ./bin in the $PATH environment variable.

```bash
phpunit
```

--------------------------------

### Open a shell to build the container

Source: https://github.com/facile-it/paraunit/blob/2.x/CONTRIBUTING.md

Builds and opens a shell inside the Docker container. The build process is cached by Docker, so it is slow only the first time.

```bash
make shell
```

--------------------------------

### Move into the repository folder

Source: https://github.com/facile-it/paraunit/blob/2.x/CONTRIBUTING.md

Changes the current directory to the cloned Paraunit repository.

```bash
cd paraunit
```

--------------------------------

### Run tests with Paraunit

Source: https://github.com/facile-it/paraunit/blob/2.x/README.md

Execute all tests in all configured test suites using the Paraunit console command.

```bash
vendor/bin/paraunit run
```

--------------------------------

### Collect test coverage

Source: https://github.com/facile-it/paraunit/blob/2.x/README.md

Collect test coverage in parallel and generate an HTML report in the specified directory.

```bash
vendor/bin/paraunit coverage --html=./dir
```

--------------------------------

### Add to composer.json

Source: https://github.com/facile-it/paraunit/blob/2.x/README.md

Add the package to the require-dev section of composer.json for a project.

```json
{
    "require-dev": {
        "facile-it/paraunit": "^2.0"
    }
}
```
Tokens:
Raw