Skip to content

Commit

Permalink
⚒️ add legacy warning
Browse files Browse the repository at this point in the history
  • Loading branch information
Gin-Quin committed Dec 14, 2023
1 parent 506bfd9 commit 1d984e1
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
> **This package has been moved to [esrun](https://www.npmjs.com/package/esrun). This is a legacy version.**
# esrun
**esrun** is a "work out of the box" library to execute Typescript (as well as modern Javascript with decorators and stuff) without having to use a bundler. This is useful for quick demonstrations or when launching your tests written in Typescript.

Expand All @@ -15,7 +17,7 @@ Install the library globally with your favorite package manager:


```shell
npm i -g @digitak/esrun
npm i -g esrun
```

Then you can execute any Typescript file in the same way Node would execute a Javascript file:
Expand All @@ -40,7 +42,7 @@ External module dependencies won't be bundled, it's up to the `node` engine to r
Install the library locally with your favorite package manager.

```shell
npm i -D @digitak/esrun
npm i -D esrun
```

Then you can use it in your `package.json` scripts:
Expand Down Expand Up @@ -213,7 +215,7 @@ If the given entry point is a directory, the following actions will be executed
The library exports a single function that you can use to programmatically execute a Typescript file.

``` ts
import esrun from '@digitak/esrun'
import esrun from 'esrun'

export async function esrun(filePath: string, options?: Options): Promise<void>

Expand Down Expand Up @@ -267,7 +269,7 @@ export type Options = {
To have full control, you can create your own script runner instance:
```ts
import { Runner } from '@digitak/esrun'
import { Runner } from 'esrun'

const runner = new Runner(inputFile: string, options?: Options)

Expand Down

0 comments on commit 1d984e1

Please sign in to comment.