docs: update README to reflect current functionality (#6)

- Initialize logger before Playwright to prevent nil pointer dereference
- Set AllowedPaths for CLI URLs so they get processed by scraper

Co-authored-by: Claude <noreply@anthropic.com>

README.md

@@ -1,145 +1,225 @@
 # Rollup
 
-Rollup aggregates the contents of text-based files and webpages into a markdown file.
+Rollup aggregates the contents of text-based files and webpages into markdown files.
 
 ## Features
 
-- File type filtering for targeted content aggregation
-- Ignore patterns for excluding specific files or directories
-- Support for code-generated file detection and exclusion
-- Advanced web scraping functionality with depth control
-- Verbose logging option for detailed operation insights
-- Exclusionary CSS selectors for precise web content extraction
-- Support for multiple URLs in web scraping operations
-- Configurable output format for web scraping (single file or separate files)
-- Flexible configuration file support (YAML)
-- Automatic generation of default configuration file
-- Custom output file naming
-- Rate limiting for web scraping to respect server resources
+- **File aggregation**: Combine multiple source files into a single markdown document
+- **File type filtering**: Include only specific file extensions
+- **Ignore patterns**: Exclude files/directories using glob patterns
+- **Code-generated file detection**: Mark auto-generated files as read-only in output
+- **Web scraping**: Scrape webpage content using Playwright browser automation
+- **HTML to Markdown conversion**: Automatically converts scraped HTML to clean markdown
+- **CSS selectors**: Extract specific content sections or exclude unwanted elements
+- **Path-based overrides**: Configure different selectors for specific URL paths
+- **Rate limiting**: Configurable requests per second and burst limits for web scraping
+- **Output modes**: Single combined file or separate files per source
+- **Verbose logging**: Detailed operation insights for debugging
+- **YAML configuration**: Flexible configuration file support
 
 ## Installation
 
-To install Rollup, make sure you have Go installed on your system, then run:
+Ensure you have Go 1.21+ installed, then run:
 
 ```bash
-go get github.com/tnypxl/rollup
+go install github.com/tnypxl/rollup@latest
+```
+
+Or build from source:
+
+```bash
+git clone https://github.com/tnypxl/rollup.git
+cd rollup
+go build -o rollup .
 ```
 
 ## Usage
 
-Basic usage:
-
 ```bash
 rollup [command] [flags]
 ```
 
 ### Commands
 
-- `rollup files`: Rollup files into a single Markdown file
-- `rollup web`: Scrape main content from webpages and convert to Markdown
-- `rollup generate`: Generate a rollup.yml config file
+| Command | Description |
+|---------|-------------|
+| `files` | Aggregate local files into a single markdown file |
+| `web` | Scrape webpages and convert to markdown |
+| `generate` | Generate a default rollup.yml config file |
 
 ### Flags for `files` command
 
-- `--path, -p`: Path to the project directory (default: current directory)
-- `--types, -t`: Comma-separated list of file extensions to include (default: .go,.md,.txt)
-- `--codegen, -g`: Comma-separated list of glob patterns for code-generated files
-- `--ignore, -i`: Comma-separated list of glob patterns for files to ignore
+| Flag | Short | Default | Description |
+|------|-------|---------|-------------|
+| `--path` | `-p` | `.` | Path to the project directory |
+| `--types` | `-t` | `go,md,txt` | Comma-separated list of file extensions (without dots) |
+| `--codegen` | `-g` | | Glob patterns for code-generated files |
+| `--ignore` | `-i` | | Glob patterns for files to ignore |
 
 ### Flags for `web` command
 
-- `--urls, -u`: URLs of the webpages to scrape (comma-separated)
-- `--output, -o`: Output type: 'single' for one file, 'separate' for multiple files (default: single)
-- `--depth, -d`: Depth of link traversal (default: 0, only scrape the given URLs)
-- `--css`: CSS selector to extract specific content
-- `--exclude`: CSS selectors to exclude from the extracted content (comma-separated)
+| Flag | Short | Description |
+|------|-------|-------------|
+| `--urls` | `-u` | URLs of webpages to scrape (comma-separated) |
+| `--output` | `-o` | Output type: `single` or `separate` |
+| `--css` | | CSS selector to extract specific content |
+| `--exclude` | | CSS selectors to exclude (comma-separated) |
 
 ### Global flags
 
-- `--config, -f`: Path to the configuration file (default: rollup.yml in the current directory)
-- `--verbose, -v`: Enable verbose logging
+| Flag | Short | Description |
+|------|-------|-------------|
+| `--config` | `-f` | Path to config file (default: `rollup.yml`) |
+| `--verbose` | `-v` | Enable verbose logging |
 
 ## Configuration
 
-Rollup can be configured using a YAML file. By default, it looks for `rollup.yml` in the current directory. You can specify a different configuration file using the `--config` flag.
+Rollup reads from `rollup.yml` by default. Use `--config` to specify a different file.
 
-Example `rollup.yml`:
+### Configuration Options
 
 ```yaml
+# File extensions to include (without leading dots)
 file_extensions:
   - go
   - md
+  - js
+
+# Glob patterns for paths to ignore
 ignore_paths:
   - node_modules/**
   - vendor/**
   - .git/**
+
+# Glob patterns for code-generated files (marked as read-only in output)
 code_generated_paths:
-  - **/generated/**
+  - "**/*.pb.go"
+  - "**/generated/**"
+
+# Web scraping site configurations
 sites:
   - base_url: https://example.com
-    css_locator: .content
+    css_locator: .main-content
     exclude_selectors:
       - .ads
       - .navigation
-    max_depth: 2
+      - footer
     allowed_paths:
-      - /blog
       - /docs
+      - /blog
     exclude_paths:
       - /admin
-    output_alias: example
+    file_name_prefix: example-docs
     path_overrides:
       - path: /special-page
         css_locator: .special-content
         exclude_selectors:
           - .special-ads
+
+# Output type for web scraping: 'single' or 'separate'
 output_type: single
+
+# Rate limiting for web requests
 requests_per_second: 1.0
 burst_limit: 3
 ```
 
+### Configuration Reference
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `file_extensions` | list | File extensions to include in file rollup |
+| `ignore_paths` | list | Glob patterns for files/directories to skip |
+| `code_generated_paths` | list | Glob patterns for auto-generated files |
+| `sites` | list | Web scraping target configurations |
+| `output_type` | string | `single` (one file) or `separate` (multiple files) |
+| `requests_per_second` | float | Rate limit for web requests (default: 1.0) |
+| `burst_limit` | int | Maximum burst size for rate limiting (default: 3) |
+
+#### Site Configuration
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `base_url` | string | Starting URL for scraping (required) |
+| `css_locator` | string | CSS selector for content extraction |
+| `exclude_selectors` | list | CSS selectors for content to exclude |
+| `allowed_paths` | list | URL paths allowed for scraping |
+| `exclude_paths` | list | URL paths to skip |
+| `file_name_prefix` | string | Prefix for output file names |
+| `path_overrides` | list | Path-specific selector overrides |
+
 ## Examples
 
-1. Rollup files with default configuration:
+### File Aggregation
 
-   ```bash
-   rollup files
-   ```
+```bash
+# Rollup files using config file
+rollup files
 
-2. Web scraping with multiple URLs:
+# Specify file types and ignore patterns
+rollup files --types=go,js,ts --ignore="vendor/**,*_test.go"
 
-   ```bash
-   rollup web --urls=https://example.com,https://another-example.com
-   ```
+# Rollup a specific directory
+rollup files --path=/path/to/project
+```
 
-3. Generate a default configuration file:
+### Web Scraping
 
-   ```bash
-   rollup generate
-   ```
+```bash
+# Scrape URLs from command line
+rollup web --urls=https://example.com/docs
 
-4. Use a custom configuration file:
+# Scrape multiple URLs
+rollup web --urls=https://example.com,https://another.com
 
-   ```bash
-   rollup files --config=my-config.yml
-   ```
+# Extract specific content with CSS selector
+rollup web --urls=https://example.com --css=".article-content"
 
-5. Web scraping with separate output files:
+# Exclude elements from scraped content
+rollup web --urls=https://example.com --css=".content" --exclude=".ads,.sidebar"
 
-   ```bash
-   rollup web --urls=https://example.com,https://another-example.com --output=separate
-   ```
+# Output to separate files
+rollup web --urls=https://example.com --output=separate
+```
 
-6. Rollup files with specific types and ignore patterns:
+### Configuration Generation
 
-   ```bash
-   rollup files --types=go,md --ignore=vendor/**,*_test.go
-   ```
+```bash
+# Generate rollup.yml based on files in current directory
+rollup generate
+```
 
-7. Web scraping with depth and CSS selector:
-   ```bash
-   rollup web --urls=https://example.com --depth=2 --css=.main-content
-   ```
+### Using Custom Config
+
+```bash
+rollup files --config=my-config.yml
+rollup web --config=my-config.yml
+```
+
+## Output
+
+### File Rollup Output
+
+The `files` command generates a markdown file named `<project-name>-<timestamp>.rollup.md` containing all matched files:
+
+```markdown
+# File: src/main.go
+
+​```go
+package main
+// ... file contents
+​```
+
+# File: docs/README.md (Code-generated, Read-only)
+
+​```md
+// ... file contents
+​```
+```
+
+### Web Rollup Output
+
+The `web` command generates markdown files from scraped content, with filenames based on the page title or URL.
 
 ## Contributing
 

cmd/root.go

@@ -1,8 +1,10 @@
 package cmd
 
 import (
+	"log"
+
 	"github.com/spf13/cobra"
-	config "github.com/tnypxl/rollup/internal/config"
+	"github.com/tnypxl/rollup/internal/config"
 )
 
 var (
@@ -15,13 +17,31 @@ var rootCmd = &cobra.Command{
 	Short: "Rollup is a tool for combining and processing files",
 	Long: `Rollup is a versatile tool that can combine and process files in various ways.
 Use subcommands to perform specific operations.`,
+	PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
+		// Skip config loading for generate and help commands
+		if cmd.Name() == "generate" || cmd.Name() == "help" {
+			return nil
+		}
+
+		// Determine config path
+		configPath := configFile
+		if configPath == "" {
+			configPath = "rollup.yml"
+		}
+
+		// Load configuration
+		var err error
+		cfg, err = config.Load(configPath)
+		if err != nil {
+			log.Printf("Warning: Failed to load configuration from %s: %v", configPath, err)
+			cfg = &config.Config{} // Use empty config if loading fails
+		}
+
+		return nil
+	},
 }
 
-func Execute(conf *config.Config) error {
-	if conf == nil {
-		conf = &config.Config{} // Use an empty config if none is provided
-	}
-	cfg = conf // Set the cfg variable in cmd/files.go
+func Execute() error {
 	return rootCmd.Execute()
 }
 

cmd/web.go

@@ -28,7 +28,21 @@ var webCmd = &cobra.Command{
 	Use:   "web",
 	Short: "Scrape main content from webpages and convert to Markdown",
 	Long:  `Scrape the main content from one or more webpages, ignoring navigational elements, ads, and other UI aspects. Convert the content to a well-structured Markdown file.`,
+	PreRunE: func(cmd *cobra.Command, args []string) error {
+		// Setup logger before initializing Playwright
+		scraper.SetupLogger(verbose)
+		// Initialize Playwright for web scraping
+		if err := scraper.InitPlaywright(); err != nil {
+			return fmt.Errorf("failed to initialize Playwright: %w", err)
+		}
+		return nil
+	},
 	RunE: runWeb,
+	PostRunE: func(cmd *cobra.Command, args []string) error {
+		// Clean up Playwright resources
+		scraper.ClosePlaywright()
+		return nil
+	},
 }
 
 func init() {
@@ -71,6 +85,7 @@ func runWeb(cmd *cobra.Command, args []string) error {
 				BaseURL:          u,
 				CSSLocator:       includeSelector,
 				ExcludeSelectors: excludeSelectors,
+				AllowedPaths:     []string{""},
 			}
 			logger.Printf("URL %d configuration: BaseURL=%s, CSSLocator=%s",
 				i+1, u, includeSelector)
@@ -144,95 +159,6 @@ func runWeb(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
-func writeSingleFile(content map[string]string) error {
-	outputFile := generateDefaultFilename()
-	file, err := os.Create(outputFile)
-	if err != nil {
-		return fmt.Errorf("error creating output file: %v", err)
-	}
-	defer file.Close()
-
-	for url, c := range content {
-		_, err = fmt.Fprintf(file, "# ::: Content from %s\n\n%s\n\n---\n\n", url, c)
-		if err != nil {
-			return fmt.Errorf("error writing content to file: %v", err)
-		}
-	}
-
-	fmt.Printf("Content has been extracted from %d URL(s) and saved to %s\n", len(content), outputFile)
-	return nil
-}
-
-func writeMultipleFiles(content map[string]string) error {
-	for url, c := range content {
-		filename, err := getFilenameFromContent(c, url)
-		if err != nil {
-			return fmt.Errorf("error generating filename for %s: %v", url, err)
-		}
-
-		file, err := os.Create(filename)
-		if err != nil {
-			return fmt.Errorf("error creating output file %s: %v", filename, err)
-		}
-
-		_, err = file.WriteString(fmt.Sprintf("# ::: Content from %s\n\n%s\n", url, c))
-		if err != nil {
-			file.Close()
-			return fmt.Errorf("error writing content to file %s: %v", filename, err)
-		}
-
-		file.Close()
-		fmt.Printf("Content from %s has been saved to %s\n", url, filename)
-	}
-
-	return nil
-}
-
-func generateDefaultFilename() string {
-	timestamp := time.Now().Format("20060102-150405")
-	return fmt.Sprintf("web-%s.rollup.md", timestamp)
-}
-
-func scrapeURL(urlStr string) (string, error) {
-	content, err := testExtractAndConvertContent(urlStr)
-	if err != nil {
-		return "", err
-	}
-
-	return content, nil
-}
-
-var (
-	testExtractAndConvertContent = extractAndConvertContent
-)
-
-func extractAndConvertContent(urlStr string) (string, error) {
-	content, err := scraper.FetchWebpageContent(urlStr)
-	if err != nil {
-		return "", fmt.Errorf("error fetching webpage content: %v", err)
-	}
-
-	if includeSelector != "" {
-		content, err = scraper.ExtractContentWithCSS(content, includeSelector, excludeSelectors)
-		if err != nil {
-			return "", fmt.Errorf("error extracting content with CSS: %v", err)
-		}
-	}
-
-	markdown, err := scraper.ProcessHTMLContent(content, scraper.Config{})
-	if err != nil {
-		return "", fmt.Errorf("error processing HTML content: %v", err)
-	}
-
-	parsedURL, err := url.Parse(urlStr)
-	if err != nil {
-		return "", fmt.Errorf("error parsing URL: %v", err)
-	}
-	header := fmt.Sprintf("# ::: Content from %s\n\n", parsedURL.String())
-
-	return header + markdown + "\n\n", nil
-}
-
 func getFilenameFromContent(content, urlStr string) (string, error) {
 	// Try to extract title from content
 	titleStart := strings.Index(content, "<title>")

cmd/web_test.go

@@ -97,8 +97,3 @@ func TestGetFilenameFromContent(t *testing.T) {
 		}
 	}
 }
-
-// Mock functions for testing
-func mockExtractAndConvertContent(urlStr string) (string, error) {
-	return "Mocked content for " + urlStr, nil
-}

internal/config/config.go

@@ -92,6 +92,10 @@ func (c *Config) Validate() error {
 		return fmt.Errorf("file_extensions or sites must be specified")
 	}
 
+	if c.OutputType != "" && c.OutputType != "single" && c.OutputType != "separate" {
+		return fmt.Errorf("output_type must be 'single' or 'separate'")
+	}
+
 	if c.RequestsPerSecond != nil && *c.RequestsPerSecond <= 0 {
 		return fmt.Errorf("requests_per_second must be positive")
 	}

internal/config/config_test.go

@@ -136,6 +136,30 @@ func TestValidate(t *testing.T) {
 			},
 			wantErr: true,
 		},
+		{
+			name: "Valid output type single",
+			config: Config{
+				FileExtensions: []string{"go"},
+				OutputType:     "single",
+			},
+			wantErr: false,
+		},
+		{
+			name: "Valid output type separate",
+			config: Config{
+				FileExtensions: []string{"go"},
+				OutputType:     "separate",
+			},
+			wantErr: false,
+		},
+		{
+			name: "Invalid output type",
+			config: Config{
+				FileExtensions: []string{"go"},
+				OutputType:     "invalid",
+			},
+			wantErr: true,
+		},
 	}
 
 	for _, tt := range tests {

main.go

@@ -2,40 +2,13 @@ package main
 
 import (
 	"fmt"
-	"log"
 	"os"
 
 	"github.com/tnypxl/rollup/cmd"
-	"github.com/tnypxl/rollup/internal/config"
-	"github.com/tnypxl/rollup/internal/scraper"
 )
 
 func main() {
-	// Check if the command is "help"
-	isHelpCommand := len(os.Args) > 1 && (os.Args[1] == "help" || os.Args[1] == "--help" || os.Args[1] == "-h")
-
-	var cfg *config.Config
-	var err error
-
-	if !isHelpCommand {
-		configPath := "rollup.yml"
-		cfg, err = config.Load(configPath)
-		if err != nil {
-			log.Printf("Warning: Failed to load configuration: %v", err)
-			// Continue execution without a config file
-		}
-
-		// Initialize the scraper logger with default verbosity (false)
-		scraper.SetupLogger(false)
-
-		err = scraper.InitPlaywright()
-		if err != nil {
-			log.Fatalf("Failed to initialize Playwright: %v", err)
-		}
-		defer scraper.ClosePlaywright()
-	}
-
-	if err := cmd.Execute(cfg); err != nil {
+	if err := cmd.Execute(); err != nil {
 		fmt.Println(err)
 		os.Exit(1)
 	}