Skip to content

[Repo Assist] docs: improve setting descriptions in package.json #122

@github-actions

Description

@github-actions

🤖 This is an automated pull request from Repo Assist.

Summary

Three small but user-facing improvements to the package.json setting descriptions (shown in the VS Code Settings UI):

1. Fix typo in phpcbf.executablePath

Before:

Points to the phpcbf exectuable, eg: win: phpcbf.bat, other: phpcbf

After:

Path to the phpcbf executable. Examples: 'phpcbf' (if on PATH), '/usr/local/bin/phpcbf', '${workspaceFolder}/vendor/bin/phpcbf', '~/bin/phpcbf'. On Windows use 'phpcbf.bat'.

Also adds concrete path examples covering the most common configurations.

2. Update phpcbf.standard description

Before:

null, PSR1, PSR2, Symfony, WordPress etc. You can also point to a phpcs.xml rules file, eg: /file/path/phpcs.xml

After:

Coding standard to pass to phpcbf via --standard. Examples: PSR2, PSR12, WordPress, Symfony, or a path to a phpcs.xml file. Supports ${workspaceFolder}/phpcs.xml, ${workspaceRoot}/phpcs.xml (deprecated), ~/standards/MyStandard, and relative paths like ./phpcs.xml.

Changes:

  • Adds PSR12 (which phpcbf supports natively)
  • Mentions \$\{workspaceFolder} / \$\{workspaceRoot} / ~ / relative path support (these are already implemented in code but undocumented in settings)
  • Framed as "what to pass" rather than listing standards vaguely

3. Expand phpcbf.configSearch description

Before:

Search for phpcs configuration files in the workspace.

After:

When true, automatically searches for a phpcs configuration file (.phpcs.xml, phpcs.xml, phpcs.xml.dist, ruleset.xml, etc.) in the file's directory and up to the workspace root, and uses it as the coding standard. Takes precedence over phpcbf.standard when a config file is found.

Changes:

  • Lists the actual file names that are searched (matching the code's confFileNames array)
  • Explains walk-up behaviour and scope
  • Clarifies precedence over phpcbf.standard

Motivation

These descriptions appear directly in the VS Code Settings UI. Many user issues (#17, #38, #7) stem from not knowing about configSearch or the variable substitution support in standard. Better in-editor documentation helps users self-serve.

Test Status

✔ findFiles  7 tests pass
tests 7  pass 7  fail 0

(The change is documentation-only in package.json; no logic was changed.)

Generated by Repo Assist ·

To install this agentic workflow, run

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

Warning

🛡️ Protected Files

This was originally intended as a pull request, but the patch modifies protected files: package.json.

These files may affect project dependencies, CI/CD pipelines, or agent behaviour. Please review the changes carefully before creating the pull request.

Click here to create the pull request once you have reviewed the changes

To route changes like this to a review issue instead of blocking, configure protected-files: fallback-to-issue in your workflow configuration.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions