@moostjs/vite 0.5.20 → 0.5.21

package/dist/index.cjs

@@ -83,7 +83,7 @@ function patchMoostHandlerLogging() {
     };
 }
 
-const PLUGIN_NAME = 'moost-vite-dev';
+const PLUGIN_NAME = 'moost-vite';
 function gatherAllImporters(moduleNode, visited = new Set()) {
     if (!moduleNode) {
         return visited;
@@ -103,13 +103,17 @@ const logger = new moost.EventLogger('', { level: 99 }).createTopic('' + '[
 function getLogger() {
     return logger;
 }
-function getExternals() {
+function getExternals({ node, workspace }) {
     const pkg = JSON.parse(node_fs.readFileSync('package.json', 'utf8').toString());
-    return [
-        ...node_module.builtinModules,
-        ...node_module.builtinModules.map(m => `node:${m}`),
-        ...Object.keys(pkg.dependencies || {}),
-    ];
+    const externals = workspace
+        ? Object.keys(pkg.dependencies || {})
+        : Object.entries(pkg.dependencies || {})
+            .filter(([key, ver]) => !ver.startsWith('workspace:'))
+            .map(i => i[0]);
+    if (node) {
+        externals.push(...node_module.builtinModules, ...node_module.builtinModules.map(m => `node:${m}`));
+    }
+    return externals;
 }
 
 function moostRestartCleanup(adapters, onEject, cleanupInstances) {
@@ -200,8 +204,12 @@ function constructorName(i) {
 const REG_HAS_EXPORT_CLASS = /(^\s*@(Injectable|Controller)\()/m;
 const REG_REPLACE_EXPORT_CLASS = /(^\s*@(Injectable|Controller)\()/gm;
 function moostVite(options) {
+    const isTest = process.env.NODE_ENV === 'test';
+    const isProd = process.env.NODE_ENV === 'production';
     let moostMiddleware = null;
-    const adapters = [
+    const adapters = isTest
+        ? []
+        : [
             createAdapterDetector('http', MoostHttp => {
                 MoostHttp.prototype.listen = function (...args) {
                     moostMiddleware = this.getServerCb();
@@ -214,12 +222,11 @@ function moostVite(options) {
             createAdapterDetector('cli'),
             createAdapterDetector('wf'),
         ];
-    const logger = getLogger();
+    const logger = isTest ? console : getLogger();
     let reloadRequired = false;
     patchMoostHandlerLogging();
-    return {
+    const pluginConfig = {
         name: PLUGIN_NAME,
-        apply: 'serve',
         enforce: 'pre',
         config(cfg) {
             const entry = cfg.build?.rollupOptions?.input || options.entry;
@@ -239,7 +246,15 @@ function moostVite(options) {
                     ssr: cfg.build?.ssr ?? true,
                     minify: cfg.build?.minify || false,
                     rollupOptions: {
-                        external: cfg.build?.rollupOptions?.external || getExternals(),
+                        external: isTest
+                            ? cfg.build?.rollupOptions?.external
+                            : cfg.build?.rollupOptions?.external ||
+                                (options.externals === false
+                                    ? []
+                                    : getExternals({
+                                        node: Boolean(options.externals === true || options.externals?.node),
+                                        workspace: Boolean(options.externals === true || options.externals?.workspace),
+                                    })),
                         input: entry,
                         output: {
                             format: options.format,
@@ -324,6 +339,14 @@ function moostVite(options) {
             }
         },
     };
+    if (isProd || isTest) {
+        delete pluginConfig.configureServer;
+        delete pluginConfig.resolveId;
+        delete pluginConfig.load;
+        delete pluginConfig.transform;
+        delete pluginConfig.hotUpdate;
+    }
+    return pluginConfig;
 }
 
 exports.moostVite = moostVite;

package/dist/index.d.ts

@@ -1,20 +1,89 @@
 import { Plugin } from 'vite';
 
 interface TMoostViteDevOptions {
+    /**
+     * The entry file for the application.
+     * This file serves as the main entry point for the build process and SSR server.
+     *
+     * Example: './src/main.ts'
+     */
     entry: string;
+    /**
+     * The port number for the Vite dev server.
+     *
+     * Default: `3000`.
+     */
     port?: number;
+    /**
+     * The hostname or IP address for the Vite dev server.
+     * If not specified, defaults to `'localhost'`.
+     *
+     * Example: '0.0.0.0'
+     */
     host?: string;
+    /**
+     * The output directory for the build artifacts.
+     *
+     * Default to: `'dist'`.
+     */
     outDir?: string;
+    /**
+     * The output format for the build artifacts.
+     * - `'cjs'`: CommonJS, suitable for Node.js environments.
+     * - `'esm'`: ES Module, suitable for modern environments.
+     *
+     * Default: `'esm'`.
+     */
     format?: 'cjs' | 'esm';
+    /**
+     * Whether to generate source maps for the build output.
+     * Source maps are useful for debugging purposes by mapping minified code back to the original source.
+     *
+     * Default: `true`.
+     */
     sourcemap?: boolean;
+    /**
+     * Configuration for defining external dependencies during the build process.
+     *
+     * This helps in excluding certain modules from the bundled output, reducing the bundle size and
+     * allowing them to be resolved at runtime instead.
+     *
+     * Default: `true`.
+     */
+    externals?: {
+        /**
+         * Whether to exclude Node.js built-in modules (e.g., `fs`, `path`, `node:fs`) from the build output.
+         * If `true`, all Node.js built-ins will be marked as external.
+         * Default: `false`.
+         */
+        node?: boolean;
+        /**
+         * Whether to exclude workspace dependencies (e.g., packages marked with `workspace:*` in `package.json`) from the build output.
+         * If `true`, all workspace dependencies will be marked as external.
+         * Default: `false`.
+         */
+        workspace?: boolean;
+    } | boolean;
     onEject?: (instance: object, dependency: Function) => boolean;
 }
 /**
- * The main Vite plugin that:
- * - Detects when moost adapter usage (http, cli, wf).
- * - Patches `MoostHttp.prototype.listen` in dev mode to register a custom middleware instead of listening on a port.
- * - Injects a `__VITE_ID()` decorator into exported classes to track them for hot reload cleanup.
- * - Cleans up internal Moost state upon hot updates, then reloads the SSR entry.
+ * The main Vite plugin for integrating Moost applications.
+ *
+ * Features:
+ * - **Adapter Detection**: Detects Moost adapter usage (`http`, `cli`, `wf`) and applies relevant configurations.
+ * - **Dev Mode Middleware**:
+ *   - Patches `MoostHttp.prototype.listen` to register a custom middleware for serving the app via Vite's dev server instead of binding to a port.
+ *   - Handles Moost state cleanup and hot module replacement (HMR) during development.
+ * - **Class Tracking**: Injects a `__VITE_ID()` decorator into exported classes to enable tracking and cleanup during hot reloads.
+ * - **Externals Support**:
+ *   - Allows marking Node.js built-in modules and dependencies from `package.json` (optionally excluding workspace dependencies) as external during builds.
+ *   - Configured via the `externals` option, which helps reduce bundle size and ensures compatibility with runtime environments.
+ * - **Build and Test Friendly**:
+ *   - Avoids interfering with Vitest runs by skipping dev-specific behaviors during tests.
+ *   - Ensures proper SSR entry setup and Rollup configurations for production builds.
+ *
+ * @param {TMoostViteDevOptions} options - Configuration options for the Moost Vite plugin.
+ * @returns {Plugin} The configured Vite plugin.
  */
 declare function moostVite(options: TMoostViteDevOptions): Plugin;
 

package/dist/index.mjs

@@ -81,7 +81,7 @@ function patchMoostHandlerLogging() {
     };
 }
 
-const PLUGIN_NAME = 'moost-vite-dev';
+const PLUGIN_NAME = 'moost-vite';
 function gatherAllImporters(moduleNode, visited = new Set()) {
     if (!moduleNode) {
         return visited;
@@ -101,13 +101,17 @@ const logger = new EventLogger('', { level: 99 }).createTopic('' + '' +
 function getLogger() {
     return logger;
 }
-function getExternals() {
+function getExternals({ node, workspace }) {
     const pkg = JSON.parse(readFileSync('package.json', 'utf8').toString());
-    return [
-        ...builtinModules,
-        ...builtinModules.map(m => `node:${m}`),
-        ...Object.keys(pkg.dependencies || {}),
-    ];
+    const externals = workspace
+        ? Object.keys(pkg.dependencies || {})
+        : Object.entries(pkg.dependencies || {})
+            .filter(([key, ver]) => !ver.startsWith('workspace:'))
+            .map(i => i[0]);
+    if (node) {
+        externals.push(...builtinModules, ...builtinModules.map(m => `node:${m}`));
+    }
+    return externals;
 }
 
 function moostRestartCleanup(adapters, onEject, cleanupInstances) {
@@ -198,8 +202,12 @@ function constructorName(i) {
 const REG_HAS_EXPORT_CLASS = /(^\s*@(Injectable|Controller)\()/m;
 const REG_REPLACE_EXPORT_CLASS = /(^\s*@(Injectable|Controller)\()/gm;
 function moostVite(options) {
+    const isTest = process.env.NODE_ENV === 'test';
+    const isProd = process.env.NODE_ENV === 'production';
     let moostMiddleware = null;
-    const adapters = [
+    const adapters = isTest
+        ? []
+        : [
             createAdapterDetector('http', MoostHttp => {
                 MoostHttp.prototype.listen = function (...args) {
                     moostMiddleware = this.getServerCb();
@@ -212,12 +220,11 @@ function moostVite(options) {
             createAdapterDetector('cli'),
             createAdapterDetector('wf'),
         ];
-    const logger = getLogger();
+    const logger = isTest ? console : getLogger();
     let reloadRequired = false;
     patchMoostHandlerLogging();
-    return {
+    const pluginConfig = {
         name: PLUGIN_NAME,
-        apply: 'serve',
         enforce: 'pre',
         config(cfg) {
             const entry = cfg.build?.rollupOptions?.input || options.entry;
@@ -237,7 +244,15 @@ function moostVite(options) {
                     ssr: cfg.build?.ssr ?? true,
                     minify: cfg.build?.minify || false,
                     rollupOptions: {
-                        external: cfg.build?.rollupOptions?.external || getExternals(),
+                        external: isTest
+                            ? cfg.build?.rollupOptions?.external
+                            : cfg.build?.rollupOptions?.external ||
+                                (options.externals === false
+                                    ? []
+                                    : getExternals({
+                                        node: Boolean(options.externals === true || options.externals?.node),
+                                        workspace: Boolean(options.externals === true || options.externals?.workspace),
+                                    })),
                         input: entry,
                         output: {
                             format: options.format,
@@ -322,6 +337,14 @@ function moostVite(options) {
             }
         },
     };
+    if (isProd || isTest) {
+        delete pluginConfig.configureServer;
+        delete pluginConfig.resolveId;
+        delete pluginConfig.load;
+        delete pluginConfig.transform;
+        delete pluginConfig.hotUpdate;
+    }
+    return pluginConfig;
 }
 
 export { moostVite };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moostjs/vite",
-  "version": "0.5.20",
+  "version": "0.5.21",
   "description": "Vite Dev plugin for moostjs",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -38,8 +38,8 @@
   },
   "homepage": "https://github.com/moostjs/moostjs/tree/main/packages/vite#readme",
   "peerDependencies": {
-    "moost": "0.5.20",
-    "@moostjs/event-http": "0.5.20",
+    "moost": "0.5.21",
+    "@moostjs/event-http": "0.5.21",
     "vite": "^6.0.5"
   }
 }