Skip to content

[Repo Assist] docs: document configSearch setting and standard variable substitution#95

Draft
github-actions[bot] wants to merge 1 commit intomasterfrom
repo-assist/docs-configsearch-2026-03-18-bc5ba4af2f3c8456
Draft

[Repo Assist] docs: document configSearch setting and standard variable substitution#95
github-actions[bot] wants to merge 1 commit intomasterfrom
repo-assist/docs-configsearch-2026-03-18-bc5ba4af2f3c8456

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

🤖 This is an automated draft PR from Repo Assist, an AI assistant.

Summary

The phpcbf.configSearch setting has been present in package.json and the extension code since v0.0.9 but was never documented in the README. Users who need automatic phpcs.xml discovery have had to discover this feature by accident.

This PR:

  • Adds phpcbf.configSearch to the Extension Settings list with a description of what it does and when to use it
  • Adds phpcbf.configSearch: false to the default settings JSON block
  • Expands the phpcbf.standard entry to show that \$\{workspaceFolder}, \$\{workspaceRoot}, and ~/... paths are supported (this was added in v0.0.9 but not reflected in the README)

Motivation

Issues #7 and #17 both arise from users not knowing about these features:

  • Users set hardcoded absolute paths for standard when \$\{workspaceFolder} would work portably
  • Users don't know configSearch exists and can auto-locate their phpcs.xml

Test Status

Documentation-only change. All 7 unit tests pass (npm run test:unit).

Generated by Repo Assist ·

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/repo-assist.md@346204513ecfa08b81566450d7d599556807389f

Generated by Repo Assist ·

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/repo-assist.md@346204513ecfa08b81566450d7d599556807389f

- Add phpcbf.configSearch to the Extension Settings list with a clear
  description of its auto-discovery behaviour
- Update phpcbf.configSearch entry in the default-settings JSON block
- Expand the phpcbf.standard entry to show ,
  , and ~/... are supported in the path

Closes #17

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants