Implement node wrapper #298
Merged
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
See changesets and README for full details. --- `skuba node` runs a TypeScript file; it's like a one-off `skuba start`. Unlike start, it gives you a REPL when you omit the command line entry point rather than falling back to the entry point in `package.json`. This PR also adds some secret sauce to automatically register the `src` module alias when you're running under `skuba node` or `skuba start`. This means that you only need a runtime module alias resolver like `import skuba-dive/register` at the top of production entry points; local scripts can be run with little fanfare using the skuba commands. --- Notes: - I considered calling the command `skuba exec`, but that sounds a bit awkward when it supports opening a REPL. - You may be wondering why don't we just use `tsconfig-paths`. This is tempting but I'm not convinced that we should depend on reading configuration out of `tsconfig.json` at runtime. This can be confusing given TypeScript is generally considered a compile-time concern, and our own templates only keep `lib` and `node_modules` in the runtime Docker image. - Diving into this has uncovered that the `@babel/node` REPL is pretty unusable with modern JavaScript/TypeScript. See the README for more.
🦋 Changeset detectedLatest commit: 17e3574 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
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.
See changesets and README for full details. Closes #84.
skuba noderuns a TypeScript file; it's like a one-offskuba start. Unlike start, it gives you a REPL when you omit the command line entry point rather than falling back to the entry point inpackage.json.This PR also adds some secret sauce to automatically register the
srcmodule alias when you're running underskuba nodeorskuba start. This means that you only need a runtime module alias resolver likeimport skuba-dive/registerat the top of production entry points; local scripts can be run with little fanfare using the skuba commands.Notes:
I considered calling the command
skuba exec, but that sounds a bit awkward when it supports opening a REPL.You may be wondering why don't we just use
tsconfig-paths.This is tempting but I'm not convinced that we should depend on reading configuration out of
tsconfig.jsonat runtime. This can be confusing given TypeScript is generally considered a compile-time concern, and our own templates only keeplibandnode_modulesin the runtime Docker image.Diving into this has uncovered that the
@babel/nodeREPL is pretty unusable with modern JavaScript/TypeScript. See the README for more.