Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pearofducks/rollup-plugin-dev
development server for rollup with additional logging and options
https://github.com/pearofducks/rollup-plugin-dev
developer-tools koa rollup
Last synced: 27 days ago
JSON representation
development server for rollup with additional logging and options
- Host: GitHub
- URL: https://github.com/pearofducks/rollup-plugin-dev
- Owner: pearofducks
- License: mit
- Created: 2019-08-04T20:01:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-18T07:19:25.000Z (over 2 years ago)
- Last Synced: 2024-04-30T10:32:32.739Z (8 months ago)
- Topics: developer-tools, koa, rollup
- Language: JavaScript
- Homepage:
- Size: 601 KB
- Stars: 59
- Watchers: 4
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - dev - Development server with additional logging and options. (Plugins / All-Purpose Awesome)
README
# rollup-plugin-dev
a development server for rollup
### why this plugin?
compared to other plugins, this plugin:
- uses Fastify to provide the server and implement features
- while this means there are dependencies, it should also be trivial to add/modify to suit individual needs (see `extend` option below!)
- has additional features that may be useful
- detailed logging of requests (see screenshot)
- full proxy support
- support for a basepath in the URL
- will automatically turn itself off when _watch_ mode isn't enabled
## install
```console
npm install --save-dev rollup-plugin-dev
```
```console
pnpm add --save-dev rollup-plugin-dev
```
## use
```js
import dev from 'rollup-plugin-dev'
export default {
plugins: [
dev()
]
}
```
## options
#### dirs
directories to serve static files from
example: `dev('dist')`
example: `dev({ dirs: ['dist', 'lib'] })`
default: `__dirname`
_when no other options are needed, a shortcut is available to specify one folder_
#### basePath
prefix all served files with a base path - e.g. serve from `/static` instead of `/`
example: `dev({ basePath: '/static' })`
default: `/`
#### silent
will silence all log messages, as well as the warning printed when rollup is started outside of watch mode
example: `dev({ silent: true })`
default: `false`
#### proxy
proxy a path to an upstream service
example: `dev({ proxy: [{ from: '/api', to: 'http://localhost:9000/resources' }] })`
example: `dev({ proxy: [{ from: '/api', to: 'http://localhost:9000/resources', opts: { preHandler: myPreHandler } }] })`
default: `undefined`
_`opts` can contain any valid options for [fastify-http-proxy](https://github.com/fastify/fastify-http-proxy)_
#### spa
serve a fallback page (for single-page apps)
example: `dev({ spa: true }) // will serve index.html`
example: `dev({ spa: 'path/to/fallback.html' })`
default: `false`
_if a path is provided, it should be relative to one of the `dirs` being served_
_the fallback file must reside in one of the `dirs` being served_
#### port
the port the server should listen on
example: `dev({ port: 3000 })`
default: `8080`
_the server will automatically listen on the first available port after 8080 if the specified/default port is taken_
#### host
the host the server should listen on
example: `dev({ host: '0.0.0.0' })`
default: `localhost`
#### force
force the server to start, even if rollup isn't in watch mode
example: `dev({ force: true })`
default: `false`
#### dirname
the path to resolve any relative `dirs` from
example: `dev({ dirname: '/Users/MyUser/Development/my-project' })`
default: `undefined`
_this is generally not needed if one is running Rollup from package.json's `scripts`_
#### server
modify options the Fastify server is booted with - accepts any valid [Fastify server attribute](https://www.fastify.io/docs/latest/Reference//Server)
example: `dev({ server: { connectionTimeout: 3000 } })`
default: see `config.js` and the `serverDefaults` export
_here be dragons - because modifying these options can wildly change server behavior, this is supported on an 'as is' basis only_
#### extend
enables full customization of the dev server, expects a [Fastify plugin](https://www.fastify.io/docs/latest/Reference/Plugins/)
example: `dev({ extend: fp(async (server) => server.register(myPlugin)) })`
default: `undefined`
#### onListen
this is a callback that runs after the server has started
example: `dev({ onListen(server) { server.log.info('Hello world') }`
default: `undefined`