Skip to content

CodeWithSushil/brushcss

Repository files navigation

๐ŸŽจ๐Ÿ–Œ๏ธ BrushCSS

Tests Packagist Version Packagist Dependency Version Packagist License Packagist Downloads Packagist Stars

A PHP-native utility-first CSS engine with JIT compilation, plugin marketplace support, and deep framework integration (Hurricane-ready).


๐Ÿš€ What is BrushCSS?

BrushCSS is a backend-driven CSS compiler that scans your PHP/HTML views and generates only the CSS you actually use.

Instead of shipping large static stylesheets, BrushCSS builds CSS on demand (JIT) and integrates directly into your PHP application lifecycle.


โšก Key Features

  • ๐Ÿ” JIT Compilation — Generates CSS only from used classes
  • ๐Ÿง  View Scanner — Extracts classes from ".php" / ".html" views
  • ๐Ÿ”Œ Plugin System — Extend utilities and variants easily
  • ๐Ÿ“ฆ Composer Ready — Install via Packagist
  • ๐ŸŒช๏ธ Hurricane Integration — Middleware + DI ready
  • ๐Ÿ” HMR Support — Live CSS reload during development
  • ๐Ÿงฑ Grid System (12-column) — Built-in layout engine
  • ๐ŸŽจ Utility-first design system
  • ๐ŸŒ Remote Plugin Marketplace (CLI "add")

๐Ÿ“ฆ Installation

composer require brushcss/brushcss

โš™๏ธ Initialization

php vendor/bin/brushcss init

This creates:

  • config/brushcss.php
  • public/style.css

๐Ÿงช Build CSS

php vendor/bin/brushcss build

๐Ÿ‘€ Watch Mode (HMR)

php vendor/bin/brushcss watch

๐Ÿ”ฅ Example Usage

View file ("views/login.php").

<h2 class="bg-blue-500 p-4 mt-5">
  Hello BrushCSS
</h2>

Generated CSS:

.bg-blue-500 { background-color: #3b82f6; }
.p-4 { padding: 16px; }
.mt-5 { margin-top: 20px; }

๐Ÿงฑ Grid System

<div class="grid grid-cols-12 gap-4">
  <div class="col-span-6">Left</div>
  <div class="col-span-6">Right</div>
</div>

๐ŸŽจ Utility Classes

Spacing:

p-4, p-6, mt-5, mb-2

Colors:

bg-blue-500, text-red-100

Layout:

  • flex
  • grid
  • hidden
  • block

Effects:

transition, duration-300, hover:bg-blue-500


๐Ÿ”Œ Plugin System

BrushCSS supports extensible plugins.

Install plugin:

brushcss add grid

Example plugins:

  • grid system
  • typography system
  • forms system
  • animation system

๐ŸŒ Plugin Marketplace

BrushCSS supports a remote registry:

brushcss add typography

Internally:

CLI → Registry API → Composer → Activation → Config injection


๐ŸŒช๏ธ Hurricane Integration

BrushCSS can be used inside the Hurricane PHP framework:

Middleware compilation

  • Auto-scans views per request
  • Generates scoped CSS
  • Injects into response pipeline

BrushCSSMiddleware::class


โšก Architecture

View Files
↓ Class Extractor
↓ JIT Engine
↓ Variant Compiler
↓ Plugin System
↓ CSS Output
public/css/style.css


๐Ÿง  Advanced Features (Roadmap)

๐Ÿ”ฅ JIT Engine Enhancements

  • Incremental builds
  • File hashing cache
  • Dependency graph tracking

โšก Variant System

hover:, md:, lg:, dark:

๐Ÿงฑ Grid & Layout Engine

  • 12-column grid
  • flex utilities
  • responsive breakpoints

๐ŸŒ Plugin Marketplace

  • versioning
  • remote registry
  • CLI install/remove/update

๐Ÿ” HMR WebSocket Server

  • instant CSS injection
  • no page reload

๐Ÿงฉ Component System (future)

  • "", "" style UI engine

๐Ÿ› ๏ธ CLI Commands

brushcss init brushcss build brushcss watch brushcss add brushcss remove brushcss list


๐Ÿ“ Project Structure

src/ bin/ config/ plugins/ public/ storage/ tests/


โš ๏ธ Philosophy

BrushCSS is built on one principle:

“Generate only what you use — nothing more.”

No heavy bundles. No unused CSS. No frontend build dependency.


๐Ÿš€ Future Vision

BrushCSS is evolving into:

A PHP-native styling compiler ecosystem with plugin marketplace and framework-level integration.

Comparable in concept to modern frontend tooling, but fully backend-driven.


๐Ÿ“œ License

MIT License


โœจ Author

Built for modern PHP ecosystems and deep framework integration (Hurricane-ready architecture).

About

๐ŸŽจ๐Ÿ–Œ๏ธ BrushCSS:A PHP-native utility-first CSS engine with JIT compilation, plugin marketplace support, and deep framework integration (Hurricane-ready).

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

  •  

Packages

 
 
 

Contributors

Languages