Skip to content

Latest commit

 

History

History
18 lines (11 loc) · 1.07 KB

README.md

File metadata and controls

18 lines (11 loc) · 1.07 KB
Raw

FiftyOne JS Plugin Build Utils

This repository contains utilities for building a FiftyOne JS plugin.

Getting Started

You can find a hello world JS plugin in the @voxel51/hello-world-plugin-js repo.

Design

The build utilities are designed to be as simple as possible. The main goal is to provide a single function that can be called to get a Vite config object that can be used to build a JS plugin. The function takes in the path to the plugin's directory and an optional object that can be used to override the default Vite config.

This repo uses ESM but it's transpiled to both ESM and CommonJS so it can be used in both ESM and CommonJS projects.

Bundling and Externalization

  • All pacakges declared in the dependecies of your plugin's package.json are externalized.
  • All packages declared in the devDependencies of your plugin's package.json are ignored and not bundled.
  • If you want to force bundle any dependencies, you can do so by adding them to the opts.forceBundleDependencies array of defineConfig().