Skip to content

Commit

Permalink
Docs folder standardization and other fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
luizcmarin committed Apr 18, 2024
1 parent 9650adc commit b83bcd9
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 46 deletions.
8 changes: 4 additions & 4 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
Copyright © 2008 by Yii Software (https://www.yiiframework.com/)
Copyright © 2008 by Yii Software (<https://www.yiiframework.com/>)
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

* Redistributions of source code must retain the above copyright
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
* Neither the name of Yii Software nor the names of its
* Neither the name of Yii Software nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.

Expand Down
55 changes: 16 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ The file paths are relative to the [source-directory](#source-directory), which

- `?` - marks optional files. Absence of files not marked with this marker will cause exception.

```
```php
"params": [
"params.php",
"?params-local.php"
Expand All @@ -120,7 +120,7 @@ The file paths are relative to the [source-directory](#source-directory), which

- `*` - marks wildcard path. It means zero or more matches by wildcard mask.

```
```php
"web": [
"../src/Modules/*/config/web.php"
]
Expand All @@ -132,7 +132,7 @@ The file paths are relative to the [source-directory](#source-directory), which

- `$` - reference to another config by its group name.

```
```php
"params": [
"params.php",
"?params-local.php"
Expand Down Expand Up @@ -373,7 +373,7 @@ we use `$web` configuration from the main environment.

This configuration has the following structure:

```
```text
config/ Configuration root directory.
dev/ Development environment files.
app.php Development environment app group configuration.
Expand Down Expand Up @@ -653,44 +653,14 @@ composer yii-config-info
composer yii-config-info yiisoft/widget
```

## Testing

### Unit testing

The package is tested with [PHPUnit](https://phpunit.de/). To run tests:

```shell
./vendor/bin/phpunit --testdox --no-interaction
```

### Mutation testing

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/roave-infection-static-analysis-plugin
```

### Static analysis
## Documentation

The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
- More information can be found in the [Internals.](docs/internals.md)

```shell
./vendor/bin/psalm
```

## License

The config package is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).
## Support

## Credits

The plugin is heavily inspired by [Composer config plugin](https://github.com/yiisoft/composer-config-plugin)
originally created by HiQDev (<https://hiqdev.com/>) in 2016 and then adopted by Yii.
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).

## Support the project

Expand All @@ -703,3 +673,10 @@ originally created by HiQDev (<https://hiqdev.com/>) in 2016 and then adopted by
[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)
[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)
[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)

## License

The Yii Access is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).
5 changes: 2 additions & 3 deletions docs/internals.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,9 @@ use either newest or any specific version of PHP:
./vendor/bin/rector
```

## Dependencies
## Composer require checker

Use [ComposerRequireChecker](https://github.com/maglnet/ComposerRequireChecker) to detect transitive
[Composer](https://getcomposer.org/) dependencies.
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:

Expand Down

0 comments on commit b83bcd9

Please sign in to comment.