@vulkano/core 1.17.4 → 1.18.0

package/app.js

@@ -1,4 +1,5 @@
 /* eslint-disable import/no-dynamic-require */
+/* global Vite */
 
 /**
  * Bootstrap.js
@@ -196,7 +197,8 @@ async function startVulkano() {
 
       const {
         sockets,
-        settings: configSettings
+        settings: configSettings,
+        vite
       } = app.config || {};
 
       const {
@@ -245,6 +247,10 @@ async function startVulkano() {
 
       console.log(`${colors.fg.magenta}${cutLine}`, colors.reset);
 
+      if (vite && vite.enabled) {
+        app.vite = Vite.init(vite.buildPath || 'public/.vite');
+      }
+
       // Run custom callback after init vulkano
       if (callbackAfterInitVulkano && typeof callbackAfterInitVulkano === 'function') {
         callbackAfterInitVulkano();

package/bin/vulkano.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+/* eslint-disable global-require */
+/* eslint-disable import/extensions */
+
+const [,, command] = process.argv;
+
+switch (command) {
+  case 'init':
+    require('./setup.js');
+    break;
+  default:
+    console.log([
+      '',
+      '  Usage: vulkano <command>',
+      '',
+      '  Commands:',
+      '    init    Scaffold a new Vulkano project in the current directory',
+      '',
+    ].join('\n'));
+    process.exit(0);
+}

package/bootstrap/views.js

@@ -15,6 +15,12 @@ const appFilters = require('include-all')({
 });
 
 // Include all helpers
+const coreHelpers = require('include-all')({
+  dirname: path.join(CORE_PATH, 'views/helpers'),
+  filter: /(.+)\.js$/,
+  optional: true
+});
+
 const appHelpers = require('include-all')({
   dirname: path.join(APP_PATH, 'config/views/helpers'),
   filter: /(.+)\.js$/,
@@ -32,6 +38,6 @@ module.exports = {
     appFilters || {}
   ],
 
-  helpers: [appHelpers || {}]
+  helpers: [coreHelpers || {}, appHelpers || {}]
 
 };

package/libs/Vite.js

@@ -0,0 +1,71 @@
+const fs = require('fs');
+
+module.exports = {
+
+  init(buildPath) {
+
+    // we must have a manifest file...
+    let manifestPath = null;
+
+    const viteFolder = [
+      ABS_PATH,
+      (buildPath || 'public/.vite')
+    ].join('/');
+
+    const env = String(process.env.NODE_ENV || 'development').toLowerCase();
+
+    const isProd = env === 'production' ? true : false;
+
+    // Get the main manifest file
+    if (fs.existsSync(`${viteFolder}/manifest.json`)) {
+      manifestPath = fs.readFileSync(`${viteFolder}/manifest.json`, 'utf8');
+    }
+
+    // if in dev, try to get the env specific manifest file
+    if (!isProd) {
+      if (fs.existsSync(`${viteFolder}/manifest.${env}.json`)) {
+        manifestPath = fs.readFileSync(`${viteFolder}/manifest.${env}.json`, 'utf8');
+      } else if (manifestPath) {
+        console.log(`No Vite Manifest for env: ${env} exists. Fallback: manifest.json.`);
+      }
+    }
+
+    // Show warning if no manifest found
+    if (!manifestPath) {
+      if (isProd) {
+        console.log(`No Vite Manifest exists. Path: ${viteFolder}/manifest.json. Should hot server be running?`);
+      } else {
+        console.log(`No Vite Manifest exists. Path: ${viteFolder}/manifest.${env}.json. Should hot server be running?`);
+      }
+    }
+
+    const manifest = JSON.parse(manifestPath || '{}');
+
+    const {
+      url
+    } = manifest || {};
+
+    if (!url) {
+
+      return {
+        env,
+        url: '',
+        inputs: manifest || {}
+      };
+
+    }
+
+    return {
+      env,
+      ...manifest
+    };
+
+  },
+
+  buildFolder() {
+
+    return [ABS_PATH, this.buildPath].join('/');
+
+  }
+
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vulkano/core",
-  "version": "1.17.4",
+  "version": "1.18.0",
   "description": "A MVC framework using Express 4",
   "license": "MIT",
   "author": "Vulkano Team",
@@ -8,11 +8,14 @@
     "node": ">=20"
   },
   "main": "app.js",
+  "bin": {
+    "vulkano": "./bin/vulkano.js"
+  },
   "scripts": {
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
-    "postinstall": "node bin/postinstall.js"
+    "init": "node bin/setup.js"
   },
   "preferGlobal": true,
   "homepage": "https://github.com/vulkanojs/vulkano-core",

package/views/helpers/vite.js

@@ -0,0 +1,75 @@
+/**
+ * Custom backend integration for Vite asset injection.
+ * Reads the Vite manifest (dev or production) from `app.vite` to dynamically
+ * inject the correct <script> or <link> tags into Nunjucks templates.
+ * Supports two asset types via the `type` param: "script" and "style(s)".
+ * In development, it emits the Vite HMR client + module entry; in production
+ * it resolves the hashed filenames from the manifest and appends a cache-bust
+ * query string using the app version.
+ *
+ * In your template, you can define the CSS and JS entries like this:
+ *
+ * CSS: {{ vite({ entry: 'app', type: 'style' }) | safe }}
+ * JS: {{ vite({ entry: 'app', type: 'script' }) | safe }}
+ *
+ */
+module.exports = (props) => {
+
+  const {
+    vite
+  } = app.config || {};
+
+  if (!vite || (vite && !vite.enabled) ) {
+    return '<!-- Vite support not enabled. Enable it in your config/vite.js -->';
+  }
+
+  const {
+    entry,
+    type
+  } = props || {};
+
+  const {
+    url,
+    inputs
+  } = app.vite || {};
+
+  const {
+    version
+  } = app.pkg || {};
+
+  const validEntry = Object.keys(inputs).find( (k) => k.indexOf(entry) >= 0 );
+
+  if (!validEntry) {
+    return `<!-- Invalid Entry ${entry} -->`;
+  }
+
+  const currentEntry = inputs[validEntry];
+
+  const {
+    file,
+    css
+  } = currentEntry || {};
+
+  if (type === 'styles' || type === 'style') {
+    return (css || []).map( (s) => `<link rel="stylesheet" href="${url || '/'}${s}?v=${version}">`).join('\n');
+  }
+
+  if (type === 'script') {
+
+    // Development
+    if (typeof currentEntry === 'string') {
+      return [
+        '<!-- development -->',
+        `<script type="module" src="${url}@vite/client"></script>`,
+        `<script type="module" src="${url || '/'}${currentEntry}"></script>`
+      ].join('\n');
+    }
+
+    // Production
+    return `<script type="module" src="${url || '/'}${file}?v=${version}"></script>`;
+
+  }
+
+  return '';
+
+};