Change default of onSave to true?

[karlhorky]

Hi there, first of all, thanks so much for this extension. Saves so much time and is great for teaching!

I was wondering if you would consider a change of the default of the onSave option to true instead of false. It would make the "out of the box" UX much nicer, since the lens won't complain about errors as you are still typing.

Just trying this option out, I see that it doesn't extend to files that have just been opened. Maybe this could also be part of the default? I'm thinking of a default behavior something like:

1. Check for errors and show lenses when the user opens a file (opened separately in Check for errors and show lenses when the user opens a file #57)
2. Check for errors and show lenses when the user saves a file

What are your thoughts?

[karlhorky]

Oh, I just realized, this setting is a bit buggy sometimes. Sometimes TypeScript diagnostics come back slowly after save, and the extension does not update them.

For example, here the diagnostics from TypeScript are already gone and resolved (no squiggly underlines), but the lenses are still there 😟

I guess this would need to be fixed if it would become the default...

---

If I should open another issue for this, happy to do so.

[usernamehw]

I was wondering if you would consider a change of the default of the onSave option to true instead of false.

Changing the default won't happen because I believe a lot of people are using vscode setting "files.autoSave": "afterDelay" that makes this feature behave unpredictable (decorations would render by interval timer).

Check for errors and show lenses when the user opens a file

This can be easily added.

Sometimes TypeScript diagnostics come back slowly after save

Do you have an approximate time of how slow they are? I can increase interval at

vscode-error-lens/src/eventListeners.ts

Line 38 in 0679076

if (Date.now() - Global.lastSavedTimestamp < 1000) {

from 1000 to, perhaps, 3000. But this will make all the diagnostics change events to render for 3 seconds after the save. Can possibly add a setting for this delay.

[karlhorky]

Changing the default won't happen because I believe a lot of people are using vscode setting "files.autoSave": "afterDelay" that makes this feature behave unpredictable

Ah, that's understandable. How about setting default to: onSave: files.autoSave !== 'afterDelay'?

Do you have an approximate time of how slow they are?

Ah yeah this is very different, based on a lot of factors (size of the project, what else is running on the computer, etc).

I guess a callback-based approach would be better. I don't know too much about VS Code extension development, but maybe using a "save provider" or similar would work? I'm thinking, some way to do work after all other save providers have done things.

Some ideas:

1. In the early versions of prettier-vscode, they used workspace.onWillSaveTextDocument (see https://github.com/prettier/prettier-vscode/blob/0.6.0/src/extension.ts#L23) ...
2. ...although then they switched to DocumentFormattingEditProvider afterwards (https://github.com/prettier/prettier-vscode/blob/725e9bbd137cc5b0699d90f6ab12df91f36af05f/src/PrettierEditProvider.ts#L16)

[karlhorky]

Ok I split out the one request into a separate issue (#57) here for easier tracking:

1. Check for errors and show lenses when the user opens a file

[usernamehw]

• Extension now uses onWillSave event and that makes it work even when auto save is enabled
• There's a new setting onSaveTimeout for that interval after save

You can try it out and leave feedback if it works better than before:

errorlens-3.2.0.zip

Change file extension from .zip to .vsix to install.

The default value of onSave remains the same. I don't think it will ever be changed. Sorry.

[karlhorky]

Trying this now, and it is working well, thanks! 🙌

Since the default will stay with false, I'll close this issue then.

I guess 3.3.0 will be the release with these changes?

[karlhorky]

I've also asked the VS Code project whether they'd be open for adding a reason property on DiagnosticChangeEvent, which would allow removal of the onSaveTimeout check:

microsoft/vscode#105140

[usernamehw]

I don't think it works that way. The diagnostic changes when the document changes - it doesn't know/care about document saves.

[karlhorky]

I suppose that is possible. It would be nice to be able to trace the diagnostic change event back to what event caused them though (kind of like a stack trace).