Closes #153 with documentation update #155
Conversation
Codecov Report
@@ Coverage Diff @@
## master #155 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 3 3
Lines 57 57
Branches 13 13
=====================================
Hits 57 57Continue to review full report at Codecov.
|
|
|
||
| They will be available to subprocesses as normal however: | ||
|
|
||
| ```javascript |
There was a problem hiding this comment.
Maybe we could get rid of the two other examples and just use this one. Nobody wants the behavior of the other two examples so they are just noise in the README.
There was a problem hiding this comment.
FWIW I have scripts that use the behaviour of the other two examples in a multi-platform Jenkins pipeline so they would have been useful to me.
There was a problem hiding this comment.
Interesting... How is that useful? Do you choose which to run based on the platform you're using? Doesn't that sort of defeat the purpose of using cross-env?
There was a problem hiding this comment.
We use cross-env to declare env vars across different platforms in a common way high in the calling chain, then specialise as late as possible for paths, commands, switches, error handling and other cross platform incompatibilities.
There was a problem hiding this comment.
I think a better example would be (I haven't tested it, away from work computer):
"parentScript": "cross-env GREET=\"Joe\" npm run childScript",
"childScript": "cross-env echo Hello $GREET"
Basically everywhere you declare or use an env variable, you need to parse that command through cross-env or cross-env-shell, but it's possible to make a full scripts suite multi-platform.
There was a problem hiding this comment.
For me:
"parentScript": "cross-env GREET=\"Joe\" npm run childScript",
"childScript": "cross-env echo Hello $GREET"
run in cmd.exe on Windows results in:
C:\Users\Me\temp>npm run parentScript
> temp@1.0.0 parentScript C:\Users\Me\temp
> cross-env GREET="Joe" npm run childScript
> temp@1.0.0 childScript C:\Users\Me\temp
> cross-env echo Hello $GREET
Hello %GREET%
There was a problem hiding this comment.
Huh, weird. I'm honestly not too concerned about this because the use case I'm interested in doesn't involve setting env variables in one script and using them in another 🤷♂️
There was a problem hiding this comment.
My bad, it needs to be:
"parentScript": "cross-env GREET=\"Joe\" npm run childScript",
"childScript": "cross-env-shell echo Hello $GREET"
I just use cross-env-shell always so I forget the differences between both commands haha
There was a problem hiding this comment.
Actually that might be the update the README needs!
There was a problem hiding this comment.
Yes, let's do it 👍
Though I think that it should be:
"parentScript": "cross-env GREET=\"Joe\" npm run childScript",
"childScript": "cross-env-shell \"echo Hello $GREET\""
|
Switching from |
After discussion on kentcdodds#155 this seems like the better solution.
See #153 for discussion..