search

chubin / cheat.sheets

cheat.sh cheat sheets repository
MIT License
598 stars 209 forks source link

Add yq sheet #140

Closed raymondchen625 closed 3 years ago

raymondchen625 commented 3 years ago

Added a sheet for ya, the YAML processing tool.

SuperSandro2000 commented 3 years ago

This probably needs an update with 4.0.0.

https://github.com/mikefarah/yq/releases/tag/4.0.0-alpha1

chubin commented 3 years ago

@SuperSandro2000 Some of the commands will be changed?

SuperSandro2000 commented 3 years ago

Baasically all of them and they are not backwards compatible. See https://mikefarah.gitbook.io/yq/v/v4.x-alpha/upgrading-from-v3

ghost commented 3 years ago

Under the original blocks, how about adding an updated version? So that people on older versions can still have that information, and people on newer versions will understand what it was, which might be useful for scripting purposes or if they also have an older version on another machine, for whatever reason.

So:

# Description of old command
old command
# Description of old command with updated syntax. Include version number.
old command with updated syntax.

What do you think?

raymondchen625 commented 3 years ago

Cheat sheets are supposed to be short. I would like to only keep those only work with the latest version. But indicating the version at the beginning is a good idea.

On Fri, Nov 20, 2020 at 11:01 Terminal for Life notifications@github.com wrote:

Under the original blocks, how about adding an updated version? So that people on older versions can still have that information, and people on newer versions will understand what it was, which might be useful for scripting purposes or if they also have an older version on another machine, for whatever reason.

So:

Description of old command

old command

Description of old command with updated syntax. Include version number.

old command with updated syntax.

What chu fink?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/chubin/cheat.sheets/pull/140#issuecomment-731254313, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACXY4RZFAMNPIZLK3OMOA3SQ2HGLANCNFSM4T4EXXXQ .

chubin commented 3 years ago

I think that we should display the fragments which are relevant for the current (stable) version of the program. The rest should be show only if it is requested explicitly.

Of course, to implement it, we need to:

  1. make it possible to mark some blocks as applicable to some version only
  2. make cheat.sh know what versions are actual at the moment.

I think, the (2) is quite useful and interesting and I have a couple of ideas how it could be implemented

raymondchen625 commented 3 years ago

Yes, keeping all in one sheet is ideal. I imagine the markups will include things like @since, @deprecated @removed. For a total breaking change like yq 4, all v3 commands will have @removed=4. Things like that.

On Sun, Nov 22, 2020 at 05:38 Igor Chubin notifications@github.com wrote:

I think that we should display the fragments which are relevant for the current (stable) version of the program. The rest should be show only if it is requested explicitly.

Of course, to implement it, we need to:

  1. make it possible to mark some blocks as applicable to some version only
  2. make cheat.sh know what versions are actual at the moment.

I think, the (2) is quite useful and interesting and I have a couple of ideas how it could be implemented

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/chubin/cheat.sheets/pull/140#issuecomment-731727837, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACXY4TJL5RKEBGDQUT3DLTSRDS2FANCNFSM4T4EXXXQ .