tsx 3.5.0 → 3.7.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Hiroki Osame <hiroki.osame@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,4 +1,4 @@
-# tsx
+# tsx <a href="https://npm.im/tsx"><img src="https://badgen.net/npm/v/tsx"></a> <a href="https://npm.im/tsx"><img src="https://badgen.net/npm/dm/tsx"></a> <a href="https://packagephobia.now.sh/result?p=tsx"><img src="https://packagephobia.now.sh/badge?p=tsx"></a>
 
 > _TypeScript Execute (`tsx`)_: Node.js enhanced with [esbuild](https://esbuild.github.io/) to run TypeScript & ESM files
 
@@ -9,8 +9,10 @@
 - Supports `node:` import prefixes
 - Hides experimental feature warnings
 - TypeScript REPL
+- Resolves `tsconfig.json` [`paths`](https://www.typescriptlang.org/tsconfig#paths)
 - Tested on Linux & Windows with Node.js v12~18
 
+<sub>Support this project by ⭐️ starring and sharing it. [Follow me](https://github.com/privatenumber) to see what other cool projects I'm working on! ❤️</sub>
 
 ## About
 `tsx` is a CLI command (alternative to `node`) for seamlessly running TypeScript & ESM, in both `commonjs` & `module` package types.
@@ -65,6 +67,9 @@ tsx ...
 
 ## Usage
 
+`tsx` is designed to be a drop-in replacement for `node`, so you can use it just the way you would use Node.js. All command-line arguments (with the exception of a few) are propagated to Node.js.
+
+
 ### Run TypeScript / ESM / CJS module
 
 Pass in a file to run:
@@ -73,8 +78,17 @@ Pass in a file to run:
 tsx ./file.ts
 ```
 
+#### Custom `tsconfig.json` path
+By default, `tsconfig.json` will be detected from the current working directory.
+
+To set a custom path, use the `--tsconfig` flag:
+
+```sh
+tsx --tsconfig ./path/to/tsconfig.custom.json ./file.ts
+```
+
 ### Watch mode
-Run file and automatically re-run on changes:
+Run file and automatically rerun on changes:
 
 ```sh
 tsx watch ./file.ts
@@ -83,7 +97,9 @@ tsx watch ./file.ts
 All imported files are watched except from the following directories:
 `node_modules`, `bower_components`, `vendor`, `dist`, and `.*` (hidden directories).
 
-Press <kbd>Return</kbd> to manually re-run.
+#### Tips
+- Press <kbd>Return</kbd> to manually rerun
+- Pass in `--clear-screen=false` to disable clearing the screen on rerun
 
 ### REPL
 Start a TypeScript REPL by running with no arguments:
@@ -130,6 +146,12 @@ NODE_OPTIONS='--loader tsx' node ./file.ts
 
 ## FAQ
 
+### Why is it named `tsx`?
+
+`tsx` stands for "TypeScript execute", similar to [`npx`](https://docs.npmjs.com/cli/v8/commands/npx) ("Node.js package execute").
+
+It has an unfortunate overlap with React's [TSX/JSX](https://www.typescriptlang.org/docs/handbook/jsx.html), which stands for "JavaScript XML". However, we believe the naming is appropriate for what it does.
+
 ### Does it do type-checking?
 
 No, [esbuild does not support type checking](https://esbuild.github.io/faq/#:~:text=TypeScript%20type%20checking%20(just%20run%20tsc%20separately)).
@@ -148,3 +170,12 @@ Because esbuild doesn't do type checking, `tsx` is more equivalent to `ts-node -
 [Here's an exhaustive comparison](https://github.com/privatenumber/ts-runtime-comparison) between `tsx` vs `ts-node` (and other runtimes).
 
 If you migrated from `ts-node`, please share your performance gains [here](https://github.com/esbuild-kit/tsx/discussions/10)!
+
+
+### Can it use esbuild plugins?
+
+No. tsx uses esbuild's [Transform API](https://esbuild.github.io/api/#transform-api), which doesn't support plugins.
+
+### Does it have a configuration file?
+
+No. tsx's integration with Node.js is designed to be seamless so there is no configuration.