assetmin

📦 AssetMin

🚀 A lightweight and efficient web asset packager and minifier for Go applications

AssetMin bundles and minifies your JavaScript, CSS, SVG, and HTML files with support for both memory-based and disk-based serving. Perfect for development and production workflows.

🛠️ Primary Use Case

AssetMin is primarily used in the GoDEV framework for developing full stack projects with Go. It provides an efficient solution for managing and optimizing web assets, ensuring seamless integration into your Go workflow.

✨ Features

• 🔄 Live Asset Processing - Event-driven file processing with automatic cache invalidation
• 🗜️ Minification - Optimized minification using tdewolff/minify
• 💾 Dual Work Modes - Memory-only (dev) or disk-based (production) serving
• 🌐 HTTP Serving - Built-in HTTP handlers with configurable URL prefixes
• 🔒 Thread-Safe - Concurrent file processing with mutex protection
• 📦 Asset Bundling - Combines multiple files into optimized bundles
• ⚡ Smart Caching - In-memory cache for instant HTTP responses

📥 Installation

go get github.com/tinywasm/assetmin

🚀 Quick Start

package main

import (
	"log"
	"net/http"
	
	"github.com/tinywasm/assetmin"
)

func main() {
	// Create configuration
	config := &assetmin.Config{
		OutputDir: "web/public",
		Logger: func(msg ...any) {
			log.Println(msg...)
		},
		AppName: "MyApp",
		AssetsURLPrefix: "/assets/",
	}
	
	// Initialize AssetMin
	am := assetmin.NewAssetMin(config)
	
	// Register HTTP routes
	mux := http.NewServeMux()
	am.RegisterRoutes(mux)
	
	// Process files
	am.NewFileEvent("button.css", ".css", "./src/button.css", "create")
	am.NewFileEvent("app.js", ".js", "./src/app.js", "create")
	
	// Start server
	log.Println("Server running on :8080")
	http.ListenAndServe(":8080", mux)
}

🔄 How It Works

1. Configure - Set output directory and options
2. Initialize - Create AssetMin instance
3. Process Events - Notify AssetMin of file changes
4. Serve - Assets are minified, cached, and served via HTTP
5. Deploy - Switch to DiskMode to write optimized files

📚 Documentation

• API Documentation - Complete API reference with examples
• Roadmap - Planned features and improvements
• Contributing - Contribution guidelines

🎯 Core API

Configuration

type Config struct {
    OutputDir               string                 // Output directory for assets
    Logger                  func(message ...any)   // Logging function
    GetRuntimeInitializerJS func() (string, error) // JS initialization code
    AppName                 string                 // Application name
    AssetsURLPrefix         string                 // URL prefix for assets
}

Main Methods

// Create new instance
am := assetmin.NewAssetMin(config)

// Process file events
am.NewFileEvent(fileName, extension, filePath, event)

// Register HTTP routes
am.RegisterRoutes(mux)

// Work mode control
am.SetWorkMode(assetmin.DiskMode)    // Write to disk
am.SetWorkMode(assetmin.MemoryMode)  // Memory only (default)

// Manual asset refresh
am.RefreshAsset(".js")  // Rebuild JavaScript bundle

🌐 HTTP Routes

AssetMin automatically registers routes for all assets:

💾 Work Modes

MemoryMode (Default)

• Serves assets from in-memory cache
• No disk writes
• Fastest for development

DiskMode

• Writes assets to disk on changes
• Still serves from cache for performance
• Useful for production builds

// Development
am.SetWorkMode(assetmin.MemoryMode)

// Production
am.SetWorkMode(assetmin.DiskMode)
am.EnsureOutputDirectoryExists()

📋 Supported File Types

• JavaScript (.js) - Bundled with automatic 'use strict' handling
• CSS (.css) - Merged and minified stylesheets
• SVG (.svg) - Icon sprites and favicons
• HTML (.html) - Template fragments (complete documents ignored)

🔧 Advanced Usage

See the API Documentation for:

• WASM integration examples
• File watcher integration
• Development vs production setup
• Thread safety details
• Performance considerations

📋 Roadmap

• ✅ Config Simplification
• ✅ Asset Caching System
• ✅ HTTP Routes & Work Modes
• 🔄 Template System Refactor
• 🔄 TUI Integration
• 🔄 Enhanced SSR Support

See docs/ROADMAP.md for details.

📄 License

This project is licensed under the [MIT] License.