https://github.com/thgh/rollup-plugin-serve

Serve your rolled up bundle like webpack-dev-server
https://github.com/thgh/rollup-plugin-serve

Last synced: 4 days ago
JSON representation

Serve your rolled up bundle like webpack-dev-server

• Host: GitHub
• URL: https://github.com/thgh/rollup-plugin-serve
• Owner: thgh
• License: mit
• Created: 2016-09-24T17:28:28.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-12-14T19:47:03.000Z (12 months ago)
• Last Synced: 2024-11-30T10:02:41.650Z (12 days ago)
• Language: JavaScript
• Size: 291 KB
• Stars: 248
• Watchers: 5
• Forks: 54
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome - serve - Development Server in a Plugin. (Plugins / All-Purpose Awesome)

README

        
# Rollup plugin to serve the bundle



  





  





  





  





  



## Installation

```

npm install --save-dev rollup-plugin-serve

yarn add rollup-plugin-serve

```

## Usage

```js

// rollup.config.js

import serve from 'rollup-plugin-serve'

export default {

  input: 'src/main.js',

  output: {

    file: 'dist/bundle.js',

    format: ...

  },

  plugins: [

    serve('dist')

  ]

}

```

### Options

By default it serves the current project folder. Change it by passing a string:

```js

serve('public')    // will be used as contentBase

// Default options

serve({

  // Launch in browser (default: false)

  open: true,

  // Page to navigate to when opening the browser.

  // Will not do anything if open=false.

  // Remember to start with a slash.

  openPage: '/different/page',

  // Show server address in console (default: true)

  verbose: false,

  // Folder to serve files from

  contentBase: '',

  // Multiple folders to serve from

  contentBase: ['dist', 'static'],

  // Set to true to return index.html (200) instead of error page (404)

  historyApiFallback: false,

  // Path to fallback page

  historyApiFallback: '/200.html',

  // Options used in setting up server

  host: 'localhost',

  port: 10001,

  // By default server will be served over HTTP (https: false). It can optionally be served over HTTPS

  https: {

    key: fs.readFileSync('/path/to/server.key'),

    cert: fs.readFileSync('/path/to/server.crt'),

    ca: fs.readFileSync('/path/to/ca.pem')

  },

  //set headers

  headers: {

    'Access-Control-Allow-Origin': '*',

    foo: 'bar'

  },

  // set custom mime types, usage https://github.com/broofa/mime#mimedefinetypemap-force--false

  mimeTypes: {

    'application/javascript': ['js_commonjs-proxy']

  }

  // execute function after server has begun listening

  onListening: function (server) {

    const address = server.address()

    const host = address.address === '::' ? 'localhost' : address.address

    // by using a bound function, we can access options as `this`

    const protocol = this.https ? 'https' : 'http'

    console.log(`Server listening at ${protocol}://${host}:${address.port}/`)

  }

})

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Contributing

Contributions and feedback are very welcome.

This project aims to stay lean and close to standards. New features should encourage to stick to standards. Options that match the behaviour of [webpack-dev-server](https://webpack.js.org/configuration/dev-server/#devserver) are always ok.

To get it running:

1. Clone the project.

2. `npm install`

3. `npm run build`

## Credits

- [Thomas Ghysels](https://github.com/thgh)

- [All Contributors][link-contributors]

## License

The MIT License (MIT). Please see [License File](LICENSE) for more information.

[link-author]: https://github.com/thgh

[link-contributors]: ../../contributors

[rollup-plugin-serve]: https://www.npmjs.com/package/rollup-plugin-serve