0.6.3 • Published 3 months ago
@open-xchange/vite-plugin-ox-externals v0.6.3
Vite Plugin OX Externals
A vite plugin that will mark prefixed modules as external and will transform the path in production into a path relative to the root.
Install
pnpm i "@open-xchange/vite-plugin-ox-externals"
npm i "@open-xchange/vite-plugin-ox-externals"
yarn add "@open-xchange/vite-plugin-ox-externals"How to use
// in the vite.config.js
import vitePluginOxExternals from '@open-xchange/vite-plugin-ox-externals'
return {
plugins: [vitePluginOxExternals()]
}Options
You can provide the following options to the plugin:
| Name | Type | Default | Description |
|---|---|---|---|
prefix | string | '$' | The prefix to use for external modules. Will always be followed by a / if you specify the path. |
packageAliases | Record<string, string> | {} | Replacements for external packages. The property key is the original package name used in source code, and the property value is the name of the actual package to be imported. If the specified package does not exist, the original package will be imported instead. |
Example
// import the core settings module
import { Settings } from '$/io.ox/core/settings'How to test
pnpm test