-
-
Notifications
You must be signed in to change notification settings - Fork 221
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove execa.shell()
and execa.shellSync()
#219
Conversation
Fixed according to the code review. |
Fixed. |
index.d.ts
Outdated
@@ -65,6 +65,7 @@ declare namespace execa { | |||
|
|||
/** | |||
If `true`, runs `command` inside of a shell. Uses `/bin/sh` on UNIX and `cmd.exe` on Windows. A different shell can be specified as a string. The shell should understand the `-c` switch on UNIX or `/d /s /c` on Windows. | |||
We recommend against using this option since it is not cross-platform, slower and unsafe. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The TS text should be exactly what's in the readme. Easier to keep them in sync that way.
Can you fix the merge conflict? |
133af10
to
4efb7c9
Compare
Fixed |
Too bad you are not showing any concret example of before/after of this breaking change. |
Hi @kopax, You might get some extra information in this Medium article. Generally speaking: |
Thanks, I finally understood by myself, but that's always annoying to have to read the whole documentation to find how the breaking change is affecting our code. I recommend to always have a concrete migration example for all of them |
The release notes show: ### Breaking changes
- Remove `execa.shell()` and `execa.shellSync()`. The [`shell option`](https://github.com/sindresorhus/execa#shell) should be used instead. The |
I got through this but my advice is still valid, that's just general advice so people in general don't have to go through as I did. |
Fixes #211
Since the next version is a major release, I thought this would be the perfect time to directly remove those methods instead of deprecating them.