1.0.16 • Published 1 year ago

@zhourengui/esbuild-dev-server v1.0.16

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

esbuild-dev-server

⚡️ Fast, lightweight and powerful development server for esbuild ⚡️

  • Zero dependencies besides esbuild
  • API proxy support
  • Live reload
  • SPA support through History API fallback
  • Fully typed with TypeScript

Installation

npm install @zhourengui/esbuild-dev-server
# or
yarn add @zhourengui/esbuild-dev-server

Usage

import { createDevServer } from '@zhourengui/esbuild-dev-server';

createDevServer(esbuildOptions, {
  servedir: 'dist/web',
  port: 8080,
  proxy: {
    '^/api/v1': {
      target: 'https://www.google.com/',
      changeOrigin: true,
    },
  },
});

See example folder for examples.

API

createDevServer(esbuildOptions, serverOptions)

esbuildOptions

Options passed to esbuild Build API.

serverOptions

OptionDescriptionRequiredDefault
servedirbuild directoryTrueNone
portPort number to listen for requests on.TrueNone
openOpen in the default browser after starting the serviceFalseFalse
proxyproxy http network requestFalseNone

Proxying

{
  "proxy": {
    "^/api/v1": {
      "target": "https://www.google.com.hk/",
      "pathRewrite": {
        "^/api/v1": "replace string"
      },
      "changeOrigin": true
    }
  }
}

Matching prefixes support regular expressions.

Hot Reloading

Add the following code to the entry file:

// Hot Module
if (process.env.NODE_ENV === 'development') {
  import('@zhourengui/esbuild-dev-server/lib/hot-reloading');
}

Todo List

  • Add Tests
1.0.16

1 year ago

1.0.15

1 year ago

1.0.14

1 year ago

1.0.13

1 year ago

1.0.12

1 year ago

1.0.11

1 year ago

1.0.10

1 year ago

1.0.9

1 year ago

1.0.8

1 year ago

1.0.7

1 year ago

1.0.6

1 year ago

1.0.5

1 year ago

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago