npm - rails-vite-plugin - Versions diffs - 0.1.0-beta.1 - Mend

rails-vite-plugin 0.1.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/dev-server-index.html ADDED Viewed

@@ -0,0 +1,6 @@
+<html>
+<body>
+  <h1>rails-vite-plugin</h1>
+  <p>This is the Vite dev server. Your Rails app is running on a different port.</p>
+</body>
+</html>

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,12 @@
+import { Plugin } from 'vite';
+export interface RailsViteOptions {
+    input?: string | string[];
+    sourceDir?: string;
+    ssr?: string;
+    ssrOutputDirectory?: string;
+    devMetaFile?: string;
+    buildDirectory?: string;
+    publicDirectory?: string;
+    refresh?: boolean | string | string[];
+}
+export default function rails(options?: RailsViteOptions): Plugin;

package/dist/index.js ADDED Viewed

@@ -0,0 +1,205 @@
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import picomatch from 'picomatch';
+import { loadEnv, defaultAllowedOrigins, } from 'vite';
+const defaultRefreshPaths = [
+    'app/views/**/*.{erb,slim,haml}',
+    'app/helpers/**/*.rb',
+];
+let exitHandlersBound = false;
+export default function rails(options = {}) {
+    const sourceDir = options.sourceDir ?? 'app/javascript';
+    const input = options.input ?? detectEntrypoint(sourceDir);
+    const publicDirectory = options.publicDirectory ?? 'public';
+    const buildDirectory = options.buildDirectory ?? 'vite';
+    const devMetaPath = options.devMetaFile ?? path.join('tmp', 'rails-vite.json');
+    const ssrOutputDirectory = options.ssrOutputDirectory ?? 'ssr';
+    const resolvedInput = resolveInput(input, sourceDir);
+    const resolvedSsr = options.ssr ? resolveInput(options.ssr, sourceDir) : undefined;
+    let resolvedConfig;
+    let devServerUrl;
+    let reactRefresh = false;
+    return {
+        name: 'rails-vite',
+        enforce: 'post',
+        config(userConfig, { command, mode }) {
+            const env = loadEnv(mode, userConfig.envDir || process.cwd(), '');
+            const ssr = !!userConfig.build?.ssr;
+            ensureCommandShouldRunInEnvironment(command, env);
+            return {
+                base: userConfig.base ?? (command === 'build' ? `/${buildDirectory}/` : ''),
+                publicDir: userConfig.publicDir ?? false,
+                build: {
+                    manifest: userConfig.build?.manifest ?? (ssr ? false : 'manifest.json'),
+                    ssrManifest: userConfig.build?.ssrManifest ?? (ssr ? 'ssr-manifest.json' : false),
+                    outDir: userConfig.build?.outDir ?? (ssr ? ssrOutputDirectory : path.join(publicDirectory, buildDirectory)),
+                    rollupOptions: {
+                        input: userConfig.build?.rollupOptions?.input ?? (ssr ? resolvedSsr : resolvedInput),
+                    },
+                    assetsInlineLimit: userConfig.build?.assetsInlineLimit ?? 0,
+                },
+                server: {
+                    cors: userConfig.server?.cors ?? {
+                        origin: userConfig.server?.origin ?? defaultAllowedOrigins,
+                    },
+                },
+                resolve: {
+                    alias: Array.isArray(userConfig.resolve?.alias)
+                        ? [
+                            ...(userConfig.resolve?.alias ?? []),
+                            { find: '@', replacement: path.resolve(process.cwd(), sourceDir) },
+                        ]
+                        : {
+                            '@': path.resolve(process.cwd(), sourceDir),
+                            ...userConfig.resolve?.alias,
+                        },
+                },
+                ssr: {
+                    noExternal: resolveNoExternal(userConfig),
+                },
+            };
+        },
+        configResolved(config) {
+            resolvedConfig = config;
+            reactRefresh = config.plugins.some((p) => p.name === 'vite:react-babel' || p.name === 'vite:react-swc');
+        },
+        writeBundle() {
+            if (resolvedConfig.build.ssr)
+                return;
+            const outDir = resolvedConfig.build.outDir;
+            fs.writeFileSync(path.join(outDir, 'rails-vite.json'), JSON.stringify({ sourceDir }));
+        },
+        configureServer(server) {
+            server.httpServer?.once('listening', () => {
+                const address = server.httpServer?.address();
+                if (isAddressInfo(address)) {
+                    devServerUrl = resolveDevServerUrl(address, resolvedConfig);
+                    resolvedConfig.server.origin = devServerUrl;
+                    const meta = { url: devServerUrl, sourceDir };
+                    if (reactRefresh)
+                        meta.reactRefresh = true;
+                    fs.writeFileSync(devMetaPath, JSON.stringify(meta));
+                    setTimeout(() => {
+                        server.config.logger.info(`\n  RAILS  rails-vite-plugin`);
+                    }, 100);
+                }
+            });
+            if (!exitHandlersBound) {
+                const clean = () => {
+                    fs.rmSync(devMetaPath, { force: true });
+                };
+                process.on('exit', clean);
+                process.on('SIGINT', () => process.exit());
+                process.on('SIGTERM', () => process.exit());
+                process.on('SIGHUP', () => process.exit());
+                exitHandlersBound = true;
+            }
+            // Watch view templates for full-page reload
+            const refreshPaths = resolveRefreshPaths(options.refresh);
+            if (refreshPaths.length) {
+                const match = picomatch(refreshPaths);
+                server.watcher.add(refreshPaths);
+                server.watcher.on('change', (filePath) => {
+                    const relativePath = path.relative(process.cwd(), filePath);
+                    if (match(relativePath)) {
+                        server.ws.send({ type: 'full-reload', path: '*' });
+                    }
+                });
+            }
+            // Serve a helpful page at the dev server root
+            const devServerIndexHtml = fs.readFileSync(path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', 'dev-server-index.html'), 'utf-8');
+            return () => server.middlewares.use((req, res, next) => {
+                if (req.url === '/index.html') {
+                    res.statusCode = 404;
+                    res.end(devServerIndexHtml);
+                    return;
+                }
+                next();
+            });
+        },
+    };
+}
+function resolveInput(input, sourceDir) {
+    if (Array.isArray(input)) {
+        return input.map((entry) => prefixWithSourceDir(entry, sourceDir));
+    }
+    return prefixWithSourceDir(input, sourceDir);
+}
+function prefixWithSourceDir(entry, sourceDir) {
+    if (entry.startsWith(sourceDir + '/') || entry.startsWith('/')) {
+        return entry;
+    }
+    return `${sourceDir}/${entry}`;
+}
+const defaultEntryExtensions = ['.js', '.ts', '.jsx', '.tsx'];
+function detectEntrypoint(sourceDir) {
+    for (const ext of defaultEntryExtensions) {
+        const candidate = path.join(sourceDir, `application${ext}`);
+        if (fs.existsSync(candidate)) {
+            return `application${ext}`;
+        }
+    }
+    return 'application.js';
+}
+function resolveRefreshPaths(refresh) {
+    if (refresh === false || refresh === undefined) {
+        return defaultRefreshPaths;
+    }
+    if (refresh === true) {
+        return defaultRefreshPaths;
+    }
+    if (typeof refresh === 'string') {
+        return [refresh];
+    }
+    return refresh;
+}
+function resolveDevServerUrl(address, config) {
+    const configHmrProtocol = typeof config.server.hmr === 'object' ? config.server.hmr.protocol : null;
+    const clientProtocol = configHmrProtocol
+        ? configHmrProtocol === 'wss'
+            ? 'https'
+            : 'http'
+        : null;
+    const serverProtocol = config.server.https ? 'https' : 'http';
+    const protocol = clientProtocol ?? serverProtocol;
+    const configHmrHost = typeof config.server.hmr === 'object' ? config.server.hmr.host : null;
+    const configHost = typeof config.server.host === 'string' ? config.server.host : null;
+    const serverAddress = address.family === 'IPv6' || address.family === 6
+        ? `[${address.address}]`
+        : address.address;
+    const host = configHmrHost ?? configHost ?? serverAddress;
+    const configHmrClientPort = typeof config.server.hmr === 'object' ? config.server.hmr.clientPort : null;
+    const port = configHmrClientPort ?? address.port;
+    return `${protocol}://${host}:${port}`;
+}
+function isAddressInfo(x) {
+    return typeof x === 'object' && x !== null;
+}
+function ensureCommandShouldRunInEnvironment(command, env) {
+    if (command === 'build') {
+        return;
+    }
+    if (env.CI !== undefined) {
+        throw new Error('rails-vite-plugin: You should not run the Vite dev server in CI. ' +
+            'Run `rake vite:build` instead.');
+    }
+    if (env.RAILS_ENV === 'production') {
+        throw new Error('rails-vite-plugin: You should not run the Vite dev server in production. ' +
+            'Run `rake vite:build` instead.');
+    }
+}
+function resolveNoExternal(config) {
+    const userNoExternal = config.ssr?.noExternal;
+    const pluginNoExternal = ['rails-vite-plugin'];
+    if (userNoExternal === true) {
+        return true;
+    }
+    if (userNoExternal === undefined) {
+        return pluginNoExternal;
+    }
+    return [
+        ...(Array.isArray(userNoExternal) ? userNoExternal : [userNoExternal]),
+        ...pluginNoExternal,
+    ];
+}

package/package.json ADDED Viewed

@@ -0,0 +1,58 @@
+{
+  "name": "rails-vite-plugin",
+  "version": "0.1.0-beta.1",
+  "description": "Vite plugin for Rails integration",
+  "author": "Svyatoslav Kryukov <me@skryukov.dev>",
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "dev-server-index.html"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src/",
+    "prepublishOnly": "tsc -p tsconfig.build.json"
+  },
+  "peerDependencies": {
+    "vite": ">=5.0.0"
+  },
+  "dependencies": {
+    "picomatch": "^4.0.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^22.0.0",
+    "@types/picomatch": "^3.0.0",
+    "eslint": "^10.0.2",
+    "typescript": "^5.0.0",
+    "typescript-eslint": "^8.56.1",
+    "vite": "^7.3.1",
+    "vitest": "^4.0.18"
+  },
+  "keywords": [
+    "vite",
+    "rails",
+    "vite-plugin"
+  ],
+  "homepage": "https://github.com/skryukov/rails_vite",
+  "bugs": "https://github.com/skryukov/rails_vite/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/skryukov/rails_vite",
+    "directory": "packages/rails-vite-plugin"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}