svelte-bundle 0.0.1

package/ReadMe.md

@@ -0,0 +1,38 @@
+# Svelte Bundle CLI
+
+**Svelte Bundle CLI** is a simple command-line tool that allows you to bundle a Svelte application into a single `.html` file using Vite and SSR (Server-Side Rendering). The goal of this tool is to make it easy to bundle Svelte apps for deployment, particularly for cases where everything needs to be contained in a single file.
+
+Just note, the purpose of this tool is **NOT** to bundle an entire Svelte app, in-fact it is highly discouraged due to the overhead of the generated file. The purpose of this is to expand the capabilities of svelte to work on systems like certain Content Management Systems (CMS) that only allow HTML, CSS, and JS. It also was created with SSR so that the generated file is SEO-safe where necessary elements are already hydrated.
+
+Utilizing this you will be able to develop a page with the joy of svelte and be able to directly get a single `.html` file that you can utilize getting full use-case of svelte.
+
+⚠️ **Note**: This tool is **NOT** made to function with SvelteKit, this takes a single `.svelte` file as input and utilizes vite to compile it into a single `.html` file.
+
+⚠️ **Note**: This tool is currently in early development and is not fully complete. The roadmap and additional features will be added over time. There is currently **NO** testing on this, meaning there is no guarentee it will work for most usecases.
+
+## Inspiration
+This tool was inspired by the need I had when it came to updating the CMS for a company I worked for. They were looking for more custom content on their website which used an outdated CMS. Pages were only able to include HTML, CSS, and JS.
+
+Pure HTML, CSS, and JS can be grainular and more-importantly, lacks the reactivity that Svelte has. Meaning, to develop certain features I had to focus a lot more on the "what to do" when data changes, rather than Svelte handling that for me.
+
+So, I searched for tools around that could be of assistance. I found [figsvelte](https://github.com/thomas-lowry/figsvelte) which was of so much help in the underlying understanding of what to do. But, it did not accomplish all I was looking for. I needed a solution that didn't just generate an HTML file with JS that hydrated the page. Through a lot of tinkering around I was able to finally get the system to work.
+
+I noticed through a lot of google searches I wasn't the only one looking for a solution like this, yet, I was unable to find one that addressed everything I was looking for. So, for this reason I have decided to build svelte-bundle to take care of this in a much more simplistic and CLI way.
+
+## Features (In Progress)
+- [ ] Bundles Svelte applications using Vite and SSR.
+- [ ] Outputs a single `.html` file ready for deployment.
+- [ ] CLI arguments for specifying input and output directories.
+
+## Roadmap
+- [ ] Add options for SSR hydration
+- [ ] Handle CSS and assets within the bundled file.
+- [ ] Implement error handling and more robust validation.
+- [ ] Add support for environment-specific builds (development/production).
+- [ ] Documentation and guides on using the tool with different Svelte apps.
+- [ ] Tests and CI integration.
+
+## Installation (Planned)
+Once the tool is published on npm, it will be available via `npx`:
+```bash
+npx svelte-bundle -i <input-dir> -o <output-dir>

package/bundle.js

@@ -0,0 +1,119 @@
+import fs from 'fs/promises';
+import path from 'path';
+import { rollup } from 'rollup';
+import svelte from 'rollup-plugin-svelte';
+import resolve from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import { compile } from 'svelte/compiler';
+import css from 'rollup-plugin-css-only';
+import terser from '@rollup/plugin-terser';
+
+export async function buildStaticFile(svelteFilePath, outputDir) {
+  try {
+    let cssText = '';
+    
+    // Create temporary SSR bundle
+    const ssrBundle = await rollup({
+      input: svelteFilePath,
+      plugins: [
+        svelte({
+          compilerOptions: {
+            generate: 'ssr',
+            hydratable: true,
+            css: false
+          },
+          emitCss: true
+        }),
+        css({
+          output: function(styles) {
+            cssText = styles;
+          }
+        }),
+        resolve({
+          browser: true,
+          dedupe: ['svelte']
+        }),
+        commonjs()
+      ],
+      external: ['svelte/internal']
+    });
+
+    // Create a temporary directory for SSR
+    const tempDir = path.join(path.dirname(svelteFilePath), '.temp');
+    await fs.mkdir(tempDir, { recursive: true });
+    const tempSSRFile = path.join(tempDir, 'ssr-bundle.js');
+
+    // Generate SSR bundle
+    await ssrBundle.write({
+      file: tempSSRFile,
+      format: 'es',
+      exports: 'default'
+    });
+
+    // Import the SSR bundle
+    const { default: App } = await import(tempSSRFile);
+    const { html: initialHtml } = App.render();
+
+    // Clean up temp file
+    await fs.rm(tempDir, { recursive: true, force: true });
+
+    // Build client-side bundle
+    const clientBundle = await rollup({
+      input: svelteFilePath,
+      plugins: [
+        svelte({
+          compilerOptions: {
+            hydratable: true,
+            css: false
+          },
+          emitCss: true
+        }),
+        css({
+          output: function(styles) {
+            cssText = styles;
+          }
+        }),
+        resolve({
+          browser: true,
+          dedupe: ['svelte']
+        }),
+        commonjs(),
+        terser()
+      ]
+    });
+
+    const { output: [{ code: clientCode }] } = await clientBundle.generate({
+      format: 'iife',
+      name: 'App',
+      globals: {
+        svelte: 'Svelte'
+      }
+    });
+
+    // Create the final HTML
+    const finalHtml = `<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Static Svelte App</title>
+    <style>
+      ${cssText}
+    </style>
+</head>
+<body>
+    <div id="app">${initialHtml}</div>
+    <script>
+      ${clientCode}
+      const app = new App({target: document.getElementById('app'), hydrate: true});
+    </script>
+</body>
+</html>`;
+
+    // Write the output file
+    const outputPath = path.join(outputDir, 'output.html');
+    await fs.writeFile(outputPath, finalHtml, 'utf-8');
+  } catch (error) {
+    throw error;
+  }
+}

package/cli.js

@@ -0,0 +1,108 @@
+#!/usr/bin/env node
+import { program } from 'commander';
+import chalk from 'chalk';
+import path from 'path';
+import fs from 'fs/promises';
+import { createInterface } from 'readline';
+import { buildStaticFile } from './bundle.js';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// Create readline interface for prompts
+const rl = createInterface({
+  input: process.stdin,
+  output: process.stdout
+});
+
+// Promisify readline question
+const question = (query) => new Promise((resolve) => rl.question(query, resolve));
+
+program
+  .name('svelte-bundle')
+  .description('Bundle a Svelte file into a standalone .html file')
+  .version('0.0.1')
+  .requiredOption('-i, --input <path>', 'Input Svelte file')
+  .option('-o, --output <path>', 'Output directory (defaults to current directory)')
+  .option('-f, --force', 'Force overwrite without asking');
+
+program.parse();
+
+const options = program.opts();
+
+async function checkFileExists(filepath) {
+  try {
+    await fs.access(filepath);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+async function shouldOverwrite(filepath) {
+  const answer = await question(
+    chalk.yellow(`File ${filepath} already exists. Overwrite? (y/N): `)
+  );
+  return answer.toLowerCase() === 'y';
+}
+
+async function validateAndProcess() {
+  try {
+    // Validate input file
+    const inputPath = path.resolve(options.input);
+    const inputExt = path.extname(inputPath);
+    
+    if (inputExt !== '.svelte') {
+      console.error(chalk.red('Error: Input file must be a .svelte file'));
+      process.exit(1);
+    }
+
+    // Check if input file exists
+    try {
+      await fs.access(inputPath);
+    } catch {
+      console.error(chalk.red(`Error: Input file ${inputPath} does not exist`));
+      process.exit(1);
+    }
+
+    // Determine output directory and file path
+    let outputDir = process.cwd();
+    if (options.output) {
+      outputDir = path.resolve(options.output);
+      // Create output directory if it doesn't exist
+      await fs.mkdir(outputDir, { recursive: true });
+    }
+
+    const outputPath = path.join(outputDir, 'output.html');
+
+    // Check if output file exists and handle overwriting
+    if (await checkFileExists(outputPath)) {
+      if (!options.force) {
+        const shouldProceed = await shouldOverwrite(outputPath);
+        if (!shouldProceed) {
+          console.log(chalk.yellow('Operation cancelled.'));
+          process.exit(0);
+        }
+      }
+    }
+
+    console.log(chalk.blue('Starting build process...'));
+    console.log(chalk.gray(`Input: ${inputPath}`));
+    console.log(chalk.gray(`Output: ${outputPath}`));
+
+    // Process the file
+    await buildStaticFile(inputPath, outputDir);
+
+    console.log(chalk.green('\n✨ Build completed successfully!'));
+    console.log(chalk.gray(`Output file: ${outputPath}`));
+  } catch (error) {
+    console.error(chalk.red('\nBuild failed:'));
+    console.error(chalk.red(error.message));
+    process.exit(1);
+  } finally {
+    rl.close();
+  }
+}
+
+validateAndProcess();

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "svelte-bundle",
+  "version": "0.0.1",
+  "description": "Bundle Svelte files into static HTML files",
+  "type": "module",
+  "bin": {
+    "svelte-bundle": "./cli.js"
+  },
+  "files": [
+    "cli.js",
+    "bundle.js"
+  ],
+  "keywords": [
+    "svelte",
+    "bundle",
+    "static",
+    "html",
+    "ssr"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "prepublishOnly": "chmod +x cli.js"
+  },
+  "author": "Teddy Hartling",
+  "license": "MIT",
+  "dependencies": {
+    "@rollup/plugin-commonjs": "^24.0.1",
+    "@rollup/plugin-node-resolve": "^15.0.2",
+    "@rollup/plugin-terser": "^0.4.0",
+    "chalk": "^5.3.0",
+    "commander": "^11.0.0",
+    "rollup": "^3.20.0",
+    "rollup-plugin-css-only": "^4.3.0",
+    "rollup-plugin-svelte": "^7.1.4",
+    "svelte": "^3.58.0"
+  }
+}