Add event information in onDidSaveTextDocument

[SamVerschueren]

• VSCode Version: 1.0.0
• OS Version: Mac OSX

It would be nice if extensions are able to distinguish the autoSave event from a manual save. We need this information in our EditorConfig extension.

// @bpasero @jrieken

[jrieken]

This is a duplicate of #239

[SamVerschueren]

Is this actually really a duplicate of that issue? That issue is about adding new event types like onPreSaveTextDocument. This is more about adding extra information to the event being dispatched.

As you said before, it's quite difficult to change that without breaking the API. Currently only the TextDocument is being dispatched. It would be possible to attach an event type to the TextDocument but that's not perfect. It would make more sense if it was an event object, something like

interface EventObject {
    document: TextDocument,
    action: string
}

Where action is something like autoSave or save. But that will off course break the entire API.

[jrieken]

Sorry, I was wrong here... yeah, it's on_Will_ and on_Did_... Will be hard to make it work in a nice way...

[NinoFloris]

How is everything doing here?

[jrieken]

Since we are facing API breakage with this, it might help if we expose the required data in the onWillSaveTextDocument-event. The save reason is something we try to squeeze in for Sep (#239 (comment))

[SamVerschueren]

@jrieken Would this still be considered in VS Code 2.0.0 or something? It feels a little like a design flaw to pass in the TextDocument directly as event instead of an event object with the property document and some extra properties like the save reason? I'm ok if not, it's the call of the core team, just want to make sure you guys did consider it :).

[jrieken]

It clearly is a design flaw and could not come up with a back-wards compatible way to introducing such an event unless its like SaveEvent extends TextDocument which is a little weird. Maybe some TS/JS trickery ala Event<TextDocument & SaveEvent>

[SamVerschueren]

If VS Code 2.x means breaking changes (major semver change), it might be possible to push this through. BUT, I understand that this is very hard to do because that means that every extension relying on this behaviour (which is probably 99% of all the extensions), will not work on VS Code 2.x.

Maybe some TS/JS trickery ala Event<TextDocument & SaveEvent>

Yes, if that would be backwards compatible AND if somehow, we could force in the type definitions, that in the next version the object returned is an Event object with properties document and some extra's (which under the hood actually still is a TextDocument with just some extra properties). Then, one day, we might be able to get rid of the hack.

I think it might be worth exploring as this might allow to add new features more easily in the future.

[jrieken]

Closing this because it would require API breakage and because the information asked for is available in the onWillSave-event