Skip to content

Extension Development Overview#

This is a general overview to how the development of an extension will proceed. For building extensions there will be a few things that you should have installed, and some other things that might be of help.

Required:#

  • Node.js
  • Git
  • Some sort of text editor – we recommend VSCode
  • We use Webpack for compilation. All extension need to be at least compatible with a webpack system.

All Lens extensions are javascript packages. We recommend that you program in Typescript because it catches many common errors.

Lens is a standard Electron application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work.

Lens uses React as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is responsible for the lifetime of any resources it spins up. If an extension's main part starts new processes they all must be stopped and cleaned up when the extension is deactivated or unloaded.

See Your First Extension to get started.