yiisoft / yiisoft/config

Ability to explain on how config is built

Open
#125 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type:enhancement
Dominant language
PHP
Stars
34
Forks
9
Avg merge
1h 7m
Merged PRs (30d)
1

Description

Problem

It can be hard to get an idea on what files are read when getting a key from a certain config group and environment.

Solution

Either have a config/explain console command or debugger panel that gives you details about how configs are read and where the key requested was found.

./yii config/explain --env=prod --group=params --key=cache.enabled

config/params.php - found
config/params-local.php - not found

Key is loaded from config/params.php

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the proposed yii config/explain console entry point and compare it with the alternative debugger panel described in the issue. Done means showing the files read for the selected environment and group, whether the key was found in each file, and which file supplied it.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
cli, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.