0.7.2 • Published 11 months ago

@open-xchange/vite-plugin-ox-manifests v0.7.2

Weekly downloads
-
License
MIT
Repository
gitlab
Last release
11 months ago

Vite Plugin OX Manifests

A vite plugin that generates a manifest.json for code loading inside an App Suite UI plugin environment.

Install

pnpm i "@open-xchange/vite-plugin-ox-manifests"

How to use

// in the vite.config.js
import vitePluginOxManifests from '@open-xchange/vite-plugin-ox-manifests'

return {
  plugins: [vitePluginOxManifests()]
}

Options

You can provide the following options to the plugin:

  • watch <boolean> If set to true, it will watch any changes to manifest.json files and will automatically reload the vite-dev-server. Default: true
  • entryPoints <string> | <glob pattern> Convenience method to specify additional entry points for the production build. The glob pattern will be resolved and injected into the build.input options of vite. Can be specified as a glob-pattern. Default: undefined
  • manifestsAsEntryPoints <boolean> If set to true, this will inject every entrypoint that is defined by a manifest.json file into the build.input options of vite. Default: true
  • autoloadSettings <boolean> If set to true, this plugin tries to auto-detect files that export settings. Prerequisites are, that the file imports Settings from the io.ox/core/settings module and have a named export called settings. Default true
  • supportedEntryExtensions <string[]> This array defines the extensions, that are to expect as entry points. For example, if a manifest.json have "path": "index", it will look for index.js, index.mjs or index.ts next to the manifest.json. Default: ['js', 'mjs', 'ts']
  • meta <object> An object that will be translated into a meta.json file in the root directory.

Examples

Autoload settings

If autoload settings is enabled, the settings modules have to look like the following:

// import from the core settings module
import { Settings } from '$/io.ox/core/settings'

// named export 'settings'
export const settings = new Settings('test', () => {})

How to test

pnpm test

Migration guide

From 0.x to 1.x

The field transformAbsolutePaths has been removed as you can use base: './' within your vite configuration.

0.7.2

11 months ago

0.7.1

12 months ago

0.7.0

1 year ago

0.6.4

1 year ago

0.6.3

2 years ago

0.6.2

2 years ago

0.6.1

2 years ago

0.6.0

2 years ago

0.5.4

2 years ago

0.5.3

2 years ago

0.5.2

3 years ago

0.5.1

3 years ago

0.5.0-pre1

3 years ago

0.5.0

3 years ago

0.4.6

3 years ago

0.4.4-pre2

3 years ago

0.4.4-pre3

3 years ago

0.4.4-pre1

3 years ago

0.4.5

3 years ago

0.4.4

3 years ago

0.4.3

3 years ago

0.4.1-pre1

3 years ago

0.4.1-pre2

3 years ago

0.4.2-pre1

3 years ago

0.4.1

3 years ago

0.4.2

3 years ago

0.4.0

4 years ago

0.3.0

4 years ago

0.3.1

4 years ago

0.2.3

4 years ago

0.2.2

4 years ago

0.2.1

4 years ago

0.2.0

4 years ago

0.2.0-pre9

4 years ago

0.2.0-pre8

4 years ago

0.2.0-pre6

4 years ago

0.2.0-pre7

4 years ago

0.2.0-pre4

4 years ago

0.2.0-pre5

4 years ago

0.2.0-pre3

4 years ago

0.2.0-pre2

4 years ago

0.2.0-pre1

4 years ago

0.1.18

4 years ago

0.1.17

4 years ago

0.1.16

4 years ago

0.1.15

4 years ago

0.1.14

4 years ago

0.1.13

4 years ago

0.1.10

4 years ago

0.1.11

4 years ago

0.1.12

4 years ago

0.1.8

4 years ago

0.1.7

4 years ago

0.1.9

4 years ago

0.1.6

4 years ago

0.1.5

4 years ago

0.1.4

4 years ago

0.1.3

4 years ago

0.1.2

4 years ago

0.1.1

4 years ago

0.1.0

4 years ago