feat: support for rfw.json, the rfw manifest file

Author: mirkobrombin

README.md

@@ -25,16 +25,15 @@ rfw dev
 
 Read the [documentation](./docs/index.md) for a complete guide to the framework.
 
-## Plugins
+## Build-level Plugins
 
 `rfw` exposes a simple plugin system for build-time tasks. Plugins can register
 build steps and file-watcher triggers to extend the CLI without relying on
 external tooling.
 
-## Tailwind CSS
+### Tailwind CSS
 
 `rfw` includes a build step for [Tailwind CSS](https://tailwindcss.com/) using the official standalone CLI.
-Place an `input.css` file containing the `@tailwind` directives and optionally a
-`tailwind.config.js` in your project root. During development the server watches
+Place an `input.css` file containing the `@tailwind` directives in your project. During development the server watches
 template, stylesheet and configuration files and emits a trimmed `tailwind.css`
 containing only the classes you use, without requiring Node or a CDN.

cmd/rfw/build/build.go

@@ -1,6 +1,7 @@
 package build
 
 import (
+	"encoding/json"
 	"fmt"
 	"io"
 	"os"
@@ -29,7 +30,13 @@ func Build() error {
 		return fmt.Errorf("failed to build project: %s: %w", output, err)
 	}
 
-	if err := plugins.BuildAll(); err != nil {
+	var manifest struct {
+		Plugins map[string]json.RawMessage `json:"plugins"`
+	}
+	if data, err := os.ReadFile("rfw.json"); err == nil {
+		_ = json.Unmarshal(data, &manifest)
+	}
+	if err := plugins.BuildFromConfig(manifest.Plugins); err != nil {
 		return fmt.Errorf("failed to run plugins: %w", err)
 	}
 

cmd/rfw/plugins/plugins.go

@@ -1,34 +1,44 @@
 package plugins
 
-import "fmt"
+import (
+	"encoding/json"
+	"fmt"
+)
 
 // Plugin defines the interface that build plugins must implement.
 type Plugin interface {
 	Name() string
-	Build() error
+	Build(cfg json.RawMessage) error
 	ShouldRebuild(path string) bool
 }
 
-var registered []Plugin
+var (
+	registry = map[string]Plugin{}
+	active   []Plugin
+)
 
 // Register adds a plugin to the registry.
 func Register(p Plugin) {
-	registered = append(registered, p)
+	registry[p.Name()] = p
 }
 
-// BuildAll executes the Build method for all registered plugins.
-func BuildAll() error {
-	for _, p := range registered {
-		if err := p.Build(); err != nil {
-			return fmt.Errorf("%s build failed: %w", p.Name(), err)
+// BuildFromConfig executes the Build method for plugins listed in the manifest.
+func BuildFromConfig(cfg map[string]json.RawMessage) error {
+	active = active[:0]
+	for name, raw := range cfg {
+		if p, ok := registry[name]; ok {
+			if err := p.Build(raw); err != nil {
+				return fmt.Errorf("%s build failed: %w", p.Name(), err)
+			}
+			active = append(active, p)
 		}
 	}
 	return nil
 }
 
-// NeedsRebuild reports whether any plugin requires a rebuild for the given path.
+// NeedsRebuild reports whether any active plugin requires a rebuild for the given path.
 func NeedsRebuild(path string) bool {
-	for _, p := range registered {
+	for _, p := range active {
 		if p.ShouldRebuild(path) {
 			return true
 		}

cmd/rfw/plugins/tailwind/tailwind.go

@@ -1,6 +1,7 @@
 package tailwind
 
 import (
+	"encoding/json"
 	"fmt"
 	"log"
 	"os/exec"
@@ -9,28 +10,45 @@ import (
 	"github.com/rfwlab/rfw/cmd/rfw/plugins"
 )
 
-type plugin struct{}
+type plugin struct {
+	output string
+}
 
 func init() {
 	plugins.Register(&plugin{})
 }
 
 func (p *plugin) Name() string { return "tailwind" }
 
-func (p *plugin) Build() error {
+func (p *plugin) Build(raw json.RawMessage) error {
 	log.Printf("tailwind: starting build")
 	bin, err := exec.LookPath("tailwindcss")
 	if err != nil {
 		log.Printf("tailwind: tailwindcss not found, please install it manually")
 		return err
 	}
 
-	// FIXME: in future an rfw project should have a root manifest file with plugins configurations and so on,
-	// for the moment we will look for an input.css file in the project root
-	args := []string{
-		"-i", "input.css",
-		"-o", "tailwind.css",
-		"--minify",
+	cfg := struct {
+		Input  string   `json:"input"`
+		Output string   `json:"output"`
+		Minify bool     `json:"minify"`
+		Args   []string `json:"args"`
+	}{
+		Input:  "index.css",
+		Output: "tailwind.css",
+		Minify: true,
+	}
+	if len(raw) > 0 {
+		_ = json.Unmarshal(raw, &cfg)
+	}
+	p.output = cfg.Output
+
+	args := []string{"-i", cfg.Input, "-o", cfg.Output}
+	if cfg.Minify {
+		args = append(args, "--minify")
+	}
+	if len(cfg.Args) > 0 {
+		args = append(args, cfg.Args...)
 	}
 
 	log.Printf("tailwind: running %s %s", bin, strings.Join(args, " "))
@@ -43,7 +61,7 @@ func (p *plugin) Build() error {
 }
 
 func (p *plugin) ShouldRebuild(path string) bool {
-	if strings.HasSuffix(path, ".css") && !strings.HasSuffix(path, "tailwind.css") {
+	if strings.HasSuffix(path, ".css") && !strings.HasSuffix(path, p.output) {
 		log.Printf("tailwind: rebuild triggered by %s", path)
 		return true
 	}

cmd/rfw/server/server.go

@@ -13,7 +13,6 @@ import (
 	"github.com/fsnotify/fsnotify"
 	"github.com/rfwlab/rfw/cmd/rfw/build"
 	"github.com/rfwlab/rfw/cmd/rfw/plugins"
-	_ "github.com/rfwlab/rfw/cmd/rfw/plugins/tailwind"
 	"github.com/rfwlab/rfw/cmd/rfw/utils"
 )
 

docs/ui/rfw.json

@@ -0,0 +1,8 @@
+{
+    "plugins": {
+        "tailwind": {
+            "input": "input.css",
+            "output": "tailwind.css"
+        }
+    }
+}

example/rfw.json

@@ -0,0 +1,8 @@
+{
+    "plugins": {
+        "tailwind": {
+            "input": "input.css",
+            "output": "tailwind.css"
+        }
+    }
+}