@vulkano/core 1.17.4 → 1.18.1

package/.oxlintrc.json

@@ -0,0 +1,42 @@
+{
+  "env": {
+    "node": true,
+    "browser": true,
+    "es6": true
+  },
+  "globals": {
+    "app": "readonly",
+    "io": "readonly",
+    "ApiClient": "readonly",
+    "Download": "readonly",
+    "Paginate": "readonly",
+    "Mixed": "readonly",
+    "Crontab": "readonly",
+    "Encrypter": "readonly",
+    "Filter": "readonly",
+    "i18n": "readonly",
+    "Jwt": "readonly",
+    "VSError": "readonly",
+    "ABS_PATH": "readonly",
+    "APP_PATH": "readonly",
+    "CORE_PATH": "readonly",
+    "PUBLIC_PATH": "readonly"
+  },
+  "rules": {
+    "curly": "error",
+    "no-console": "off",
+    "no-underscore-dangle": "off",
+    "no-throw-literal": "off",
+    "no-unneeded-ternary": "off",
+    "guard-for-in": "off"
+  },
+  "ignorePatterns": [
+    "node_modules",
+    "test",
+    "bundle",
+    "tasks",
+    "docs",
+    "public",
+    "setup"
+  ]
+}

package/.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+  "oxc.enable": true,
+  "oxc.configPath": ".oxlintrc.json",
+  "editor.defaultFormatter": "biomejs.biome",
+  "editor.formatOnSave": true,
+  "javascript.format.enable": false,
+  "typescript.format.enable": false,
+  "[javascript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  }
+}

package/app.js

@@ -1,4 +1,5 @@
 /* eslint-disable import/no-dynamic-require */
+/* global Vite */
 
 /**
  * Bootstrap.js
@@ -80,11 +81,7 @@ const NODE_ENV = (process.env.NODE_ENV || 'development').toLowerCase();
 
 app.PRODUCTION = NODE_ENV === 'production' ? true : false;
 
-const {
-  views,
-  local,
-  env
-} = config || {};
+const { views, local, env } = config || {};
 
 // NODE_ENV
 const environmentConfig = env ? env[NODE_ENV] || {} : {};
@@ -120,12 +117,7 @@ app.config = allConfig;
 app.pkg = appPkg;
 
 // Include all components
-const {
-  lineWidth,
-  colors,
-  showCenteredText,
-  showColumn
-} = require('./bootstrap/logger');
+const { lineWidth, colors, showCenteredText, showColumn } = require('./bootstrap/logger');
 
 // Include all components
 const loadDatabase = require('./database/mongodb');
@@ -134,7 +126,6 @@ const loadControllers = require('./controllers/controllers');
 const loadServer = require('./bootstrap/server');
 
 async function startVulkano() {
-
   // Load Services
   loadServices();
 
@@ -154,17 +145,17 @@ async function startVulkano() {
   const cutLine = '-'.padEnd(lineWidth, '-');
 
   console.log('');
-  console.log(`${colors.fg.magenta}${cutLine}`, colors.reset);
+  console.log(`${colors.fg.magenta}${cutLine}${colors.reset}`);
   console.log('');
-  console.log(colors.fg.cyan, showCenteredText('🌋'), colors.reset);
-  console.log(colors.fg.cyan, showCenteredText(`${appName} ${appVersion}`), colors.reset);
-  console.log(colors.fg.cyan, showCenteredText(`${pkg.name} ${pkg.version}`.toUpperCase()), colors.reset);
+  console.log(`${colors.fg.cyan}${showCenteredText('🌋')}${colors.reset}`);
+  console.log(`${colors.fg.cyan}${showCenteredText(`${appName} ${appVersion}`)}${colors.reset}`);
+  console.log(`${colors.fg.cyan}${showCenteredText(`${pkg.name} ${pkg.version}`.toUpperCase())}${colors.reset}`);
   console.log('');
-  console.log(colors.fg.blue, '🔗 github.com/vulkanojs/vulkano', colors.reset);
-  console.log(colors.fg.cyan, '☕ buymeacoffee.com/argordmel', colors.reset);
+  console.log(`${colors.fg.blue}🔗 github.com/vulkanojs/vulkano${colors.reset}`);
+  console.log(`${colors.fg.cyan}☕ buymeacoffee.com/argordmel${colors.reset}`);
   console.log('');
   console.log(` Author: ${colors.fg.green}${author}${colors.reset}`);
-  console.log(`${colors.fg.magenta}${cutLine}`, colors.reset);
+  console.log(`${colors.fg.magenta}${cutLine}${colors.reset}`);
 
   // Routes
   app.routes = controllers;
@@ -180,32 +171,21 @@ async function startVulkano() {
     ...app.config.routes
   };
 
-  const {
-    bootstrap
-  } = config;
+  const { bootstrap } = config;
 
   if (!bootstrap || typeof bootstrap !== 'function') {
     console.log('Missing the boostrap file to start app: app/config/bootstrap.js');
     return;
   }
 
-  bootstrap( (callbackAfterInitVulkano) => {
-
+  bootstrap((callbackAfterInitVulkano) => {
     // Start Express
-    app.server.start( () => {
-
-      const {
-        sockets,
-        settings: configSettings
-      } = app.config || {};
+    app.server.start(() => {
+      const { sockets, settings: configSettings, vite } = app.config || {};
 
-      const {
-        database
-      } = configSettings || {};
+      const { database } = configSettings || {};
 
-      const {
-        connection
-      } = database || {};
+      const { connection } = database || {};
 
       const connectionToShow = connection && process.env.MONGO_URI ? 'MONGO_URI' : connection;
 
@@ -213,12 +193,15 @@ async function startVulkano() {
 
       const nodeVersion = process.version.match(/^v(\d+\.\d+\.\d+)/)[1];
       const portText = String(app.vulkano.get('port') || 8000);
-      const socketText = sockets.enabled ? 'YES' : 'NO';
-      const adapterText = sockets.enabled ? String(sockets.adapter || 'memory').toUpperCase() : 'NO';
+      const socketText = sockets.enabled
+        ? String(sockets.adapter || 'memory').toUpperCase()
+        : 'NO';
 
-      serverConfig.push(` PORT: ${colors.fg.green}${showColumn(portText, 7)}${colors.reset}`);
+      serverConfig.push(`🚀 PORT: ${colors.fg.green}${showColumn(portText, 7)}${colors.reset}`);
       serverConfig.push(' | ');
-      serverConfig.push(` ENV: ${app.PRODUCTION ? colors.fg.red : colors.fg.green}${showColumn(NODE_ENV, 0)}${colors.reset}`);
+      serverConfig.push(
+        `🌿 ENV: ${app.PRODUCTION ? colors.fg.red : colors.fg.green}${showColumn(NODE_ENV, 0)}${colors.reset}`
+      );
 
       console.log(serverConfig.join(''));
 
@@ -226,34 +209,48 @@ async function startVulkano() {
       const totalHeapSizeGb = (totalHeapSize / 1024 / 1024 / 1024).toFixed(2);
 
       const nodeConfig = [];
-      nodeConfig.push(` NODE: ${colors.fg.green}${showColumn(nodeVersion, 7)}${colors.reset}`);
+      nodeConfig.push(`📦 NODE: ${colors.fg.green}${showColumn(nodeVersion, 7)}${colors.reset}`);
       nodeConfig.push(' | ');
-      nodeConfig.push(' MAX MEM: ', `${colors.fg.green}${totalHeapSizeGb} GB${colors.reset}`);
+      nodeConfig.push(`🧠 MAX MEM: `, `${colors.fg.green}${totalHeapSizeGb} GB${colors.reset}`);
       console.log(nodeConfig.join(''));
 
       const startUpConfig = [];
-      startUpConfig.push(' SOCKETS: ', `${colors.fg.green}${showColumn(socketText, 10)}${colors.reset}`);
+      startUpConfig.push(
+        `🔌 SOCKETS: `,
+        `${sockets.enabled ? colors.fg.green : colors.fg.blue}${showColumn(socketText, 10)}${colors.reset}`
+      );
       startUpConfig.push(' | ');
-      startUpConfig.push(` STARTUP: ${colors.fg.green}${((Date.now() - global.START_TIME) / 1000).toFixed(3)}s${colors.reset}`);
+      startUpConfig.push(
+        `🍃 DB: `,
+        connection
+          ? `${colors.fg.green}${connectionToShow}${colors.reset}`
+          : `${colors.fg.blue}NO DATABASE${colors.reset}`
+      );
       console.log(startUpConfig.join(''));
 
-      const dbConfig = [];
-      dbConfig.push(' ADAPTER: ', `${colors.fg.green}${showColumn(adapterText, 10)}${colors.reset}`);
-      dbConfig.push(' | ');
-      dbConfig.push(' DB: ', connection ? `${colors.fg.green}${connectionToShow}${colors.reset}` : `${colors.fg.blue}NO DATABASE${colors.reset}`);
-      console.log(dbConfig.join(''));
+      if (vite?.enabled) {
+        console.log(
+          `${colors.fg.yellow}⚡ VITE${colors.reset}`,
+          `${colors.fg.green}${showColumn('ENABLED', 5)}${colors.reset}`,
+          `${colors.dim}${vite.buildPath || 'public/.vite'}${colors.reset}`
+        );
+      }
 
-      console.log(`${colors.fg.magenta}${cutLine}`, colors.reset);
+      const startupMs = ((Date.now() - global.START_TIME) / 1000).toFixed(3);
+      console.log(`${colors.fg.magenta}${cutLine}${colors.reset}`);
+      console.log(`${colors.bright}${colors.fg.cyan}${showCenteredText(`⚡ Ready in ${startupMs}s`)}${colors.reset}`);
+      console.log(`${colors.fg.magenta}${cutLine}${colors.reset}`);
+
+      if (vite?.enabled) {
+        app.vite = Vite.init(vite.buildPath || 'public/.vite');
+      }
 
       // Run custom callback after init vulkano
       if (callbackAfterInitVulkano && typeof callbackAfterInitVulkano === 'function') {
         callbackAfterInitVulkano();
       }
-
     });
-
   });
-
 }
 
 module.exports = startVulkano;

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/biome.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.4.15/schema.json",
+  "files": {
+    "includes": [
+      "**",
+      "!node_modules",
+      "!test",
+      "!bundle",
+      "!tasks",
+      "!docs",
+      "!public",
+      "!setup"
+    ]
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 100
+  },
+  "linter": {
+    "enabled": true
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "trailingCommas": "none",
+      "semicolons": "always"
+    }
+  }
+}

package/bootstrap/logger.js

@@ -1,6 +1,6 @@
 const logger = {
 
-  lineWidth: 39,
+  lineWidth: 41,
 
   colors: {
     reset: '\x1b[0m',
@@ -36,7 +36,7 @@ const logger = {
 
   showCenteredText(text) {
 
-    const colSize = (logger.lineWidth / 2) - 3;
+    const colSize = logger.lineWidth / 2;
     const textLength = (text || '').length;
     const textLeftSize = Math.trunc(textLength / 2);
     const textRightSize = textLength - textLeftSize;

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.1",
   "description": "A MVC framework using Express 4",
   "license": "MIT",
   "author": "Vulkano Team",
@@ -8,11 +8,16 @@
     "node": ">=20"
   },
   "main": "app.js",
+  "bin": {
+    "vulkano": "./bin/vulkano.js"
+  },
   "scripts": {
+    "format": "biome format --write .",
+    "lint": "oxlint . && biome check .",
     "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",
@@ -58,21 +63,9 @@
     "undici": "^6.25.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.26.9",
-    "@babel/eslint-parser": "^7.26.8",
-    "@babel/plugin-syntax-dynamic-import": "^7.8.3",
-    "@babel/plugin-syntax-jsx": "^7.25.9",
-    "@babel/preset-env": "^7.26.9",
-    "@babel/preset-react": "^7.26.3",
-    "@babel/preset-stage-1": "^7.8.3",
-    "eslint": "^8.57.0",
-    "eslint-config-airbnb": "^19.0.4",
-    "eslint-import-resolver-alias": "^1.1.2",
-    "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-jsx-a11y": "^6.10.2",
-    "eslint-plugin-react": "^7.37.4",
-    "eslint-plugin-react-hooks": "^4.6.2",
+    "@biomejs/biome": "^2.4.15",
     "jest": "^29.7.0",
-    "nodemon": "^3.1.14"
+    "nodemon": "^3.1.14",
+    "oxlint": "^1.64.0"
   }
-}
+}

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 '';
+
+};