Skip to content

Commit

Permalink
Minor improve readme and .editorconfig (#115)
Browse files Browse the repository at this point in the history
  • Loading branch information
vjik authored Oct 21, 2023
1 parent 5267183 commit 2bd0df0
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
4 changes: 4 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ indent_style = space
indent_size = 4
trim_trailing_whitespace = true

[*.php]
ij_php_space_before_short_closure_left_parenthesis = false
ij_php_space_after_type_cast = true

[*.md]
trim_trailing_whitespace = false

Expand Down
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,12 @@ The package provides:
## Requirements

- PHP 8.0 or higher.
- `mbstring` PHP extension.

## Installation

```
composer require yiisoft/strings --prefer-dist
```shell
composer require yiisoft/strings
```

## StringHelper usage
Expand Down Expand Up @@ -249,10 +250,11 @@ The package is tested with [PHPUnit](https://phpunit.de/). To run tests:

### Mutation testing

The package tests are checked with [Infection](https://infection.github.io/) mutation framework. To run it:
The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:

```shell
./vendor/bin/infection
./vendor/bin/roave-infection-static-analysis-plugin
```

### Static analysis
Expand All @@ -263,6 +265,20 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static
./vendor/bin/psalm
```

### 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:

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

### Dependencies

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

## License

The Yii Strings is free software. It is released under the terms of the BSD License.
Expand Down

0 comments on commit 2bd0df0

Please sign in to comment.