Condition of using vscode-phpcbf on vscode-insiders

[contactjavas]

General Info

OS: Windows 10
Node: 10.8.0
NPM: 6.1.0
VSCode: Insiders build

Simple Description

I have read #21, and i think i should open separate issue.

So, vscode-phpcbf extension works well before 15 August 2018 and start to not working anymore after that. I did some trial and here is my conclusion:

When does it not work?

• When i set "phpcbf.standard": "phpcs.xml" or "phpcbf.standard": "./phpcs.xml"
• Even if i change the standard to a rule name, it still doesn't format on save even though i set
  "phpcbf.onsave": true and "editor.formatOnSave": true

When does it work?

(Glad, i can still use this extension)

• Since i use WordPress, my setting is set to "phpcbf.standard": "WordPress". This works, but only if i use Shift Alt F (Format document) command. Simply saving the document won't format it automatically.

[contactjavas]

Update 17 August 2018:

• Saving the changes manually (through Ctrl S) works now, it formats the code
• Saving through autoSave still doesn't format the code
• Even though saving document manually formats the code, it only works if i specify the phpcbf.standard to certain standard name (in my case, WordPress).
• Setting up phpcbf.standard to phpcs.xml or ./phpcs.xml still doesn't work (doesn't format the document).

[github-actions]

🤖 This is an automated response from Repo Assist.

There are two separate issues here — let me address both:

1. phpcbf.standard: "phpcs.xml" (relative path) not resolving

The extension historically passed the standard path as-is to phpcbf, which then tried to resolve it relative to the temp file location (in the OS temp directory), not your workspace root. This is why a relative path fails.

Fix: Use ${workspaceFolder} to make the path absolute. PR #47 (now merged) added ${workspaceFolder} / ${workspaceRoot} expansion for phpcbf.standard, so changing your setting to:

"phpcbf.standard": "${workspaceFolder}/phpcs.xml"

should resolve correctly after updating to version 0.0.9.

Alternatively, enable "phpcbf.configSearch": true — the extension will automatically walk up the directory tree looking for phpcs.xml, .phpcs.xml, phpcs.xml.dist, etc., without needing to specify the path manually.

2. Formatting on save not running automatically

The onWillSaveTextDocument handler in the extension only triggers its own format command when editor.formatOnSave === false (to avoid double-formatting). If you have "[php]": { "editor.formatOnSave": true }, VS Code handles the save-format cycle itself via the registered DocumentFormattingProvider — you don't need "phpcbf.onsave": true as well.

If auto-save (not manual Ctrl+S) is the issue, note that VS Code's afterDelay auto-save mode does not trigger onWillSaveTextDocument. Using "files.autoSave": "onFocusChange" or "onWindowChange" will trigger the formatter on save; "afterDelay" will not.

Generated by Repo Assist · ◷

To install this agentic workflow, run

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