Port list-dependencies under the new ls sub command
#3706
Conversation
There was a problem hiding this comment.
Looks good! I wonder if we could add some deprecation message like over here.
It isn't done much, but would be nice.
ChangeLog.md
Outdated
| @@ -13,6 +13,8 @@ Other enhancements: | |||
| * A new sub command `ls` has been introduced to stack to view | |||
| local and remote snapshots present in the system. Use `stack ls | |||
| snapshots --help` to get more details about it. | |||
| * `list-dependencies` has been deprecated. The functionality has | |||
| to accessed through the new `ls dependencies` interface. | |||
There was a problem hiding this comment.
We should also link out to the relevant issue here?
src/main/Main.hs
Outdated
| @@ -385,7 +385,7 @@ commandLineHandler currentDir progName isInterpreter = complicatedOptions | |||
| cleanCmd | |||
| cleanOptsParser | |||
| addCommand' "list-dependencies" | |||
| "List the dependencies" | |||
| "DEPRECATED: Use ls dependencies instead. Will be removed in next major version." | |||
There was a problem hiding this comment.
While it's a safe bet, no other deprecation notice specifies a time :/
There was a problem hiding this comment.
We actually haven't been so good at removing deprecated stuff.
There was a problem hiding this comment.
I'd say we should have list-dependencies output a warning (to stderr) that it may be removed at some point. Thing is, people do use it in scripts. We should probably wait until stack 2.0 or 3.0 to remove it. Best to avoid needless script breakage. Could hide it from the --help output next version, though.
|
LGTM, I'd like it to warn for the old list-dependencies command (but to stderr not stdout, since scripts use its stdout) |
|
Pushed some commits that fixes the above concerns. |
|
LGTM, thanks! 👍 |
This PR also deprecates the existing interface. Fixes #3669
Please include the following checklist in your PR:
Please also shortly describe how you tested your change. Bonus points for added tests!