@vituum/vite-plugin-pug 1.0.0-alpha.1 → 1.0.0-beta.1

package/README.md

@@ -7,46 +7,29 @@
 import pug from '@vituum/vite-plugin-pug'
 
 export default {
-  plugins: [
-    pug({
-      reload: true,
-      root: null,
-      filters: {},
-      data: '*.json',
-      globals: {
-          template: 'path/to/template.pug'
-      },
-      filetypes: {
-          html: /.(json.html|pug.json.html|pug.html)$/,
-          json: /.(json.pug.html)$/
-      },
-      pug: {}
-    })
-  ]
+    plugins: [
+        pug()
+    ],
+    build: {
+        rollupOptions: {
+            input: ['index.pug.html']
+        }
+    }
 }
 ```
 
-Read the [docs](https://vituum.dev/config/integrations-options.html#vituum-pug) to learn more about the plugin options.
+* Read the [docs](https://vituum.dev/plugins/pug.html) to learn more about the plugin options.
+* Use with [Vituum](https://vituum.dev) to get multi-page support.
 
 ## Basic usage
 
 ```html
-<!-- index.html -->
-<script type="application/json" data-format="pug">
-  {
-    "template": "path/to/template.pug",
-    "title": "Hello world"
-  }
-</script>
-```
-or
-```html
-<!-- index.pug.html -->
+<!-- index.pug -->
 include /path/to/template.pug
 ```
 or
 ```html
-<!-- index.json.html or index.pug.json.html  -->
+<!-- index.json  -->
 {
   "template": "path/to/template.pug",
   "title": "Hello world"
@@ -55,5 +38,5 @@ or
 
 ### Requirements
 
-- [Node.js LTS (16.x)](https://nodejs.org/en/download/)
-- [Vite](https://vitejs.dev/) or [Vituum](https://vituum.dev/)
+- [Node.js LTS (18.x)](https://nodejs.org/en/download/)
+- [Vite](https://vitejs.dev/)

package/index.js

@@ -1,11 +1,17 @@
 import { resolve, relative } from 'path'
 import fs from 'fs'
-import process from 'node:process'
 import lodash from 'lodash'
 import pug from 'pug'
-import { getPackageInfo, merge, pluginBundle, pluginError, pluginReload, processData } from 'vituum/utils/common.js'
+import {
+    getPackageInfo,
+    merge, normalizePath,
+    pluginBundle,
+    pluginMiddleware,
+    pluginReload,
+    pluginTransform,
+    processData
+} from 'vituum/utils/common.js'
 import { renameBuildEnd, renameBuildStart } from 'vituum/utils/build.js'
-import { minimatch } from 'minimatch'
 
 const { name } = getPackageInfo(import.meta.url)
 
@@ -21,16 +27,17 @@ const defaultOptions = {
     },
     data: ['src/data/**/*.json'],
     formats: ['pug', 'json.pug', 'json'],
+    ignoredPaths: [],
     options: {}
 }
 
-const renderTemplate = async ({ filename, server, root }, content, options) => {
+const renderTemplate = async ({ filename, server, resolvedConfig }, content, options) => {
     const initialFilename = filename.replace('.html', '')
     const output = {}
     const context = options.data
         ? processData({
             paths: options.data,
-            root
+            root: resolvedConfig.root
         }, options.globals)
         : options.globals
 
@@ -48,14 +55,15 @@ const renderTemplate = async ({ filename, server, root }, content, options) => {
             })
         }
 
-        context.template = relative(process.cwd(), context.template).startsWith(relative(process.cwd(), options.root)) ? resolve(process.cwd(), context.template) : resolve(options.root, context.template)
+        context.template = normalizePath(context.template)
+        context.template = relative(resolvedConfig.root, context.template).startsWith(relative(resolvedConfig.root, options.root)) ? resolve(resolvedConfig.root, context.template) : resolve(options.root, context.template)
     } else if (fs.existsSync(`${initialFilename}.json`)) {
         lodash.merge(context, JSON.parse(fs.readFileSync(`${initialFilename}.json`).toString()))
     }
 
     return new Promise((resolve) => {
         try {
-            const template = pug.compileFile(output.template ? context.template : filename, Object.assign(options.options, {
+            const template = pug.compileFile(output.template ? context.template : server ? initialFilename : filename, Object.assign(options.options, {
                 basedir: options.root,
                 filters: options.filters
             }))
@@ -91,17 +99,19 @@ const plugin = (options = {}) => {
 
             if (!options.root) {
                 options.root = config.root
+            } else {
+                options.root = normalizePath(options.root)
             }
         },
         buildStart: async () => {
-            if (userEnv.command !== 'build') {
+            if (userEnv.command !== 'build' || !resolvedConfig.build.rollupOptions.input) {
                 return
             }
 
             await renameBuildStart(resolvedConfig.build.rollupOptions.input, options.formats)
         },
         buildEnd: async () => {
-            if (userEnv.command !== 'build') {
+            if (userEnv.command !== 'build' || !resolvedConfig.build.rollupOptions.input) {
                 return
             }
 
@@ -110,38 +120,11 @@ const plugin = (options = {}) => {
         transformIndexHtml: {
             order: 'pre',
             async transform (content, { path, filename, server }) {
-                if (
-                    !options.formats.find(format => filename.replace('.html', '').endsWith(format)) ||
-                    (filename.replace('.html', '').endsWith('.json') && !content.startsWith('{'))
-                ) {
-                    return content
-                }
-
-                if (
-                    (filename.replace('.html', '').endsWith('.json') && content.startsWith('{')) &&
-                    (JSON.parse(content)?.format && !options.formats.includes(JSON.parse(content)?.format))
-                ) {
-                    return content
-                }
-
-                if (options.ignoredPaths.find(ignoredPath => minimatch(path.replace('.html', ''), ignoredPath) === true)) {
-                    return content
-                }
-
-                const render = await renderTemplate({ filename, server, root: resolvedConfig.root }, content, options)
-                const renderError = pluginError(render.error, server, name)
-
-                if (renderError && server) {
-                    return
-                } else if (renderError) {
-                    return renderError
-                }
-
-                return render.content
+                return pluginTransform(content, { path, filename, server }, { name, options, resolvedConfig, renderTemplate })
             }
         },
         handleHotUpdate: ({ file, server }) => pluginReload({ file, server }, options)
-    }, pluginBundle(options.formats)]
+    }, pluginBundle(options.formats), pluginMiddleware(name, options.formats)]
 }
 
 export default plugin

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vituum/vite-plugin-pug",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-beta.1",
   "type": "module",
   "main": "index.js",
   "scripts": {
@@ -11,8 +11,7 @@
     "pug": "^3.0.2",
     "lodash": "^4.17.21",
     "fast-glob": "^3.2.12",
-    "vituum": "^1.0.0-alpha.23",
-    "minimatch": "^9.0.1"
+    "vituum": "^1.0.0-beta.3"
   },
   "devDependencies": {
     "@types/node": "^20.3.1",

package/types/index.d.ts

@@ -32,6 +32,6 @@ export interface PluginUserConfig {
     globals?: Object
     data?: string | string[]
     formats?: string[]
-    options?: PugOptions
     ignoredPaths?: string[]
+    options?: PugOptions
 }