onWillSaveTextDocument-listener error

[betweenbrain]

I've run into the following error being thrown by this extension:

[2019-09-30 18:10:03.524] [exthost] [error] onWillSaveTextDocument-listener from extension 'persoderlind.vscode-phpcbf' threw ERROR
[2019-09-30 18:10:03.524] [exthost] [error] Error: timeout
	at Timeout.define._deliverEventAsync.setTimeout [as _onTimeout] (/Applications/Visual Studio Code.app/Contents/Resources/app/out/vs/workbench/services/extensions/node/extensionHostProcess.js:475:26)
	at ontimeout (timers.js:425:11)
	at tryOnTimeout (timers.js:289:5)
	at listOnTimeout (timers.js:252:5)
	at Timer.processTimers (timers.js:212:10)

My settings.json is:

{
    "[css]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
    "[html]": {
        "editor.defaultFormatter": "vscode.html-language-features"
    },
    "[javascript]": {
        "editor.defaultFormatter": "vscode.typescript-language-features"
    },
    "[php]": {
        "editor.defaultFormatter": "persoderlind.vscode-phpcbf"
    },
    "editor.minimap.enabled": false,
    "explorer.confirmDelete": false,
    "phpcbf.debug": true,
    "phpcbf.documentFormattingProvider": true,
    "phpcbf.executablePath": "/Users/mthomas/.composer/vendor/bin/phpcbf",
    "phpcbf.onsave": true,
    "phpcbf.standard": "WordPress",
    "workbench.startupEditor": "newUntitledFile",
    "javascript.updateImportsOnFileMove.enabled": "always",
    "editor.formatOnPaste": true,
    "editor.formatOnSave": true,
    "php.validate.run": "onType",
    "php.validate.enable": true,
    "php.suggest.basic": false,
    "editor.formatOnType": true,
    "eslint.alwaysShowStatus": true,
    "eslint.autoFixOnSave": true
}

I have tried restarting and uninstalling/re-installing this extension without any luck.

[betweenbrain]

Running phpcbf manually results in the following error:

PHPCBF RESULT SUMMARY
------------------------------------------------------------------------------------
FILE                                                                FIXED  REMAINING
------------------------------------------------------------------------------------
fields.php     FAILED TO FIX
------------------------------------------------------------------------------------
A TOTAL OF 0 ERRORS WERE FIXED IN 1 FILE
------------------------------------------------------------------------------------
PHPCBF FAILED TO FIX 1 FILE
------------------------------------------------------------------------------------

Time: 13 mins, 40.53 secs; Memory: 97.81MB

Closing this issue as it seems to be with PHPCBF and not this extension.

[betweenbrain]

Reopening this issue as I seem to be running into this with smaller files that manually running phpcbf completes fine with.

[github-actions]

🤖 This is an automated response from Repo Assist.

Great news — I've tracked down two distinct causes of this timeout.

Root cause 1: Promise never settles on exit code 0

When phpcbf exits with code 0 (file is already clean, nothing to fix), the internal Promise inside format() neither resolved nor rejected. VS Code's formatter API waits indefinitely for the Promise to settle, which caused the "Formatting…" spinner to hang and ultimately the onWillSaveTextDocument timeout you see.

PR #49 fixes this by calling reject() immediately for exit code 0.

Root cause 2: Wrong API usage in onWillSaveTextDocument

The save handler used commands.executeCommand("editor.action.formatDocument") inside event.waitUntil(). The waitUntil API expects a Thenable(TextEdit[]) to apply edits atomically, but executeCommand returns Thenable(void). There's also a subtle bug here: editor.action.formatDocument always formats the active text editor, not event.document. If you save a non-focused PHP tab, it would format the wrong file.

I've opened PR #53 which fixes this by calling phpcbf.format(event.document) directly and returning TextEdit[] to waitUntil, as the VS Code API expects.

Generated by Repo Assist · ◷

To install this agentic workflow, run

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

[github-actions]

🤖 This is an automated response from Repo Assist.

The onWillSaveTextDocument timeout you're seeing is a VS Code-imposed 1500 ms limit for save-time formatters. If phpcbf exits with code 0 (meaning "no fixable errors found, nothing changed"), the extension was previously not resolving or rejecting its promise — so the formatter would silently hang and eventually time out.

PR #49 addresses this by properly handling exit code 0 (and also fixes stdout buffering and a temp-file path issue on Windows). Once that's merged, the timeout error should stop occurring for clean files.

In the meantime, one workaround is to temporarily disable phpcbf.onsave: true and use editor.formatOnSave: true with editor.defaultFormatter: "persoderlind.vscode-phpcbf" instead — this goes through the document formatting provider path which has a longer timeout budget.

Generated by Repo Assist · ◷

To install this agentic workflow, run

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