Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs #181

Merged
merged 5 commits into from
May 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<p align="center">
<a href="https://github.com/yiisoft" target="_blank">
<img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="100px">
<img src="logo.png" height="100px">
<img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="100px" alt="Yii">
<img src="docs/logo.png" height="100px" alt="Config">
</a>
<h1 align="center">Yii Config</h1>
<br>
Expand All @@ -15,7 +15,7 @@
[![static analysis](https://github.com/yiisoft/config/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/config/actions?query=workflow%3A%22static+analysis%22)
[![type-coverage](https://shepherd.dev/github/yiisoft/config/coverage.svg)](https://shepherd.dev/github/yiisoft/config)

This [Composer](https://getcomposer.org/) plugin provides assembling of configurations distributed with composer
This [Composer](https://getcomposer.org) plugin provides assembling of configurations distributed with composer
packages. It is implementing a plugin system which allows to provide the configuration needed to use a package directly when installing it to make it run out-of-the-box.
The package becomes a plugin holding both the code and its default configuration.

Expand Down Expand Up @@ -108,25 +108,30 @@ The file paths are relative to the [source-directory](#source-directory), which
### Markers

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

```php
"params": [
"params.php",
"?params-local.php"
]
```

It's okay if `params-local.php` will not be found, but it's not okay if `params.php` will be absent.

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

```php
"web": [
"../src/Modules/*/config/web.php"
]
```

It will collect all `web.php` in any sub-folders of `src/Modules/` in `config` folder.
However, if the configuration folder is packaged as part of the `PHAR` archive, the configuration
files will not be uploaded. In this case, you must explicitly specify each configuration file.

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

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

The config groups `params-console` and `params-web` will both contain the config values from `params.php` and `params-local.php` additional to their own configuration values.

***
Expand Down Expand Up @@ -664,7 +670,7 @@ Maintained by [Yii Software](https://www.yiiframework.com/).
## 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.
originally created by HiQDev (<https://hiqdev.com/>) in 2016 and then adopted by Yii.

## Support the project

Expand Down
4 changes: 2 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@
"license": "BSD-3-Clause",
"support": {
"issues": "https://github.com/yiisoft/config/issues?state=open",
"source": "https://github.com/yiisoft/config",
"forum": "https://www.yiiframework.com/forum/",
"wiki": "https://www.yiiframework.com/wiki/",
"irc": "ircs://irc.libera.chat:6697/yii",
"chat": "https://t.me/yii3en",
"source": "https://github.com/yiisoft/config"
"chat": "https://t.me/yii3en"
},
"funding": [
{
Expand Down
File renamed without changes
Loading