Skip to content

server-plugins.md

Latest commit

 

History

History
64 lines (44 loc) · 2.89 KB

server-plugins.md

File metadata and controls

64 lines (44 loc) · 2.89 KB

Server Plugins

This is a guide for creating Cosmos server plugins.

Boilerplate

The server field in cosmos.plugin.json points to a module like this:

export default {
  name: 'magic-plugin',

  async config({ cosmosConfig }) {
    // An opportunity to alter the user's Cosmos config
    return cosmosConfig;
  },

  async devServer({ cosmosConfig, platform, httpServer, expressApp }) {
    // Dev server plugin
  },

  async export({ cosmosConfig }) {
    // Static export plugin
  },
};

Plugin API

config

Argument Description
cosmosConfig The user's Cosmos config.
command "dev" or "export".
platform "web" or "native".

The config hook is called before both devServer and export hooks. It allows overriding the user's Cosmos config. Setting the rendererUrl config option is a common use case.

devServer

Argument Description
cosmosConfig The user's Cosmos config.
platform "web" or "native".
httpServer The http.Server instance used by Cosmos.
expressApp The Express App instance used by Cosmos.
sendMessage Send a message to the Cosmos UI.

A hook for starting the renderer dev server alongside the Cosmos server.

For example in the Webpack plugin the Webpack compiler is attached to Cosmos' internal Express app, having the renderer run on the same port as the Cosmos server. In contract, the Vite plugin starts the Vite dev server independently and in this case you end up using two ports—one for the Cosmos server and one for the Vite renderer.

export

Argument Description
cosmosConfig The user's Cosmos config.

A hook for exporting the user's fixtures and decorators into a static Cosmos renderer that the static Cosmos UI connects to.

Join us on Discord for feedback, questions and ideas.