vscode-gitops-tools icon indicating copy to clipboard operation
vscode-gitops-tools copied to clipboard

Describe instead of YAML

Open kingdonb opened this issue 3 years ago • 3 comments

Edit: Includes #270 (published as 0.20.0-alpha.2)

I'd still like to omit the ManagedFields from the describe output, maybe this can be refactored to present as an option in the API

I found the existing option in getResourceUri to use the "describe" action, it simplifies a lot and obviates some of the code still in this tree, but I kept it as this remains WIP. I'm not sure if we can opt into this behavior narrowly or if there are resources we would still want to present as YAML (there should be a right-click action to open the resource as YAML.)

kingdonb avatar May 13 '22 12:05 kingdonb

It's not so bad if we omit the Managed Fields section

kingdonb avatar May 13 '22 14:05 kingdonb

There is a tag at 0.20.0-alpha.1 with this feature in it.

The main drawback of doing it this way is, when you call OpenTextDocument without a URI, you get an anonymous text window that expects to be saved or it'll warn you that the content might be lost. There must be a way to avoid that behavior.

kingdonb avatar May 13 '22 14:05 kingdonb

This is complicated and low-priority as it has not been universally agreed upon that the Describe output is better, and adding a whole alternative to the k8smsx document URI format seems a bit heavyweight to get the functionality we need that should really be provided upstream. (Since kubectl describe is for human readers, it should have the same convenience features as kubectl get -oyaml with respect to human readers, namely the default exclusion of the Managed Fields block.)

I'm going to defer this to the next minor release since we'd like to have 0.20 out soonish, and this isn't getting done soon.

kingdonb avatar Jul 14 '22 17:07 kingdonb