Remove yarn link:bin script #135
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To adopt TypeScript, we previously used ts-node [1] in [2] as our shebang. However this required user to install ts-node as a sibling global dependency and effectively stopped using transpiled JavaScript files. So in [3] we reverted back to node to fix the issue in distribution. However locally when using `yarn/npm link`, it still links that very same script to global binary directory. Since locally we don't keep the JavaScript files (we only transpile them when packaging/publishing), it rendered the `yarn link:bin` setup broken. As it stands now, it's easier and more straightforward to rely on `yarn dev` which feeds the `run` script into ts-node, overriding its shebang. [1] https://github.com/TypeStrong/ts-node [2] 2b799dc [3] 0f59937
See [1]. oclif/core doesn't transpile using TypeScript 4.8 at the moment. [1] oclif/core#482
cl8au
approved these changes
Sep 8, 2022
etanxing
reviewed
Sep 8, 2022
| # Local development | ||
|
|
||
| You can run `yarn --cwd /path/to/zcli dev` in a development environment without transpiling ZCLI into JavaScript. | ||
|
|
There was a problem hiding this comment.
could you leave an example here? I usually use something like yarn dev apps:server ./zcli-demo-4
There was a problem hiding this comment.
I added an example in ee8dd0d. Does it work for you?
etanxing
approved these changes
Sep 8, 2022
|
I'm gonna close this for now since it doesn't work well with things like apps:new, which now creates the new folder in zcli/ instead of $PWD/ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
88e105a Remove yarn link:bin script
To adopt TypeScript, we previously used ts-node [1] in [2] as our
shebang. However this required user to install ts-node as a sibling
global dependency and effectively stopped using transpiled JavaScript
files.
So in [3] we reverted back to node to fix the issue in distribution.
However locally when using
yarn/npm link, it still links that verysame script to global binary directory. Since locally we don't keep the
JavaScript files (we only transpile them when packaging/publishing), it
rendered the
yarn link:binsetup broken.As it stands now, it's easier and more straightforward to rely on
yarn devwhich feeds therunscript into ts-node, overriding its shebang.[1] https://github.com/TypeStrong/ts-node
[2] 2b799dc
[3] 0f59937
ce8e79a Pin TypeScript to <4.8 to avoid oclif/core error
See [1]. oclif/core doesn't transpile using TypeScript 4.8 at the
moment.
[1] oclif/core#482
Detail
Checklist