@open-xchange/vite-plugin-ox-manifests 0.5.2 → 0.6.0

package/src/plugins/manifests.js

@@ -1,136 +0,0 @@
-import path from 'path'
-import fs from 'fs'
-import fastGlob from 'fast-glob'
-import { applyInputToOptions, basepath, joinUrlPaths } from '../util.js'
-
-async function getManifestEntryFile (basePath, extensions) {
-  if (path.extname(basePath)) {
-    try {
-      await fs.promises.stat(basePath)
-      return path.parse(basePath)
-    } catch (e) {
-      throw new Error(`Cannot find file "${basePath}"`)
-    }
-  }
-
-  for (const ext of extensions) {
-    try {
-      await fs.promises.stat(`${basePath}.${ext}`)
-      return path.parse(`${basePath}.${ext}`)
-    } catch (e) {}
-  }
-
-  throw new Error(`Cannot find file "${basePath}"`)
-}
-
-export default function ({ supportedEntryExtensions, entryPoints, manifestsAsEntryPoints } = {}) {
-  const manifestModules = {}
-  let resolvedConfig
-  let viteManifestPlugin
-
-  return {
-    config (config) {
-      if (config.build) {
-        config.build.manifest = true
-      } else {
-        config.build = { manifest: true }
-      }
-    },
-
-    configResolved (config) {
-      resolvedConfig = config
-
-      if (resolvedConfig.mode !== 'production') return
-
-      // locate the vite:manifest plugin, copy and delete it
-      const index = config.plugins.findIndex(({ name }) => name === 'vite:manifest')
-      ;([viteManifestPlugin] = config.plugins.splice(index, 1))
-
-      viteManifestPlugin.getManifests = (options, bundle) => {
-        // manually invoke plugins functions
-        return new Promise(resolve => {
-          if (viteManifestPlugin.buildStart) viteManifestPlugin.buildStart()
-          viteManifestPlugin.generateBundle.call({
-            emitFile: ({ source }) => {
-              resolve(JSON.parse(source))
-            },
-            getFileName: (id) => 'Not implemented'
-          }, options, bundle)
-        })
-      }
-    },
-
-    async options (options) {
-      const input = {}
-
-      if (entryPoints) {
-        const entryPointFiles = await fastGlob(entryPoints, { absolute: true })
-        entryPointFiles.forEach(entry => {
-          const baseLength = resolvedConfig.root.length + 1
-          const extLength = path.extname(entry).length
-          input[entry.substring(baseLength, entry.length - extLength)] = entry
-        })
-      }
-
-      // 1. load all json files
-      const root = resolvedConfig.root
-      const entries = await fastGlob(`${root.replace(/\\/g, '/')}/**/manifest.json`)
-      // 2. find every file that is referenced by that json file
-      for (const entry of entries) {
-        const rawData = await fs.promises.readFile(entry, 'utf-8')
-        const json = JSON.parse(rawData)
-        const manifests = [].concat(json)
-        const manifestDir = path.dirname(entry).substr(root.length + 1)
-
-        await Promise.all(manifests.map(async ({ path: srcManifestEntryPath = joinUrlPaths(manifestDir, 'register'), ...rest }) => {
-          const { dir, base } = await getManifestEntryFile(joinUrlPaths(root, srcManifestEntryPath), supportedEntryExtensions)
-          const manifestEntryPath = joinUrlPaths(dir, base)
-
-          if (manifestsAsEntryPoints) {
-            input[basepath(joinUrlPaths(path.dirname(srcManifestEntryPath), base))] = manifestEntryPath
-          }
-
-          // 3. put the file content except path into the manifest modules
-          const modules = manifestModules[manifestEntryPath] || []
-          manifestModules[manifestEntryPath] = modules.concat({ ...rest })
-        }))
-      }
-
-      if (resolvedConfig.mode === 'production') {
-        applyInputToOptions(input, options)
-      }
-      return options
-    },
-
-    // specific call to collect all manifests
-    getManifests () {
-      return Object.entries(manifestModules).map(
-        ([path, manifests]) => manifests.map(m => ({ ...m, path: basepath(path.substr(resolvedConfig.root.length + 1)) }))
-      ).flat(1)
-    },
-
-    transform (code, id) {
-      if (resolvedConfig.mode !== 'production') return
-
-      if (manifestModules[id]) {
-        return { meta: { manifests: manifestModules[id] } }
-      }
-    },
-
-    async generateBundle (options, bundle) {
-      const viteManifests = await viteManifestPlugin.getManifests(options, bundle)
-
-      for (const entry in viteManifests) {
-        const chunk = bundle[viteManifests[entry].file]
-        if (!chunk.facadeModuleId) continue
-        viteManifests[entry].meta = this.getModuleInfo(chunk.facadeModuleId).meta
-      }
-
-      this.emitFile({
-        fileName: 'manifest.json',
-        type: 'asset',
-        source: JSON.stringify(viteManifests)
-      })
-    }
-  }
-}

package/src/plugins/meta.js

@@ -1,13 +0,0 @@
-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/src/plugins/relative-paths.js

@@ -1,7 +0,0 @@
-import { PROJECT_NAME as name } from '../constants.js'
-import MagicString from 'magic-string'
-
-export default function ({ transformAbsolutePaths } = {}) {
-  if (transformAbsolutePaths !== undefined) console.warn("transformAbsolutePaths is no longer used. Use `base: './'` with vite 3")
-  return {}
-}

package/src/plugins/serve.js

@@ -1,64 +0,0 @@
-import path, { posix } from 'path'
-import parseurl from 'parseurl'
-import chokidar from 'chokidar'
-
-const sendJSON = (res, data) => {
-  res.statusCode = 200
-  res.setHeader('Content-Type', 'application/json')
-  res.write(JSON.stringify(data))
-  return res.end()
-}
-
-export default function ({ watch } = {}) {
-  let resolvedConfig
-  let manifestRegex
-  let depsRegex
-
-  return {
-    configResolved (config) {
-      resolvedConfig = config
-      manifestRegex = new RegExp(`^${config.base}(api/manifest.json|manifests)$`)
-      depsRegex = new RegExp(`^${config.base}(api/deps.json|dependencies)$`)
-    },
-
-    async configureServer ({ ws, middlewares, moduleGraph }) {
-      const addTimestamp = (manifests) => {
-        manifests.forEach(manifest => {
-          // TODO what about other file types?
-          const id = `${resolvedConfig.root}/${manifest.path}.js`
-          const moduleNode = moduleGraph.idToModuleMap.get(id)
-          if (!moduleNode) return
-          const hmrTS = moduleNode.lastHMRTimestamp
-          if (!hmrTS) return
-          manifest.raw = posix.join(resolvedConfig.base, `/${manifest.path}.js?t=${hmrTS}`)
-        })
-      }
-
-      middlewares.use(async (req, res, next) => {
-        const { path } = parseurl(req)
-        if (req.method !== 'GET') return next()
-
-        if (manifestRegex.test(path)) {
-          const manifests = await this.getManifests()
-          await addTimestamp(manifests)
-          return sendJSON(res, manifests)
-        }
-
-        if (depsRegex.test(path)) {
-          return sendJSON(res, {})
-        }
-
-        next()
-      })
-
-      if (watch) {
-        const watcher = chokidar.watch(path.join(resolvedConfig.root, '**/manifest.json'))
-          .on('ready', async () => {
-            watcher.on('all', async (path) => {
-              ws.send({ type: 'full-reload', path })
-            })
-          })
-      }
-    }
-  }
-}

package/src/plugins/settings.js

@@ -1,147 +0,0 @@
-import fastGlob from 'fast-glob'
-import fs from 'fs'
-import path, { posix } from 'path'
-import { applyInputToOptions, basepath } from '../util.js'
-
-function getRequirements (entry) {
-  const moduleInfo = this.getModuleInfo(entry)
-  const open = [].concat(moduleInfo.importers).concat(moduleInfo.dynamicImporters)
-  const closed = {}
-  const entryPoints = []
-  open.forEach(o => (closed[o] = true))
-
-  while (open.length > 0) {
-    const first = open.shift()
-    if (first.indexOf('node_modules') >= 0) continue
-
-    const moduleInfo = this.getModuleInfo(first)
-    if (moduleInfo.isEntry) {
-      if (moduleInfo.meta?.manifests) {
-        entryPoints.push.apply(entryPoints, moduleInfo.meta.manifests.map(manifest => ({ requires: 'true', ...manifest })))
-        continue
-      }
-    }
-
-    const nextOpen = [].concat(moduleInfo.importers).concat(moduleInfo.dynamicImporters).filter(o => !closed[o])
-    nextOpen.forEach(o => (closed[o] = true))
-    open.push(...nextOpen)
-  }
-
-  return [...new Set(entryPoints.map(e => e.requires).filter(Boolean))]
-}
-
-function mergeRequirements (requirements) {
-  if (requirements.length === 0) return
-  if (requirements.includes('true')) return
-  return requirements.map(c => {
-    // check if is just a simple string
-    if (/^[-\w]*$/.test(c)) return c
-    return `(${c})`
-  }).join('||')
-}
-
-export const getExternalsPrefix = (() => {
-  let cache
-  return function (resolvedConfig) {
-    if (cache === undefined) {
-      const externalPlugin = resolvedConfig.plugins.find(p => p.name === '@open-xchange/vite-plugin-ox-externals')
-      cache = externalPlugin?.meta?.prefix || ''
-    }
-    return cache
-  }
-})()
-
-const containsExportRegex = /export const settings = new Settings\(/
-export async function isSettingsFile (entry, resolvedConfig) {
-  const externalPrefix = getExternalsPrefix(resolvedConfig)
-  const containsSettingsRegex = new RegExp(`import.+[,\\s]Settings.+from ['"][@${externalPrefix}]\\/io.ox\\/core\\/settings(\\.js)?['"]`)
-
-  const content = await fs.promises.readFile(entry, { encoding: 'utf-8' })
-  // special case
-  if (entry === `${resolvedConfig.root}/io.ox/core/settings.js`) return true
-  return containsSettingsRegex.test(content) && containsExportRegex.test(content)
-}
-
-export default function ({ autoloadSettings } = {}) {
-  const settingsModules = {}
-  let resolvedConfig, moduleGraph
-
-  return {
-    configResolved (config) {
-      resolvedConfig = config
-    },
-
-    async options (options) {
-      if (!autoloadSettings) return
-
-      const input = {}
-      const root = resolvedConfig.root
-      const entries = await fastGlob(`${root.replace(/\\/g, '/')}/**/*.{js,ts,mjs}`, { absolute: true })
-      await Promise.all(entries.map(async (entry) => {
-        if (!await isSettingsFile(entry, resolvedConfig)) return
-
-        settingsModules[entry] = { namespace: 'settings', generator: 'settings' }
-
-        const baseLength = root.length + 1
-        const extLength = path.extname(entry).length
-        const entryPath = entry.substring(baseLength, entry.length - extLength)
-        input[entryPath] = entry
-      }))
-
-      if (resolvedConfig.mode === 'production') {
-        applyInputToOptions(input, options)
-      }
-
-      return options
-    },
-
-    configureServer ({ moduleGraph: mg }) {
-      moduleGraph = mg
-    },
-
-    // specific call to collect all manifests
-    getManifests () {
-      return Object.entries(settingsModules).map(
-        ([path, m]) => {
-          const newPath = basepath(path.substr(resolvedConfig.root.length + 1))
-          const manifest = { ...m, path: newPath }
-          const moduleNode = moduleGraph?.idToModuleMap.get(path)
-          if (moduleNode?.lastHMRTimestamp) {
-            manifest.raw = posix.join(resolvedConfig.base, `/${manifest.path}.js?t=${moduleNode.lastHMRTimestamp}`)
-          }
-          return manifest
-        }
-      )
-    },
-
-    transform (code, id) {
-      if (resolvedConfig.mode !== 'production') return
-
-      if (settingsModules[id]) {
-        return { meta: { manifests: [settingsModules[id]] } }
-      }
-    },
-
-    async generateBundle (options, bundle) {
-      if (!autoloadSettings) return
-
-      for (const file in bundle) {
-        const chunk = bundle[file]
-        if (!chunk.facadeModuleId) continue
-        const meta = this.getModuleInfo(chunk.facadeModuleId)?.meta
-        if (!meta?.manifests) continue
-
-        meta.manifests.forEach(manifest => {
-          if (manifest.generator !== 'settings') return
-          delete manifest.generator
-
-          const requirements = getRequirements.call(this, chunk.facadeModuleId, resolvedConfig)
-          if (!requirements.length) return
-
-          const requires = mergeRequirements(requirements)
-          if (requires) manifest.requires = requires
-        })
-      }
-    }
-  }
-}

package/src/util.js

@@ -1,61 +0,0 @@
-import path from 'path'
-
-export function applyInputToOptions (input, options) {
-  // apply changes to input
-  if (Object.keys(input).length > 0) {
-    if (options.input) {
-      if (typeof options.input === 'string') {
-        input.index = options.input
-        options.input = input
-      } else if (options.input instanceof Array) {
-        options.input = [...options.input, ...Object.values(input)]
-      } else {
-        Object.assign(input, options.input)
-        options.input = input
-      }
-    }
-  }
-}
-
-export function joinUrlPaths (...paths) {
-  return path.join.apply(path, paths).replace(/\\+/g, '/')
-}
-
-export function basepath (src) {
-  const { dir, name } = path.parse(src)
-  return joinUrlPaths(dir, name)
-}
-
-export function deepMergeObject (a, b) {
-  const keys = [...new Set(Object.keys(a).concat(Object.keys(b)))]
-  const result = {}
-
-  for (const key of keys) {
-    if (a[key] === undefined) result[key] = b[key]
-    else if (b[key] === undefined) result[key] = a[key]
-    else if ((a[key] instanceof Array) !== (b[key] instanceof Array)) throw new Error('Cannot merge different types')
-    else if (typeof a[key] !== typeof b[key]) throw new Error('Cannot merge different types')
-    else if (a[key] instanceof Array) result[key] = [...a[key], ...b[key]]
-    else if (typeof a[key] === 'object') result[key] = deepMergeObject(a[key], b[key])
-    else result[key] = b[key]
-  }
-
-  return result
-}
-
-export function waitForReload (server) {
-  return new Promise(resolve => {
-    const prev = server.ws.send
-    server.ws.send = function ({ type } = {}) {
-      try {
-        return prev.apply(this, arguments)
-      } finally {
-        if (type === 'full-reload') resolve()
-      }
-    }
-  })
-}
-
-export function wait (millis) {
-  return new Promise(resolve => setTimeout(resolve, millis))
-}

package/test/.eslintrc.cjs

@@ -1,5 +0,0 @@
-module.exports = {
-  plugins: [
-    'jest'
-  ]
-}

package/test/deps/main.test.js

@@ -1,32 +0,0 @@
-import { describe, it, expect, afterEach } from '@jest/globals'
-import { createServer } from 'vite'
-import path from 'path'
-import vitePluginOxManifests from '../../index'
-import { getPort } from '../util'
-
-const PORT = getPort()
-const __dirname = path.dirname(new URL(import.meta.url).pathname)
-
-describe('deps', function () {
-  let server
-
-  afterEach(async function () {
-    if (server) {
-      await server.close()
-      server = null
-    }
-  })
-
-  it('deliver empty deps in dev mode', async function () {
-    server = await createServer({
-      root: __dirname,
-      logLevel: 'silent',
-      plugins: [vitePluginOxManifests({})]
-    })
-    await server.listen(PORT)
-
-    const res = await fetch(`http://localhost:${PORT}/api/deps.json`)
-    const deps = await res.json()
-    expect(deps).toEqual({})
-  })
-})

package/test/gettext-chunked/another_chunk.js

@@ -1,4 +0,0 @@
-import gt from 'gettext'
-
-export const five = 5
-export default gt('five')

package/test/gettext-chunked/i18n/de_DE.po

@@ -1,16 +0,0 @@
-msgid ""
-msgstr ""
-"Project-Id-Version: \n"
-"PO-Revision-Date: 2014-01-15 14:13+0100\n"
-"Last-Translator: Julian Bäume <julian.baeume@open-xchange.com>\n"
-"Language-Team: German <julian.baeume@open-xchange.com>\n"
-"Language: de_DE\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"Plural-Forms: nplurals=2; plural=(n != 1);\n"
-"X-Generator: Lokalize 1.5\n"
-
-#: module:i18n
-msgid "Hello world!"
-msgstr "Hallo Welt!"

package/test/gettext-chunked/i18n/en_US.po

@@ -1,16 +0,0 @@
-msgid ""
-msgstr ""
-"Project-Id-Version: \n"
-"PO-Revision-Date: 2014-01-15 14:13+0100\n"
-"Last-Translator: Julian Bäume <julian.baeume@open-xchange.com>\n"
-"Language-Team: German <julian.baeume@open-xchange.com>\n"
-"Language: en_US\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"Plural-Forms: nplurals=2; plural=(n != 1);\n"
-"X-Generator: Lokalize 1.5\n"
-
-#: module:i18n
-msgid "Hello world!"
-msgstr ""

package/test/gettext-chunked/main.test.js

@@ -1,67 +0,0 @@
-import { describe, it, expect, afterEach } from '@jest/globals'
-import { build, createServer } from 'vite'
-import path from 'path'
-import vitePluginOxManifests from '../../index'
-import rollupPluginPo2Json from '@open-xchange/rollup-plugin-po2json'
-import { getFileFromBundle, getPort } from '../util'
-
-const PORT = getPort()
-const __dirname = path.dirname(new URL(import.meta.url).pathname)
-
-describe('Dictionary in modules with dynamic imports', function () {
-  let server
-
-  afterEach(async function () {
-    if (server) {
-      await server.close()
-      server = null
-    }
-  })
-
-  it('works', async function () {
-    const bundle = await build({
-      root: __dirname,
-      logLevel: 'silent',
-      build: {
-        write: false,
-        rollupOptions: {
-          input: { }
-        }
-      },
-      plugins: [rollupPluginPo2Json({
-        poFiles: __dirname + '/i18n/*.po'
-      }), vitePluginOxManifests({
-
-      })]
-    })
-
-    const manifestFile = getFileFromBundle('manifest', bundle)
-    const manifests = JSON.parse(manifestFile.source)
-    expect(Object.keys(manifests)).toHaveLength(7)
-    expect(manifests['register.js'].meta.manifests[0].namespace).toEqual('test')
-    expect(manifests['../../i18n.js'].meta.gettext.dictionary).toEqual(true)
-    expect(manifests['../../i18n.js'].meta.manifests[0].namespace).toEqual('i18n')
-  })
-
-  it('works in dev mode', async function () {
-    server = await createServer({
-      root: __dirname,
-      logLevel: 'silent',
-      plugins: [rollupPluginPo2Json({
-        poFiles: __dirname + '/i18n/*.po'
-      }), vitePluginOxManifests({
-
-      })]
-    })
-    await server.listen(PORT)
-
-    const res = await fetch(`http://localhost:${PORT}/api/manifest.json`)
-    const manifests = await res.json()
-
-    expect(manifests).toHaveLength(2)
-    expect(manifests[0].namespace).toEqual('i18n')
-    expect(manifests[0].path).toEqual('i18n')
-    expect(manifests[1].namespace).toEqual('test')
-    expect(manifests[1].path).toContain('register')
-  })
-})

package/test/gettext-chunked/manifest.json

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

package/test/gettext-chunked/register.js

@@ -1,6 +0,0 @@
-import gt from 'gettext'
-
-export async function doSomethingDynamic () {
-  const { five } = await import('./another_chunk.js')
-  console.log(gt('Hello world!'), five)
-}

package/test/gettext-multiple/i18n/de_DE.po

@@ -1,22 +0,0 @@
-msgid ""
-msgstr ""
-"Project-Id-Version: \n"
-"PO-Revision-Date: 2014-01-15 14:13+0100\n"
-"Last-Translator: Julian Bäume <julian.baeume@open-xchange.com>\n"
-"Language-Team: German <julian.baeume@open-xchange.com>\n"
-"Language: de_DE\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"Plural-Forms: nplurals=2; plural=(n != 1);\n"
-"X-Generator: Lokalize 1.5\n"
-
-#. empty is meant as a state (folder is empty)
-#: module:i18n
-msgctxt "describe state"
-msgid "Empty folder"
-msgstr "Leerer Ordner"
-
-#: module:foobar
-msgid "String with \" in it"
-msgstr "Zeichenkette mit \""

package/test/gettext-multiple/i18n/en_US.po

@@ -1,22 +0,0 @@
-msgid ""
-msgstr ""
-"Project-Id-Version: \n"
-"PO-Revision-Date: 2014-01-15 14:13+0100\n"
-"Last-Translator: Julian Bäume <julian.baeume@open-xchange.com>\n"
-"Language-Team: German <julian.baeume@open-xchange.com>\n"
-"Language: en_US\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"Plural-Forms: nplurals=2; plural=(n != 1);\n"
-"X-Generator: Lokalize 1.5\n"
-
-#. empty is meant as a state (folder is empty)
-#: module:i18n
-msgctxt "describe state"
-msgid "Empty folder"
-msgstr ""
-
-#: module:foobar
-msgid "String with \" in it"
-msgstr ""