@open-xchange/vite-plugin-ox-manifests 0.4.1-pre1 → 0.4.1-pre2

package/README.md

@@ -30,6 +30,7 @@ You can provide the following options to the plugin:
 * transformAbsolutePaths `<boolean>` If set to true, every absolute path will be transformed into a relative path. This is especially useful, if the production path is not clear at build time. E.g. if you do not know, whether appsuite will be served under `/appsuite`. 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
 

package/index.js

@@ -4,7 +4,7 @@ import relativePathsPlugin from './src/plugins/relative-paths.js'
 import settingsPlugin from './src/plugins/settings.js'
 import servePlugin from './src/plugins/serve.js'
 import gettextPlugin from './src/plugins/gettext.js'
-import versionPlugin from './src/plugins/version.js'
+import metaPlugin from './src/plugins/meta.js'
 import { deepMergeObject } from './src/util.js'
 
 /**
@@ -17,7 +17,7 @@ import { deepMergeObject } from './src/util.js'
  * @param {boolean} [options.transformAbsolutePaths=true] - If this is set to true, every path in the html-files is transformed to a relative path. Additionally, every preloaded file will also be loaded relative to the index.html
  * @param {boolean} [options.autoloadSettings=true] - If disabled, settings will not be automatically detected and therefore have to provide a manual manifest.json.
  * @param supportedEntryExtensions {string[]=['js', 'mjs', 'ts']} - An array of valid file-extensions for entry points.
- * @param {object} [options.version] - An object that will be translated into a version.json file in the root directory.
+ * @param {object} [options.meta] - An object that will be translated into a meta.json file in the root directory.
  */
 export default function ({
   watch = false,
@@ -26,7 +26,7 @@ export default function ({
   transformAbsolutePaths = true,
   autoloadSettings = true,
   supportedEntryExtensions = ['js', 'mjs', 'ts'],
-  version
+  meta
 } = {}) {
   const options = {
     watch,
@@ -35,7 +35,7 @@ export default function ({
     transformAbsolutePaths,
     autoloadSettings,
     supportedEntryExtensions,
-    version
+    meta
   }
 
   const plugins = [
@@ -44,7 +44,7 @@ export default function ({
     relativePathsPlugin(options),
     servePlugin(options),
     gettextPlugin(options),
-    versionPlugin(options),
+    metaPlugin(options),
     // manifest plugin last
     manifestsPlugin(options)
   ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/vite-plugin-ox-manifests",
-  "version": "0.4.1-pre1",
+  "version": "0.4.1-pre2",
   "description": "A vite plugin to concat and serve ox manifests",
   "main": "index.js",
   "type": "module",

package/src/plugins/meta.js

@@ -0,0 +1,13 @@
+export default function ({ meta } = {}) {
+  return {
+    generateBundle () {
+      if (!meta || Object.keys(meta).length === 0) return
+
+      this.emitFile({
+        fileName: 'meta.json',
+        type: 'asset',
+        source: JSON.stringify(meta)
+      })
+    }
+  }
+}

package/test/meta/main.test.js

@@ -0,0 +1,25 @@
+import { describe, it, expect } from '@jest/globals'
+import { build } from 'vite'
+import path from 'path'
+import vitePluginOxManifests from '../../index'
+import { getFileFromBundle } from '../util'
+
+const __dirname = path.dirname(new URL(import.meta.url).pathname)
+
+describe('Meta option', function () {
+  it('works', async function () {
+    const bundle = await build({
+      root: __dirname,
+      logLevel: 'silent',
+      build: { write: false, rollupOptions: { input: {} } },
+      plugins: [vitePluginOxManifests({
+        meta: {
+          version: '1.2.3'
+        }
+      })]
+    })
+
+    const metaFile = getFileFromBundle('meta.json', bundle)
+    expect(JSON.parse(metaFile.source)).toEqual({ version: '1.2.3' })
+  })
+})

package/test/meta/manifest.json

@@ -0,0 +1,3 @@
+{
+  "namespace": "test"
+}

package/test/meta/register.js

@@ -0,0 +1 @@
+console.log('Hello world')

package/src/plugins/version.js

@@ -1,13 +0,0 @@
-export default function ({ version } = {}) {
-  return {
-    generateBundle () {
-      if (!version || Object.keys(version).length === 0) return
-
-      this.emitFile({
-        fileName: 'version.json',
-        type: 'asset',
-        source: JSON.stringify(version)
-      })
-    }
-  }
-}