assetmin

README

📦 AssetMin

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

AssetMin is a simple yet powerful tool that bundles and minifies your JavaScript and CSS files into single optimized output files, improving your web application's performance.

🛠️ 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. Whether you're building a small project or a large-scale application, AssetMin simplifies the bundling and minification of your JavaScript and CSS files with minimal effort.

✨ Features

• 🔄 Live Asset Processing - Automatically processes files when they are created or modified
• 🗜️ Minification - Reduces file size by removing unnecessary characters
• 🔌 Concurrency Support - Thread-safe operation for multiple file processing
• 📁 Directory Structure - Organizes files from theme and module directories
• 🛠️ Simple API - Easy to integrate into your Go application

📥 Installation

import "github.com/cdvelop/assetmin"

🚀 Quick Start

package main

import (
	"fmt"
	
	"github.com/cdvelop/assetmin"
)

func main() {
	// Create configuration
	config := &assetmin.Config{
		// Define theme folder path
		ThemeFolder: func() string { 
			return "./web/theme" 
		},
		
		// Define public folder for output files
		OutputDir: func() string { 
			return "./web/public" 
		},
		
		// Define print function
		Print: func(messages ...any) {
			fmt.Println(messages...)
		},
		
		// Optional JavaScript initialization code
		GetRuntimeInitializerJS: func() (string, error) {
			return "console.log('App initialized!');", nil
		},
	}
	
	// Initialize AssetMin
	handler := assetmin.NewAssetMin(config)
	
	// Process a new JavaScript file
	handler.NewFileEvent("script.js", ".js", "./path/to/script.js", "create")
	
	// Process a new CSS file
	handler.NewFileEvent("styles.css", ".css", "./path/to/styles.css", "create")
	
	// Files will be bundled and minified into:
	// - ./web/public/main.js
	// - ./web/public/style.css
}

🔄 How It Works

1. 📁 You define theme and output directories
2. 📝 Create or modify JS/CSS files
3. 🔄 Call NewFileEvent when files change
4. 📦 AssetMin processes and bundles your files
5. 🚀 Output is saved to your public directory as minified files

📋 API Reference

NewAssetMin(config *Config) *AssetMin

Creates a new instance of the AssetMin handler.

NewFileEvent(filename, extension, filepath, event string) error

Processes a file event (create/write).

🛠️ Configuration Options

Option	Description
ThemeFolder	Function that returns the path to your theme directory
OutputDir	Function that returns the path to your public output directory
Print	Function for logging messages
GetRuntimeInitializerJS	Function that returns initialization JavaScript code

📋 Roadmap

See docs/issues/README.md for planned features:

• HTTP Routes & Work Modes (SSR/Disk)
• Asset Caching System
• Template System Refactor
• TUI Integration

---

Contributing

📄 License

This project is licensed under the [MIT] License.

Documentation

Index

• func FileWrite(pathFile string, data bytes.Buffer) error
• func NewFaviconSvgHandler(ac *Config, outputName string) *asset
• func NewHtmlHandler(ac *Config, outputName, cssURL, jsURL string) *asset
• func NewSvgHandler(ac *Config, outputName string) *asset
• type AssetMin
  • func NewAssetMin(ac *Config) *AssetMin
  • func (c *AssetMin) EnsureOutputDirectoryExists()
  • func (c *AssetMin) GetWorkMode() WorkMode
  • func (c *AssetMin) NewFileEvent(fileName, extension, filePath, event string) error
  • func (c *AssetMin) RefreshAsset(extension string)
  • func (c *AssetMin) RegisterRoutes(mux *http.ServeMux)
  • func (c *AssetMin) SetWorkMode(mode WorkMode)
  • func (c *AssetMin) SupportedExtensions() []string
  • func (c *AssetMin) UnobservedFiles() []string
  • func (c *AssetMin) UpdateFileContentInMemory(filePath, extension, event string, content []byte) (*asset, error)
• type Config
• type TestEnvironment
  • func (env *TestEnvironment) CleanDirectory()
  • func (env *TestEnvironment) CreateModulesDir() *TestEnvironment
  • func (env *TestEnvironment) CreatePublicDir() *TestEnvironment
  • func (env *TestEnvironment) CreateThemeDir() *TestEnvironment
  • func (env *TestEnvironment) TestConcurrentFileProcessing(fileExtension string, fileCount int)
  • func (env *TestEnvironment) TestFileCRUDOperations(fileExtension string)
• type WorkMode

Functions

func FileWrite

func FileWrite(pathFile string, data bytes.Buffer) error

pathFile e.g., "theme/htmlMainFileName" data e.g., *bytes.Buffer NOTE: The buffer data will be cleared after writing the file

func NewFaviconSvgHandler

func NewFaviconSvgHandler(ac *Config, outputName string) *asset

NewFaviconSvgHandler creates a handler for favicon.svg that simply minifies and copies the file without sprite wrapping. This handler processes standalone SVG files like favicon.svg

func NewHtmlHandler

func NewHtmlHandler(ac *Config, outputName, cssURL, jsURL string) *asset

NewHtmlHandler creates an HTML asset handler using the provided output filename

func NewSvgHandler

func NewSvgHandler(ac *Config, outputName string) *asset

Types

type AssetMin

type AssetMin struct {
	*Config
	// contains filtered or unexported fields
}

func NewAssetMin

func NewAssetMin(ac *Config) *AssetMin

func (*AssetMin) EnsureOutputDirectoryExists

func (c *AssetMin) EnsureOutputDirectoryExists()

func (*AssetMin) GetWorkMode

func (c *AssetMin) GetWorkMode() WorkMode

GetWorkMode returns the current work mode of AssetMin.

func (*AssetMin) NewFileEvent

func (c *AssetMin) NewFileEvent(fileName, extension, filePath, event string) error

event: create, remove, write, rename

func (*AssetMin) RefreshAsset

func (c *AssetMin) RefreshAsset(extension string)

func (*AssetMin) RegisterRoutes

func (c *AssetMin) RegisterRoutes(mux *http.ServeMux)

RegisterRoutes registers the HTTP handlers for all assets.

func (*AssetMin) SetWorkMode

func (c *AssetMin) SetWorkMode(mode WorkMode)

SetWorkMode sets the work mode for AssetMin.

func (*AssetMin) SupportedExtensions

func (c *AssetMin) SupportedExtensions() []string

func (*AssetMin) UnobservedFiles

func (c *AssetMin) UnobservedFiles() []string

func (*AssetMin) UpdateFileContentInMemory

func (c *AssetMin) UpdateFileContentInMemory(filePath, extension, event string, content []byte) (*asset, error)

type Config

type Config struct {
	OutputDir               string                 // eg: web/static, web/public, web/assets
	Logger                  func(message ...any)   // Renamed from io.Writer to a function type
	GetRuntimeInitializerJS func() (string, error) // javascript code to initialize the wasm or other handlers
	AppName                 string                 // Application name for templates (default: "MyApp")
	AssetsURLPrefix         string                 // New: for HTTP routes
}

type TestEnvironment

type TestEnvironment struct {
	BaseDir       string
	ThemeDir      string
	PublicDir     string
	ModulesDir    string
	MainJsPath    string
	MainCssPath   string
	MainSvgPath   string
	MainHtmlPath  string
	AssetsHandler *AssetMin
	// contains filtered or unexported fields
}

TestEnvironment holds all the paths and components needed for asset tests

func (*TestEnvironment) CleanDirectory

func (env *TestEnvironment) CleanDirectory()

CleanDirectory removes all content from the test directory but keeps the directory itself

func (*TestEnvironment) CreateModulesDir

func (env *TestEnvironment) CreateModulesDir() *TestEnvironment

CreateModulesDir creates the modules directory if it doesn't exist

func (*TestEnvironment) CreatePublicDir

func (env *TestEnvironment) CreatePublicDir() *TestEnvironment

CreatePublicDir creates the public directory if it doesn't exist

func (*TestEnvironment) CreateThemeDir

func (env *TestEnvironment) CreateThemeDir() *TestEnvironment

CreateThemeDir creates the theme directory if it doesn't exist

func (*TestEnvironment) TestConcurrentFileProcessing

func (env *TestEnvironment) TestConcurrentFileProcessing(fileExtension string, fileCount int)

TestConcurrentFileProcessing is a reusable function to test concurrent file processing for both JS and CSS.

func (*TestEnvironment) TestFileCRUDOperations

func (env *TestEnvironment) TestFileCRUDOperations(fileExtension string)

TestFileCRUDOperations tests the complete CRUD cycle (create, write, remove) for a file

type WorkMode

type WorkMode int

const (
	MemoryMode WorkMode = iota // Serve from memory cache (default)
	DiskMode                   // Write to disk + serve from cache
)