Skip to content

Commit

Permalink
Docs folder standardization and other fixes
Browse files Browse the repository at this point in the history
Differences from the testing.md file have been added to the internals.md file
  • Loading branch information
luizcmarin committed Apr 15, 2024
1 parent c08f204 commit 7e9690e
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 54 deletions.
40 changes: 0 additions & 40 deletions docs/en/internals.md

This file was deleted.

31 changes: 17 additions & 14 deletions docs/en/testing.md → docs/internals.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Testing
# Internals

This package can be tested globally or individually for each DBMS.

Expand Down Expand Up @@ -26,7 +26,7 @@ For greater ease it is recommended to use Docker containers for each DBMS, for t

For running the Docker containers you can use the following command:

```shell
```dockerfile
docker compose up -d
```

Expand Down Expand Up @@ -59,22 +59,13 @@ vendor/bin/phpunit --testsuite=Pgsql
```

Suites available:

- Mssql
- Mysql
- Oracle
- Pgsql
- Sqlite

## Composer require checker

This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`.

To run the checker, execute the following command:

```shell
./vendor/bin/composer-require-checker
```

## Mutation testing

The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
Expand All @@ -92,10 +83,22 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static
./vendor/bin/psalm
```

## Rector
## Code style

Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or use either newest or any specific version of PHP:
Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or
use either newest or any specific version of PHP:

```shell
./vendor/bin/rector
```

## Dependencies

Use [ComposerRequireChecker](https://github.com/maglnet/ComposerRequireChecker) to detect transitive
[Composer](https://getcomposer.org/) dependencies.

To run the checker, execute the following command:

```shell
./vendor/bin/composer-require-checker
```

0 comments on commit 7e9690e

Please sign in to comment.