Installations

npm install esbuild-runner

Score

52.4

Supply Chain

89.5

Quality

75.7

Maintenance

100

Vulnerability

99.3

License

Pull Requests

Open

14

Total

53

Closed

23

Merged

16

Issues

Open

29

Total

40

Closed

11

Releases

10

Release 2.2.0

2.2.0

Published on 04 Jun 2021

Release 2.1.0

2.1.0

Published on 01 Jun 2021

Release 2.0.0

2.0.0

Published on 29 May 2021

Release 1.4.0

1.4.0

Published on 26 May 2021

Release 1.3.2

1.3.2

Published on 14 Dec 2020

Release 1.3.1

1.3.1

Published on 09 Dec 2020

View all 10 releases

Developer

folke

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

18.9.1

NPM Version

8.19.1 Statistics

715 Stars

63 Commits

24 Forks

3 Watching

11 Branches

5 Contributors

Updated on 28 Nov 2024

Languages

TypeScript (67.25%)

JavaScript (32.21%)

Shell (0.53%)

Total Downloads

Cumulative downloads

Total Downloads

10,309,670

Last day

-19.7%

19,119

Compared to previous day

Last week

-8.1%

110,695

Compared to previous week

Last month

7.9%

476,139

Compared to previous month

Last year

29.2%

4,599,505

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

2

source-map-support tslib

Peer Dependencies

1

esbuild

Dev Dependencies

28

Versions

:zap: Esbuild Runner (`esr`)

Super-fast on-the-fly transpilation of modern JS, TypeScript and JSX using esbuild.

esr makes it easy to run arbitrary code or tests without needing to build your whole project. It's a great way to improve your development workflow.

✨ Usage

The easiest way to use esbuild-runner is to install it globally and use the included esr binary.

1$ esr hello-world.ts

Alternatively, you can require esbuild-runner within any nodejs process to include realtime transpilation:

1$ node -r esbuild-runner/register hello-world.ts

In order to use esbuild-runner with Jest, you need to configure a Jest transform in your jest.config.js

1module.exports = {
2  transform: {
3    "\\.ts$": "esbuild-runner/jest",
4  },
5}

VSCode Debugging

1{
2  "version": "0.2.0",
3  "configurations": [
4    {
5      "name": "Debug with esbuild-runner",
6      "program": "${workspaceFolder}/hello-world.ts",
7      "runtimeArgs": [
8        "-r",
9        "esbuild-runner/register"
10      ],
11      "request": "launch",
12      "sourceMaps": true,
13      "skipFiles": [
14        "<node_internals>/**"
15      ],
16      "type": "pwa-node"
17    }
18  ]
19}

⚙️ Configuration

esr provides two different ways to transpile your code:

bundling (default): this transpiles the script and all its dependencies in typically one invocation of esbuild. Dependencies defined in package.json or node_modules will never be transpiled. Running esr will always transpile the code. No caching is used.
transform (--cache): this method will invoke esbuild for every source file, but will cache the result. This means that the initial run will be slower, but after that, only changed source files will be transpiled.

1$ bin/esr.js --help
2Usage: esr [options] <source-file> [file-options]
3
4  --cache       Transform on a file per file basis and cache code
5  --clearCache  Clear transform cache
6  --help|-h     Display this help message
7

To customize the options passed to esbuild, you can create an esbuild-runner.config.js file in the current directory or one of the ancestor directories.

1// example esbuild-runner.config.js
2module.exports = {
3  type: "bundle", // bundle or transform (see description above)
4  esbuild: {
5    // Any esbuild build or transform options go here
6    target: "esnext",
7  },
8}

📦 Installation

Simply install the esbuild-runner npm package using your favorite package manager.

globally ...

1$ npm install -g esbuild-runner

... or locally in your project

1$ npm add --dev esbuild-runner

👋 Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

⚖ License

Apache 2.0

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.6

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

esbuild-runner

Installations

Score

Pull Requests

14

53

23

16

Issues

29

40

11

Releases

Developer

Developer Guide

CommonJS

Yes

18.9.1

8.19.1

Statistics

Languages

Total Downloads

10,309,670

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

:zap: Esbuild Runner (esr)

✨ Usage

⚙️ Configuration

📦 Installation

👋 Contributing

⚖ License

10

10

10

1

0

0

0

0

0

0

0

0

0

2.6

/10

:zap: Esbuild Runner (`esr`)