6 Commits

13 changed files with 642 additions and 731 deletions

View File

@@ -1,53 +0,0 @@
# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## Build and Run Commands
```bash
# Build the binary
go build -o rollup .
# Run directly
go run main.go [command]
# Run tests
go test ./...
# Run a single test
go test -run TestName ./path/to/package
```
## Project Overview
Rollup is a Go CLI tool that aggregates text-based files and webpages into markdown files. It has three main commands:
- `files` - Rolls up local files into a single markdown file
- `web` - Scrapes webpages and converts to markdown using Playwright
- `generate` - Creates a default rollup.yml config file
## Architecture
**Entry Point**: `main.go` initializes Playwright browser and loads config before executing commands via Cobra.
**Command Layer** (`cmd/`):
- `root.go` - Cobra root command with global flags (--config, --verbose)
- `files.go` - File aggregation with glob pattern matching for ignore/codegen detection
- `web.go` - Web scraping orchestration, converts config site definitions to scraper configs
- `generate.go` - Scans directory for text file types and generates rollup.yml
**Internal Packages**:
- `internal/config` - YAML config loading and validation. Defines `Config`, `SiteConfig`, `PathOverride` structs
- `internal/scraper` - Playwright-based web scraping with rate limiting, HTML-to-markdown conversion via goquery and html-to-markdown library
**Key Dependencies**:
- `spf13/cobra` - CLI framework
- `playwright-go` - Browser automation for web scraping
- `PuerkitoBio/goquery` - HTML parsing and CSS selector extraction
- `JohannesKaufmann/html-to-markdown` - HTML to markdown conversion
## Configuration
The tool reads from `rollup.yml` by default. Key config fields:
- `file_extensions` - File types to include in rollup
- `ignore_paths` / `code_generated_paths` - Glob patterns for exclusion
- `sites` - Web scraping targets with CSS selectors, path filtering, rate limiting

View File

@@ -15,7 +15,7 @@ Rollup aggregates the contents of text-based files and webpages into a markdown
- Flexible configuration file support (YAML) - Flexible configuration file support (YAML)
- Automatic generation of default configuration file - Automatic generation of default configuration file
- Custom output file naming - Custom output file naming
- Rate limiting for web scraping to respect server resources - Concurrent processing for improved performance
## Installation ## Installation
@@ -63,39 +63,37 @@ rollup [command] [flags]
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 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.
Example `rollup.yml`: **Scrape Configuration Parameters:**
- `requests_per_second`: *(float, optional)* The rate at which requests are made per second during web scraping. Default is `1.0`.
- `burst_limit`: *(integer, optional)* The maximum number of requests that can be made in a burst. Default is `5`.
These parameters help control the request rate to avoid overloading the target servers and to comply with their rate limits.
**Example `rollup.yml` with Scrape Configuration:**
```yaml ```yaml
file_extensions: scrape:
- go requests_per_second: 1.0
- md burst_limit: 5
ignore_paths: sites:
- node_modules/** - base_url: https://example.com
- vendor/** css_locator: .content
- .git/** exclude_selectors:
code_generated_paths: - .ads
- **/generated/** - .navigation
sites: max_depth: 2
- base_url: https://example.com allowed_paths:
css_locator: .content - /blog
exclude_selectors: - /docs
- .ads exclude_paths:
- .navigation - /admin
max_depth: 2 output_alias: example
allowed_paths: path_overrides:
- /blog - path: /special-page
- /docs css_locator: .special-content
exclude_paths: exclude_selectors:
- /admin - .special-ads
output_alias: example
path_overrides:
- path: /special-page
css_locator: .special-content
exclude_selectors:
- .special-ads
output_type: single
requests_per_second: 1.0
burst_limit: 3
``` ```
## Examples ## Examples
@@ -106,10 +104,10 @@ burst_limit: 3
rollup files rollup files
``` ```
2. Web scraping with multiple URLs: 2. Web scraping with multiple URLs and increased concurrency:
```bash ```bash
rollup web --urls=https://example.com,https://another-example.com rollup web --urls=https://example.com,https://another-example.com --concurrent=8
``` ```
3. Generate a default configuration file: 3. Generate a default configuration file:
@@ -118,22 +116,20 @@ burst_limit: 3
rollup generate rollup generate
``` ```
4. Use a custom configuration file: 4. Use a custom configuration file and specify output:
```bash ```bash
rollup files --config=my-config.yml rollup files --config=my-config.yml --output=project_summary.md
``` ```
5. Web scraping with separate output files: 5. Web scraping with separate output files and custom timeout:
```bash ```bash
rollup web --urls=https://example.com,https://another-example.com --output=separate rollup web --urls=https://example.com,https://another-example.com --output=separate --timeout=60
``` ```
6. Rollup files with specific types and ignore patterns: 6. Rollup files with specific types and ignore patterns:
```bash ```bash
rollup files --types=go,md --ignore=vendor/**,*_test.go rollup files --types=.go,.md --ignore=vendor/**,*_test.go
``` ```
7. Web scraping with depth and CSS selector: 7. Web scraping with depth and CSS selector:

View File

@@ -33,7 +33,7 @@ whose name is <project-directory-name>-rollup-<timestamp>.md.`,
func init() { func init() {
filesCmd.Flags().StringVarP(&path, "path", "p", ".", "Path to the project directory") filesCmd.Flags().StringVarP(&path, "path", "p", ".", "Path to the project directory")
filesCmd.Flags().StringVarP(&fileTypes, "types", "t", "go,md,txt", "Comma-separated list of file extensions to include (without leading dot)") filesCmd.Flags().StringVarP(&fileTypes, "types", "t", ".go,.md,.txt", "Comma-separated list of file extensions to include")
filesCmd.Flags().StringVarP(&codeGenPatterns, "codegen", "g", "", "Comma-separated list of glob patterns for code-generated files") filesCmd.Flags().StringVarP(&codeGenPatterns, "codegen", "g", "", "Comma-separated list of glob patterns for code-generated files")
filesCmd.Flags().StringVarP(&ignorePatterns, "ignore", "i", "", "Comma-separated list of glob patterns for files to ignore") filesCmd.Flags().StringVarP(&ignorePatterns, "ignore", "i", "", "Comma-separated list of glob patterns for files to ignore")
} }
@@ -108,20 +108,19 @@ func isIgnored(filePath string, patterns []string) bool {
func runRollup(cfg *config.Config) error { func runRollup(cfg *config.Config) error {
// Use config if available, otherwise use command-line flags // Use config if available, otherwise use command-line flags
var types []string var types, codeGenList, ignoreList []string
var codeGenList, ignoreList []string if cfg != nil && len(cfg.FileTypes) > 0 {
if cfg != nil && len(cfg.FileExtensions) > 0 { types = cfg.FileTypes
types = cfg.FileExtensions
} else { } else {
types = strings.Split(fileTypes, ",") types = strings.Split(fileTypes, ",")
} }
if cfg != nil && len(cfg.CodeGeneratedPaths) > 0 { if cfg != nil && len(cfg.CodeGenerated) > 0 {
codeGenList = cfg.CodeGeneratedPaths codeGenList = cfg.CodeGenerated
} else { } else {
codeGenList = strings.Split(codeGenPatterns, ",") codeGenList = strings.Split(codeGenPatterns, ",")
} }
if cfg != nil && len(cfg.IgnorePaths) > 0 { if cfg != nil && cfg.Ignore != nil && len(cfg.Ignore) > 0 {
ignoreList = cfg.IgnorePaths ignoreList = cfg.Ignore
} else { } else {
ignoreList = strings.Split(ignorePatterns, ",") ignoreList = strings.Split(ignorePatterns, ",")
} }
@@ -146,11 +145,6 @@ func runRollup(cfg *config.Config) error {
} }
defer outputFile.Close() defer outputFile.Close()
startTime := time.Now()
showProgress := false
progressTicker := time.NewTicker(500 * time.Millisecond)
defer progressTicker.Stop()
// Walk through the directory // Walk through the directory
err = filepath.Walk(absPath, func(path string, info os.FileInfo, err error) error { err = filepath.Walk(absPath, func(path string, info os.FileInfo, err error) error {
if err != nil { if err != nil {
@@ -166,25 +160,16 @@ func runRollup(cfg *config.Config) error {
// Check if the file should be ignored // Check if the file should be ignored
if isIgnored(relPath, ignoreList) { if isIgnored(relPath, ignoreList) {
if verbose {
fmt.Printf("Ignoring file: %s\n", relPath)
}
return nil return nil
} }
ext := filepath.Ext(path) ext := filepath.Ext(path)
for _, t := range types { for _, t := range types {
if ext == "."+t { if ext == "."+t {
// Verbose logging for processed file
if verbose {
size := humanReadableSize(info.Size())
fmt.Printf("Processing file: %s (%s)\n", relPath, size)
}
// Read file contents // Read file contents
content, err := os.ReadFile(path) content, err := os.ReadFile(path)
if err != nil { if err != nil {
fmt.Printf("Error reading file %s: %v\n", path, err) fmt.Printf("Error reading file %s: %v", path, err)
return nil return nil
} }
@@ -200,43 +185,12 @@ func runRollup(cfg *config.Config) error {
break break
} }
} }
if !showProgress && time.Since(startTime) > 5*time.Second {
showProgress = true
fmt.Print("This is taking a while (hold tight) ")
}
select {
case <-progressTicker.C:
if showProgress {
fmt.Print(".")
}
default:
}
return nil return nil
}) })
if err != nil { if err != nil {
return fmt.Errorf("error walking through directory: %v", err) return fmt.Errorf("error walking through directory: %v", err)
} }
if showProgress { fmt.Printf("Rollup complete. Output file: %s", outputFileName)
fmt.Println() // Print a newline after the progress dots
}
fmt.Printf("Rollup complete. Output file: %s\n", outputFileName)
return nil return nil
} }
func humanReadableSize(size int64) string {
const unit = 1024
if size < unit {
return fmt.Sprintf("%d B", size)
}
div, exp := int64(unit), 0
for n := size / unit; n >= unit; n /= unit {
div *= unit
exp++
}
return fmt.Sprintf("%.1f %cB", float64(size)/float64(div), "KMGTPE"[exp])
}

View File

@@ -112,9 +112,9 @@ func TestRunRollup(t *testing.T) {
// Set up test configuration // Set up test configuration
cfg = &config.Config{ cfg = &config.Config{
FileExtensions: []string{"go", "txt", "md"}, FileTypes: []string{"go", "txt", "md"},
IgnorePaths: []string{"*.json", ".git/**", "vendor/**"}, Ignore: []string{"*.json", ".git/**", "vendor/**"},
CodeGeneratedPaths: []string{"generated_*.go"}, CodeGenerated: []string{"generated_*.go"},
} }
// Change working directory to the temp directory // Change working directory to the temp directory

View File

@@ -38,23 +38,23 @@ func runGenerate(cmd *cobra.Command, args []string) error {
} }
cfg := config.Config{ cfg := config.Config{
FileExtensions: make([]string, 0, len(fileTypes)), FileTypes: make([]string, 0, len(fileTypes)),
IgnorePaths: []string{"node_modules/**", "vendor/**", ".git/**"}, Ignore: []string{"node_modules/**", "vendor/**", ".git/**"},
} }
for ext := range fileTypes { for ext := range fileTypes {
cfg.FileExtensions = append(cfg.FileExtensions, ext) cfg.FileTypes = append(cfg.FileTypes, ext)
} }
// Sort file types for consistency // Sort file types for consistency
sort.Strings(cfg.FileExtensions) sort.Strings(cfg.FileTypes)
yamlData, err := yaml.Marshal(&cfg) yamlData, err := yaml.Marshal(&cfg)
if err != nil { if err != nil {
return fmt.Errorf("error marshaling config: %v", err) return fmt.Errorf("error marshaling config: %v", err)
} }
outputPath := "rollup.yml" outputPath := config.DefaultConfigPath()
err = os.WriteFile(outputPath, yamlData, 0644) err = os.WriteFile(outputPath, yamlData, 0644)
if err != nil { if err != nil {
return fmt.Errorf("error writing config file: %v", err) return fmt.Errorf("error writing config file: %v", err)

View File

@@ -1,10 +1,8 @@
package cmd package cmd
import ( import (
"log"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"github.com/tnypxl/rollup/internal/config" config "github.com/tnypxl/rollup/internal/config"
) )
var ( var (
@@ -17,31 +15,13 @@ var rootCmd = &cobra.Command{
Short: "Rollup is a tool for combining and processing files", 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. Long: `Rollup is a versatile tool that can combine and process files in various ways.
Use subcommands to perform specific operations.`, 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() error { 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
return rootCmd.Execute() return rootCmd.Execute()
} }

View File

@@ -4,9 +4,7 @@ import (
"fmt" "fmt"
"io" "io"
"log" "log"
"net/url"
"os" "os"
"regexp"
"strings" "strings"
"time" "time"
@@ -18,176 +16,176 @@ import (
var ( var (
urls []string urls []string
outputType string outputType string
depth int
includeSelector string includeSelector string
excludeSelectors []string excludeSelectors []string
) )
var scraperConfig scraper.Config
var webCmd = &cobra.Command{ var webCmd = &cobra.Command{
Use: "web", Use: "web",
Short: "Scrape main content from webpages and convert to Markdown", 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.`, 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 { RunE: runWeb,
// 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() { func init() {
webCmd.Flags().StringSliceVarP(&urls, "urls", "u", []string{}, "URLs of the webpages to scrape (comma-separated)") webCmd.Flags().StringSliceVarP(&urls, "urls", "u", []string{}, "URLs of the webpages to scrape (comma-separated)")
webCmd.Flags().StringVarP(&outputType, "output", "o", "", "Output type: 'single' for one file, 'separate' for multiple files") webCmd.Flags().StringVarP(&outputType, "output", "o", "single", "Output type: 'single' for one file, 'separate' for multiple files")
webCmd.Flags().IntVarP(&depth, "depth", "d", 0, "Depth of link traversal (default: 0, only scrape the given URLs)")
webCmd.Flags().StringVar(&includeSelector, "css", "", "CSS selector to extract specific content") webCmd.Flags().StringVar(&includeSelector, "css", "", "CSS selector to extract specific content")
webCmd.Flags().StringSliceVar(&excludeSelectors, "exclude", []string{}, "CSS selectors to exclude from the extracted content (comma-separated)") webCmd.Flags().StringSliceVar(&excludeSelectors, "exclude", []string{}, "CSS selectors to exclude from the extracted content (comma-separated)")
} }
func validateScrapeConfig(scrapeConfig config.ScrapeConfig) error {
if scrapeConfig.RequestsPerSecond <= 0 {
return fmt.Errorf("requests_per_second must be greater than 0")
}
if scrapeConfig.BurstLimit <= 0 {
return fmt.Errorf("burst_limit must be greater than 0")
}
return nil
}
func runWeb(cmd *cobra.Command, args []string) error { func runWeb(cmd *cobra.Command, args []string) error {
scraper.SetupLogger(verbose) scraper.SetupLogger(verbose)
logger := log.New(os.Stdout, "WEB: ", log.LstdFlags) logger := log.New(os.Stdout, "WEB: ", log.LstdFlags)
if !verbose { if !verbose {
logger.SetOutput(io.Discard) logger.SetOutput(io.Discard)
} }
logger.Printf("Starting web scraping process with verbose mode: %v", verbose) logger.Printf("Starting web scraping process with verbose mode: %v", verbose)
scraperConfig.Verbose = verbose
var siteConfigs []scraper.SiteConfig // Prepare site configurations
if len(cfg.Sites) > 0 { var siteConfigs []scraper.SiteConfig
logger.Printf("Using configuration from rollup.yml for %d sites", len(cfg.Sites)) if len(cfg.Scrape.Sites) > 0 {
siteConfigs = make([]scraper.SiteConfig, len(cfg.Sites)) // Use configurations from rollup.yml
for i, site := range cfg.Sites { logger.Printf("Using configuration from rollup.yml for %d sites", len(cfg.Scrape.Sites))
siteConfigs[i] = scraper.SiteConfig{ siteConfigs = make([]scraper.SiteConfig, len(cfg.Scrape.Sites))
BaseURL: site.BaseURL, for i, site := range cfg.Scrape.Sites {
CSSLocator: site.CSSLocator, siteConfigs[i] = scraper.SiteConfig{
ExcludeSelectors: site.ExcludeSelectors, BaseURL: site.BaseURL,
AllowedPaths: site.AllowedPaths, CSSLocator: site.CSSLocator,
ExcludePaths: site.ExcludePaths, ExcludeSelectors: site.ExcludeSelectors,
PathOverrides: convertPathOverrides(site.PathOverrides), MaxDepth: site.MaxDepth,
} AllowedPaths: site.AllowedPaths,
logger.Printf("Site %d configuration: BaseURL=%s, CSSLocator=%s, AllowedPaths=%v", ExcludePaths: site.ExcludePaths,
i+1, site.BaseURL, site.CSSLocator, site.AllowedPaths) OutputAlias: site.OutputAlias,
} PathOverrides: convertPathOverrides(site.PathOverrides),
} else { }
logger.Printf("No sites defined in rollup.yml, falling back to URL-based configuration") logger.Printf("Site %d configuration: BaseURL=%s, CSSLocator=%s, MaxDepth=%d, AllowedPaths=%v",
siteConfigs = make([]scraper.SiteConfig, len(urls)) i+1, site.BaseURL, site.CSSLocator, site.MaxDepth, site.AllowedPaths)
for i, u := range urls { }
siteConfigs[i] = scraper.SiteConfig{ } else {
BaseURL: u, // Use command-line URLs
CSSLocator: includeSelector, if len(urls) == 0 {
ExcludeSelectors: excludeSelectors, logger.Println("Error: No URLs provided via --urls flag")
} return fmt.Errorf("no URLs provided. Use --urls flag with comma-separated URLs or set 'scrape.sites' in the rollup.yml file")
logger.Printf("URL %d configuration: BaseURL=%s, CSSLocator=%s", }
i+1, u, includeSelector) siteConfigs = make([]scraper.SiteConfig, len(urls))
} for i, u := range urls {
} siteConfigs[i] = scraper.SiteConfig{
BaseURL: u,
CSSLocator: includeSelector,
ExcludeSelectors: excludeSelectors,
MaxDepth: depth,
AllowedPaths: []string{"/"}, // Allow all paths by default
}
logger.Printf("URL %d configuration: BaseURL=%s, CSSLocator=%s, MaxDepth=%d",
i+1, u, includeSelector, depth)
}
}
if len(siteConfigs) == 0 { // Set up scraper configuration
logger.Println("Error: No sites or URLs provided") scraperConfig := scraper.Config{
return fmt.Errorf("no sites or URLs provided. Use --urls flag with comma-separated URLs or set 'scrape.sites' in the rollup.yml file") Sites: siteConfigs,
} OutputType: outputType,
Verbose: verbose,
Scrape: scraper.ScrapeConfig{
RequestsPerSecond: cfg.Scrape.RequestsPerSecond,
BurstLimit: cfg.Scrape.BurstLimit,
},
}
logger.Printf("Scraper configuration: OutputType=%s, RequestsPerSecond=%f, BurstLimit=%d",
outputType, scraperConfig.Scrape.RequestsPerSecond, scraperConfig.Scrape.BurstLimit)
// Set default values for rate limiting // Validate scrape configuration
defaultRequestsPerSecond := 1.0 err := validateScrapeConfig(cfg.Scrape)
defaultBurstLimit := 3 if err != nil {
logger.Printf("Invalid scrape configuration: %v", err)
return err
}
// Use default values if not set in the configuration // Start scraping using scraper.ScrapeSites
requestsPerSecond := defaultRequestsPerSecond logger.Println("Starting scraping process")
if cfg.RequestsPerSecond != nil { scrapedContent, err := scraper.ScrapeSites(scraperConfig)
requestsPerSecond = *cfg.RequestsPerSecond if err != nil {
} logger.Printf("Error occurred during scraping: %v", err)
burstLimit := defaultBurstLimit return fmt.Errorf("error scraping content: %v", err)
if cfg.BurstLimit != nil { }
burstLimit = *cfg.BurstLimit logger.Printf("Scraping completed. Total content scraped: %d", len(scrapedContent))
}
scraperConfig := scraper.Config{ // Write output to files
Sites: siteConfigs, if outputType == "single" {
OutputType: outputType, logger.Println("Writing content to a single file")
Verbose: verbose, return writeSingleFile(scrapedContent)
Scrape: scraper.ScrapeConfig{ } else {
RequestsPerSecond: requestsPerSecond, logger.Println("Writing content to multiple files")
BurstLimit: burstLimit, return writeMultipleFiles(scrapedContent)
}, }
} }
logger.Printf("Scraper configuration: OutputType=%s, RequestsPerSecond=%f, BurstLimit=%d",
outputType, requestsPerSecond, burstLimit)
logger.Println("Starting scraping process")
startTime := time.Now()
progressTicker := time.NewTicker(time.Second)
defer progressTicker.Stop()
done := make(chan bool)
messagePrinted := false
go func() {
for {
select {
case <-progressTicker.C:
if time.Since(startTime) > 5*time.Second && !messagePrinted {
fmt.Print("This is taking a while (hold tight) ")
messagePrinted = true
} else if messagePrinted {
fmt.Print(".")
}
case <-done:
return
}
}
}()
err := scraper.ScrapeSites(scraperConfig)
done <- true
fmt.Println() // New line after progress indicator
func writeSingleFile(content map[string]string) error {
outputFile := generateDefaultFilename()
file, err := os.Create(outputFile)
if err != nil { if err != nil {
logger.Printf("Error occurred during scraping: %v", err) return fmt.Errorf("error creating output file: %v", err)
return fmt.Errorf("error scraping content: %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 := sanitizeFilename(url) + ".rollup.md"
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)
} }
logger.Println("Scraping completed")
return nil return nil
} }
func getFilenameFromContent(content, urlStr string) (string, error) { func generateDefaultFilename() string {
// Try to extract title from content timestamp := time.Now().Format("20060102-150405")
titleStart := strings.Index(content, "<title>") return fmt.Sprintf("web-%s.rollup.md", timestamp)
titleEnd := strings.Index(content, "</title>")
if titleStart != -1 && titleEnd != -1 && titleEnd > titleStart {
title := strings.TrimSpace(content[titleStart+7 : titleEnd])
if title != "" {
return sanitizeFilename(title) + ".rollup.md", nil
}
}
// If no title found or title is empty, use the URL
parsedURL, err := url.Parse(urlStr)
if err != nil {
return "", fmt.Errorf("invalid URL: %v", err)
}
if parsedURL.Host == "" {
return "", fmt.Errorf("invalid URL: missing host")
}
filename := parsedURL.Host
if parsedURL.Path != "" && parsedURL.Path != "/" {
filename += strings.TrimSuffix(parsedURL.Path, "/")
}
return sanitizeFilename(filename) + ".rollup.md", nil
} }
func sanitizeFilename(name string) string { func sanitizeFilename(name string) string {
// Remove any character that isn't alphanumeric, dash, or underscore // Remove any character that isn't alphanumeric, dash, or underscore
reg := regexp.MustCompile("[^a-zA-Z0-9-_]+") name = strings.Map(func(r rune) rune {
name = reg.ReplaceAllString(name, "_") if (r >= 'a' && r <= 'z') || (r >= 'A' && r <= 'Z') || (r >= '0' && r <= '9') || r == '-' || r == '_' {
return r
}
return '_'
}, name)
// Trim any leading or trailing underscores // Trim any leading or trailing underscores
name = strings.Trim(name, "_") name = strings.Trim(name, "_")

View File

@@ -2,7 +2,7 @@ package cmd
import ( import (
"testing" "testing"
"strings"
"github.com/tnypxl/rollup/internal/config" "github.com/tnypxl/rollup/internal/config"
) )
@@ -67,9 +67,9 @@ func TestSanitizeFilename(t *testing.T) {
func TestGetFilenameFromContent(t *testing.T) { func TestGetFilenameFromContent(t *testing.T) {
tests := []struct { tests := []struct {
content string content string
url string url string
expected string expected string
expectErr bool expectErr bool
}{ }{
{"<title>Test Page</title>", "http://example.com", "Test_Page.rollup.md", false}, {"<title>Test Page</title>", "http://example.com", "Test_Page.rollup.md", false},
@@ -97,3 +97,58 @@ func TestGetFilenameFromContent(t *testing.T) {
} }
} }
} }
// Mock functions for testing
func mockExtractAndConvertContent(urlStr string) (string, error) {
return "Mocked content for " + urlStr, nil
}
func mockExtractLinks() ([]string, error) {
return []string{"http://example.com/link1", "http://example.com/link2"}, nil
}
func TestScrapeURL(t *testing.T) {
// Store the original functions
originalExtractAndConvertContent := testExtractAndConvertContent
originalExtractLinks := testExtractLinks
// Define mock functions
testExtractAndConvertContent = func(urlStr string) (string, error) {
return "Mocked content for " + urlStr, nil
}
testExtractLinks = func(urlStr string) ([]string, error) {
return []string{"http://example.com/link1", "http://example.com/link2"}, nil
}
// Defer the restoration of original functions
defer func() {
testExtractAndConvertContent = originalExtractAndConvertContent
testExtractLinks = originalExtractLinks
}()
tests := []struct {
url string
depth int
expectedCalls int
}{
{"http://example.com", 0, 1},
{"http://example.com", 1, 3},
{"http://example.com", 2, 3}, // Same as depth 1 because our mock only returns 2 links
}
for _, test := range tests {
visited := make(map[string]bool)
content, err := scrapeURL(test.url, test.depth, visited)
if err != nil {
t.Errorf("scrapeURL(%q, %d) returned error: %v", test.url, test.depth, err)
continue
}
if len(visited) != test.expectedCalls {
t.Errorf("scrapeURL(%q, %d) made %d calls, expected %d", test.url, test.depth, len(visited), test.expectedCalls)
}
expectedContent := "Mocked content for " + test.url
if !strings.Contains(content, expectedContent) {
t.Errorf("scrapeURL(%q, %d) content doesn't contain %q", test.url, test.depth, expectedContent)
}
}
}

View File

@@ -7,64 +7,36 @@ import (
"gopkg.in/yaml.v2" "gopkg.in/yaml.v2"
) )
// Config represents the configuration for the rollup tool
type Config struct { type Config struct {
// FileExtensions is a list of file extensions to include in the rollup FileTypes []string `yaml:"file_types"`
FileExtensions []string `yaml:"file_extensions"` Ignore []string `yaml:"ignore"`
CodeGenerated []string `yaml:"code_generated"`
// IgnorePaths is a list of glob patterns for paths to ignore Scrape ScrapeConfig `yaml:"scrape"`
IgnorePaths []string `yaml:"ignore_paths"` }
// CodeGeneratedPaths is a list of glob patterns for code-generated files type ScrapeConfig struct {
CodeGeneratedPaths []string `yaml:"code_generated_paths"` Sites []SiteConfig `yaml:"sites"`
OutputType string `yaml:"output_type"`
// Sites is a list of site configurations for web scraping RequestsPerSecond float64 `yaml:"requests_per_second"`
Sites []SiteConfig `yaml:"sites"` BurstLimit int `yaml:"burst_limit"`
// OutputType specifies how the output should be generated
OutputType string `yaml:"output_type"`
// RequestsPerSecond limits the rate of web requests
RequestsPerSecond *float64 `yaml:"requests_per_second,omitempty"`
// BurstLimit sets the maximum burst size for rate limiting
BurstLimit *int `yaml:"burst_limit,omitempty"`
} }
// SiteConfig contains configuration for scraping a single site
type SiteConfig struct { type SiteConfig struct {
// BaseURL is the starting point for scraping this site BaseURL string `yaml:"base_url"`
BaseURL string `yaml:"base_url"` CSSLocator string `yaml:"css_locator"`
ExcludeSelectors []string `yaml:"exclude_selectors"`
// CSSLocator is used to extract specific content MaxDepth int `yaml:"max_depth"`
CSSLocator string `yaml:"css_locator"` AllowedPaths []string `yaml:"allowed_paths"`
ExcludePaths []string `yaml:"exclude_paths"`
// ExcludeSelectors lists CSS selectors for content to exclude OutputAlias string `yaml:"output_alias"`
ExcludeSelectors []string `yaml:"exclude_selectors"` PathOverrides []PathOverride `yaml:"path_overrides"`
LinksContainerSelector string `yaml:"links_container_selector"`
// AllowedPaths lists paths that are allowed to be scraped
AllowedPaths []string `yaml:"allowed_paths"`
// ExcludePaths lists paths that should not be scraped
ExcludePaths []string `yaml:"exclude_paths"`
// FileNamePrefix provides the base name for output files
FileNamePrefix string `yaml:"file_name_prefix"`
// PathOverrides allows for path-specific configurations
PathOverrides []PathOverride `yaml:"path_overrides"`
} }
// PathOverride allows for path-specific configurations
type PathOverride struct { type PathOverride struct {
// Path is the URL path this override applies to Path string `yaml:"path"`
Path string `yaml:"path"` CSSLocator string `yaml:"css_locator"`
ExcludeSelectors []string `yaml:"exclude_selectors"`
// CSSLocator overrides the site-wide CSS locator for this path
CSSLocator string `yaml:"css_locator"`
// ExcludeSelectors overrides the site-wide exclude selectors for this path
ExcludeSelectors []string `yaml:"exclude_selectors"`
} }
func Load(configPath string) (*Config, error) { func Load(configPath string) (*Config, error) {
@@ -79,36 +51,22 @@ func Load(configPath string) (*Config, error) {
return nil, fmt.Errorf("error parsing config file: %v", err) return nil, fmt.Errorf("error parsing config file: %v", err)
} }
if err := config.Validate(); err != nil { // Set default values if they are zero or missing
return nil, fmt.Errorf("invalid configuration: %v", err) if config.Scrape.RequestsPerSecond <= 0 {
config.Scrape.RequestsPerSecond = 1.0
}
if config.Scrape.BurstLimit <= 0 {
config.Scrape.BurstLimit = 5
} }
return &config, nil return &config, nil
} }
// Validate checks the configuration for any invalid values func DefaultConfigPath() string {
func (c *Config) Validate() error { return "rollup.yml"
if len(c.FileExtensions) == 0 && len(c.Sites) == 0 {
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")
}
if c.BurstLimit != nil && *c.BurstLimit <= 0 {
return fmt.Errorf("burst_limit must be positive")
}
for _, site := range c.Sites {
if site.BaseURL == "" {
return fmt.Errorf("base_url must be specified for each site")
}
}
return nil
} }
func FileExists(filename string) bool {
_, err := os.Stat(filename)
return err == nil
}

View File

@@ -9,33 +9,34 @@ import (
func TestLoad(t *testing.T) { func TestLoad(t *testing.T) {
// Create a temporary config file // Create a temporary config file
content := []byte(` content := []byte(`
file_extensions: file_types:
- go - go
- md - md
ignore_paths: ignore:
- "*.tmp" - "*.tmp"
- "**/*.log" - "**/*.log"
code_generated_paths: code_generated:
- "generated_*.go" - "generated_*.go"
sites: scrape:
- base_url: "https://example.com" sites:
css_locator: "main" - base_url: "https://example.com"
exclude_selectors: css_locator: "main"
- ".ads" exclude_selectors:
max_depth: 2 - ".ads"
allowed_paths: max_depth: 2
- "/blog" allowed_paths:
exclude_paths: - "/blog"
- "/admin" exclude_paths:
file_name_prefix: "example" - "/admin"
path_overrides: output_alias: "example"
- path: "/special" path_overrides:
css_locator: ".special-content" - path: "/special"
exclude_selectors: css_locator: ".special-content"
- ".sidebar" exclude_selectors:
output_type: "single" - ".sidebar"
requests_per_second: 1.0 output_type: "single"
burst_limit: 5 requests_per_second: 1.0
burst_limit: 5
`) `)
tmpfile, err := os.CreateTemp("", "config*.yml") tmpfile, err := os.CreateTemp("", "config*.yml")
@@ -58,32 +59,33 @@ burst_limit: 5
} }
// Check if the loaded config matches the expected values // Check if the loaded config matches the expected values
rps := 1.0
bl := 5
expectedConfig := &Config{ expectedConfig := &Config{
FileExtensions: []string{"go", "md"}, FileTypes: []string{"go", "md"},
IgnorePaths: []string{"*.tmp", "**/*.log"}, Ignore: []string{"*.tmp", "**/*.log"},
CodeGeneratedPaths: []string{"generated_*.go"}, CodeGenerated: []string{"generated_*.go"},
Sites: []SiteConfig{ Scrape: ScrapeConfig{
{ Sites: []SiteConfig{
BaseURL: "https://example.com", {
CSSLocator: "main", BaseURL: "https://example.com",
ExcludeSelectors: []string{".ads"}, CSSLocator: "main",
AllowedPaths: []string{"/blog"}, ExcludeSelectors: []string{".ads"},
ExcludePaths: []string{"/admin"}, MaxDepth: 2,
FileNamePrefix: "example", AllowedPaths: []string{"/blog"},
PathOverrides: []PathOverride{ ExcludePaths: []string{"/admin"},
{ OutputAlias: "example",
Path: "/special", PathOverrides: []PathOverride{
CSSLocator: ".special-content", {
ExcludeSelectors: []string{".sidebar"}, Path: "/special",
CSSLocator: ".special-content",
ExcludeSelectors: []string{".sidebar"},
},
}, },
}, },
}, },
OutputType: "single",
RequestsPerSecond: 1.0,
BurstLimit: 5,
}, },
OutputType: "single",
RequestsPerSecond: &rps,
BurstLimit: &bl,
} }
if !reflect.DeepEqual(config, expectedConfig) { if !reflect.DeepEqual(config, expectedConfig) {
@@ -91,83 +93,28 @@ burst_limit: 5
} }
} }
func TestValidate(t *testing.T) { func TestDefaultConfigPath(t *testing.T) {
tests := []struct { expected := "rollup.yml"
name string result := DefaultConfigPath()
config Config if result != expected {
wantErr bool t.Errorf("DefaultConfigPath() = %q, want %q", result, expected)
}{ }
{ }
name: "Valid config",
config: Config{ func TestFileExists(t *testing.T) {
FileExtensions: []string{"go"}, // Test with an existing file
Sites: []SiteConfig{ tmpfile, err := os.CreateTemp("", "testfile")
{BaseURL: "https://example.com"}, if err != nil {
}, t.Fatalf("Failed to create temp file: %v", err)
}, }
wantErr: false, defer os.Remove(tmpfile.Name())
},
{ if !FileExists(tmpfile.Name()) {
name: "No file extensions", t.Errorf("FileExists(%q) = false, want true", tmpfile.Name())
config: Config{}, }
wantErr: true,
}, // Test with a non-existing file
{ if FileExists("non_existing_file.txt") {
name: "Invalid requests per second", t.Errorf("FileExists(\"non_existing_file.txt\") = true, want false")
config: Config{
FileExtensions: []string{"go"},
RequestsPerSecond: func() *float64 { f := -1.0; return &f }(),
},
wantErr: true,
},
{
name: "Invalid burst limit",
config: Config{
FileExtensions: []string{"go"},
BurstLimit: func() *int { i := -1; return &i }(),
},
wantErr: true,
},
{
name: "Site without base URL",
config: Config{
FileExtensions: []string{"go"},
Sites: []SiteConfig{{}},
},
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 {
t.Run(tt.name, func(t *testing.T) {
err := tt.config.Validate()
if (err != nil) != tt.wantErr {
t.Errorf("Validate() error = %v, wantErr %v", err, tt.wantErr)
}
})
} }
} }

View File

@@ -8,7 +8,6 @@ import (
"math/rand" "math/rand"
"net/url" "net/url"
"os" "os"
"path/filepath"
"regexp" "regexp"
"strings" "strings"
"sync" "sync"
@@ -46,10 +45,12 @@ type SiteConfig struct {
BaseURL string BaseURL string
CSSLocator string CSSLocator string
ExcludeSelectors []string ExcludeSelectors []string
MaxDepth int
AllowedPaths []string AllowedPaths []string
ExcludePaths []string ExcludePaths []string
FileNamePrefix string OutputAlias string
PathOverrides []PathOverride PathOverrides []PathOverride
LinksContainerSelector string
} }
// PathOverride holds path-specific overrides // PathOverride holds path-specific overrides
@@ -59,33 +60,41 @@ type PathOverride struct {
ExcludeSelectors []string ExcludeSelectors []string
} }
func ScrapeSites(config Config) error { func ScrapeSites(config Config) (map[string]string, error) {
logger.Println("Starting ScrapeSites function - Verbose mode is active") logger.Println("Starting ScrapeSites function - Verbose mode is active")
results := make(chan struct { results := make(chan struct {
url string url string
content string content string
site SiteConfig // Add site config to track which site the content came from
err error err error
}) })
// Ensure RequestsPerSecond and BurstLimit are valid
if config.Scrape.RequestsPerSecond <= 0 {
config.Scrape.RequestsPerSecond = 1.0
}
if config.Scrape.BurstLimit <= 0 {
config.Scrape.BurstLimit = 5
}
limiter := rate.NewLimiter(rate.Limit(config.Scrape.RequestsPerSecond), config.Scrape.BurstLimit) limiter := rate.NewLimiter(rate.Limit(config.Scrape.RequestsPerSecond), config.Scrape.BurstLimit)
logger.Printf("Rate limiter configured with %f requests per second and burst limit of %d\n", logger.Printf("Rate limiter configured with %f requests per second and burst limit of %d\n", config.Scrape.RequestsPerSecond, config.Scrape.BurstLimit)
config.Scrape.RequestsPerSecond, config.Scrape.BurstLimit)
var wg sync.WaitGroup var wg sync.WaitGroup
totalURLs := 0 totalURLs := 0
for _, site := range config.Sites { var mu sync.Mutex
totalURLs += len(site.AllowedPaths)
}
for _, site := range config.Sites { for _, site := range config.Sites {
logger.Printf("Processing site: %s\n", site.BaseURL) logger.Printf("Processing site: %s\n", site.BaseURL)
wg.Add(1) wg.Add(1)
go func(site SiteConfig) { go func(site SiteConfig) {
defer wg.Done() defer wg.Done()
visited := make(map[string]bool)
for _, path := range site.AllowedPaths { for _, path := range site.AllowedPaths {
fullURL := site.BaseURL + path fullURL := site.BaseURL + path
mu.Lock()
totalURLs++
mu.Unlock()
logger.Printf("Queueing URL for scraping: %s\n", fullURL) logger.Printf("Queueing URL for scraping: %s\n", fullURL)
scrapeSingleURL(fullURL, site, results, limiter) scrapeSingleURL(fullURL, site, results, limiter, visited, 0)
} }
}(site) }(site)
} }
@@ -96,71 +105,167 @@ func ScrapeSites(config Config) error {
logger.Println("All goroutines completed, results channel closed") logger.Println("All goroutines completed, results channel closed")
}() }()
// Use a map that includes site configuration scrapedContent := make(map[string]string)
scrapedContent := make(map[string]struct {
content string
site SiteConfig
})
for result := range results { for result := range results {
if result.err != nil { if result.err != nil {
logger.Printf("Error scraping %s: %v\n", result.url, result.err) logger.Printf("Error scraping %s: %v\n", result.url, result.err)
continue continue
} }
logger.Printf("Successfully scraped content from %s (length: %d)\n", logger.Printf("Successfully scraped content from %s (length: %d)\n", result.url, len(result.content))
result.url, len(result.content)) scrapedContent[result.url] = result.content
scrapedContent[result.url] = struct {
content string
site SiteConfig
}{
content: result.content,
site: result.site,
}
} }
logger.Printf("Total URLs processed: %d\n", totalURLs) logger.Printf("Total URLs processed: %d\n", totalURLs)
logger.Printf("Successfully scraped content from %d URLs\n", len(scrapedContent)) logger.Printf("Successfully scraped content from %d URLs\n", len(scrapedContent))
return SaveToFiles(scrapedContent, config) return scrapedContent, nil
} }
func scrapeSingleURL(url string, site SiteConfig, results chan<- struct { func scrapeSingleURL(url string, site SiteConfig, results chan<- struct {
url string url string
content string content string
site SiteConfig
err error err error
}, limiter *rate.Limiter) { }, limiter *rate.Limiter, visited map[string]bool, currentDepth int) {
if site.MaxDepth > 0 && currentDepth > site.MaxDepth {
return
}
if visited[url] {
return
}
visited[url] = true
logger.Printf("Starting to scrape URL: %s\n", url) logger.Printf("Starting to scrape URL: %s\n", url)
// Wait for rate limiter before making the request
err := limiter.Wait(context.Background()) err := limiter.Wait(context.Background())
if err != nil { if err != nil {
logger.Printf("Rate limiter error for %s: %v\n", url, err)
results <- struct { results <- struct {
url string url string
content string content string
site SiteConfig
err error err error
}{url, "", site, fmt.Errorf("rate limiter error: %v", err)} }{url, "", fmt.Errorf("rate limiter error: %v", err)}
return
}
content, err := FetchWebpageContent(url)
if err != nil {
logger.Printf("Error fetching content for %s: %v\n", url, err)
results <- struct {
url string
content string
err error
}{url, "", err}
return
}
doc, err := goquery.NewDocumentFromReader(strings.NewReader(content))
if err != nil {
logger.Printf("Error parsing HTML for %s: %v\n", url, err)
results <- struct {
url string
content string
err error
}{url, "", fmt.Errorf("error parsing HTML: %v", err)}
return
}
if site.LinksContainerSelector != "" {
logger.Printf("Processing links container for %s\n", url)
linkContainers := doc.Find(site.LinksContainerSelector)
linkContainers.Each(func(i int, container *goquery.Selection) {
container.Find("a[href]").Each(func(j int, link *goquery.Selection) {
href, exists := link.Attr("href")
if exists {
resolvedURL := resolveURL(href, url)
if isAllowedURL(resolvedURL, site) && !visited[resolvedURL] {
go scrapeSingleURL(resolvedURL, site, results, limiter, visited, currentDepth+1)
}
}
})
})
return return
} }
cssLocator, excludeSelectors := getOverrides(url, site) cssLocator, excludeSelectors := getOverrides(url, site)
content, err := scrapeURL(url, cssLocator, excludeSelectors) logger.Printf("Using CSS locator for %s: %s\n", url, cssLocator)
logger.Printf("Exclude selectors for %s: %v\n", url, excludeSelectors)
extractedContent, err := ExtractContentWithCSS(content, cssLocator, excludeSelectors)
if err != nil { if err != nil {
logger.Printf("Error extracting content for %s: %v\n", url, err)
results <- struct { results <- struct {
url string url string
content string content string
site SiteConfig
err error err error
}{url, "", site, err} }{url, "", err}
return return
} }
if extractedContent == "" {
logger.Printf("Warning: Empty content scraped from %s\n", url)
} else {
logger.Printf("Successfully scraped content from %s (length: %d)\n", url, len(extractedContent))
}
results <- struct { results <- struct {
url string url string
content string content string
site SiteConfig
err error err error
}{url, content, site, nil} }{url, extractedContent, nil}
}
func scrapeSite(site SiteConfig, results chan<- struct {
url string
content string
err error
}, limiter *rate.Limiter,
) {
visited := make(map[string]bool)
queue := []string{site.BaseURL}
for len(queue) > 0 {
url := queue[0]
queue = queue[1:]
if visited[url] {
continue
}
visited[url] = true
if !isAllowedURL(url, site) {
continue
}
// Wait for rate limiter before making the request
err := limiter.Wait(context.Background())
if err != nil {
results <- struct {
url string
content string
err error
}{url, "", fmt.Errorf("rate limiter error: %v", err)}
continue
}
cssLocator, excludeSelectors := getOverrides(url, site)
content, err := scrapeURL(url, cssLocator, excludeSelectors)
results <- struct {
url string
content string
err error
}{url, content, err}
if len(visited) < site.MaxDepth {
links, _ := ExtractLinks(url)
for _, link := range links {
if !visited[link] && isAllowedURL(link, site) {
queue = append(queue, link)
}
}
}
}
} }
func isAllowedURL(urlStr string, site SiteConfig) bool { func isAllowedURL(urlStr string, site SiteConfig) bool {
@@ -175,18 +280,29 @@ func isAllowedURL(urlStr string, site SiteConfig) bool {
} }
path := parsedURL.Path path := parsedURL.Path
for _, allowedPath := range site.AllowedPaths {
if strings.HasPrefix(path, allowedPath) { // Check if the URL is within allowed paths
for _, excludePath := range site.ExcludePaths { if len(site.AllowedPaths) > 0 {
if strings.HasPrefix(path, excludePath) { allowed := false
return false for _, allowedPath := range site.AllowedPaths {
} if strings.HasPrefix(path, allowedPath) {
allowed = true
break
} }
return true }
if !allowed {
return false
} }
} }
return false // Check if the URL is in excluded paths
for _, excludePath := range site.ExcludePaths {
if strings.HasPrefix(path, excludePath) {
return false
}
}
return true
} }
func getOverrides(urlStr string, site SiteConfig) (string, []string) { func getOverrides(urlStr string, site SiteConfig) (string, []string) {
@@ -235,14 +351,9 @@ func getFilenameFromContent(content, url string) string {
} }
func sanitizeFilename(name string) string { func sanitizeFilename(name string) string {
// Replace all non-alphanumeric characters with dashes // Remove any character that isn't alphanumeric, dash, or underscore
reg := regexp.MustCompile("[^a-zA-Z0-9]+") reg, _ := regexp.Compile("[^a-zA-Z0-9-_]+")
name = reg.ReplaceAllString(name, "-") return reg.ReplaceAllString(name, "_")
// Remove any leading or trailing dashes
name = strings.Trim(name, "-")
// Collapse multiple consecutive dashes into one
reg = regexp.MustCompile("-+")
return reg.ReplaceAllString(name, "-")
} }
// URLConfig holds configuration for a single URL // URLConfig holds configuration for a single URL
@@ -250,7 +361,7 @@ type URLConfig struct {
URL string URL string
CSSLocator string CSSLocator string
ExcludeSelectors []string ExcludeSelectors []string
FileNamePrefix string OutputAlias string
} }
// SetupLogger initializes the logger based on the verbose flag // SetupLogger initializes the logger based on the verbose flag
@@ -278,7 +389,7 @@ func InitPlaywright() error {
return fmt.Errorf("could not start Playwright: %v", err) return fmt.Errorf("could not start Playwright: %v", err)
} }
userAgent := "Mozilla/5.0 (Linux; Android 15; Pixel 9 Build/AP3A.241105.008) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.6723.106 Mobile Safari/537.36 OPX/2.5" userAgent := "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"
browser, err = pw.Chromium.Launch(playwright.BrowserTypeLaunchOptions{ browser, err = pw.Chromium.Launch(playwright.BrowserTypeLaunchOptions{
Args: []string{fmt.Sprintf("--user-agent=%s", userAgent)}, Args: []string{fmt.Sprintf("--user-agent=%s", userAgent)},
@@ -311,119 +422,6 @@ func CloseBrowser() {
ClosePlaywright() ClosePlaywright()
} }
// SaveToFiles writes the scraped content to files based on output type
func SaveToFiles(content map[string]struct {
content string
site SiteConfig
}, config Config) error {
if config.OutputType == "" {
config.OutputType = "separate" // default to separate files if not specified
}
switch config.OutputType {
case "single":
if err := os.MkdirAll("output", 0755); err != nil {
return fmt.Errorf("failed to create output directory: %v", err)
}
var combined strings.Builder
for url, data := range content {
combined.WriteString(fmt.Sprintf("## %s\n\n", url))
combined.WriteString(data.content)
combined.WriteString("\n\n")
}
return os.WriteFile(filepath.Join("output", "combined.md"), []byte(combined.String()), 0644)
case "separate":
if err := os.MkdirAll("output", 0755); err != nil {
return fmt.Errorf("failed to create output directory: %v", err)
}
// Group content by site and path
contentBySitePath := make(map[string]map[string]string)
for urlStr, data := range content {
parsedURL, err := url.Parse(urlStr)
if err != nil {
logger.Printf("Warning: Could not parse URL %s: %v", urlStr, err)
continue
}
// Find matching allowed path for this URL
var matchingPath string
for _, path := range data.site.AllowedPaths {
if strings.HasPrefix(parsedURL.Path, path) {
matchingPath = path
break
}
}
if matchingPath == "" {
logger.Printf("Warning: No matching allowed path for URL %s", urlStr)
continue
}
siteKey := fmt.Sprintf("%s-%s", data.site.BaseURL, data.site.FileNamePrefix)
if contentBySitePath[siteKey] == nil {
contentBySitePath[siteKey] = make(map[string]string)
}
// Combine all content for the same path
if existing, exists := contentBySitePath[siteKey][matchingPath]; exists {
contentBySitePath[siteKey][matchingPath] = existing + "\n\n" + data.content
} else {
contentBySitePath[siteKey][matchingPath] = data.content
}
}
// Write files for each site and path
for siteKey, pathContent := range contentBySitePath {
for path, content := range pathContent {
parts := strings.SplitN(siteKey, "-", 2) // Split only on first hyphen
prefix := parts[1] // Get the FileNamePrefix part
if prefix == "" {
prefix = "doc" // default prefix if none specified
}
normalizedPath := NormalizePathForFilename(path)
if normalizedPath == "" {
normalizedPath = "index"
}
filename := filepath.Join("output", fmt.Sprintf("%s-%s.md",
prefix, normalizedPath))
// Ensure we don't have empty files
if strings.TrimSpace(content) == "" {
logger.Printf("Skipping empty content for path %s", path)
continue
}
if err := os.WriteFile(filename, []byte(content), 0644); err != nil {
return fmt.Errorf("failed to write file %s: %v", filename, err)
}
logger.Printf("Wrote content to %s", filename)
}
}
return nil
default:
return fmt.Errorf("unsupported output type: %s", config.OutputType)
}
}
// NormalizePathForFilename converts a URL path into a valid filename component
func NormalizePathForFilename(urlPath string) string {
// Remove leading/trailing slashes
path := strings.Trim(urlPath, "/")
// Replace all non-alphanumeric characters with dashes
reg := regexp.MustCompile("[^a-zA-Z0-9]+")
path = reg.ReplaceAllString(path, "-")
// Remove any leading or trailing dashes
path = strings.Trim(path, "-")
// Collapse multiple consecutive dashes into one
reg = regexp.MustCompile("-+")
path = reg.ReplaceAllString(path, "-")
return path
}
// FetchWebpageContent retrieves the content of a webpage using Playwright // FetchWebpageContent retrieves the content of a webpage using Playwright
func FetchWebpageContent(urlStr string) (string, error) { func FetchWebpageContent(urlStr string) (string, error) {
logger.Printf("Fetching webpage content for URL: %s\n", urlStr) logger.Printf("Fetching webpage content for URL: %s\n", urlStr)
@@ -462,7 +460,7 @@ func FetchWebpageContent(urlStr string) (string, error) {
} }
logger.Println("Waiting for body element") logger.Println("Waiting for body element")
bodyElement := page.Locator("body") bodyElement := page.Locator("body")
err = bodyElement.WaitFor(playwright.LocatorWaitForOptions{ err = bodyElement.WaitFor(playwright.LocatorWaitForOptions{
State: playwright.WaitForSelectorStateVisible, State: playwright.WaitForSelectorStateVisible,
@@ -534,6 +532,8 @@ func scrollPage(page playwright.Page) error {
() => { () => {
window.scrollTo(0, document.body.scrollHeight); window.scrollTo(0, document.body.scrollHeight);
return document.body.scrollHeight; return document.body.scrollHeight;
// wait for 500 ms
new Promise(resolve => setTimeout(resolve, 500));
} }
` `
@@ -565,8 +565,9 @@ func scrollPage(page playwright.Page) error {
previousHeight = currentHeight previousHeight = currentHeight
// Wait for content to load before scrolling again // Wait for a while before scrolling again
time.Sleep(100 * time.Millisecond)
} }
logger.Println("Scrolling back to top") logger.Println("Scrolling back to top")
@@ -580,6 +581,41 @@ func scrollPage(page playwright.Page) error {
return nil return nil
} }
// ExtractLinks extracts all links from the given URL
func ExtractLinks(urlStr string) ([]string, error) {
logger.Printf("Extracting links from URL: %s\n", urlStr)
page, err := browser.NewPage()
if err != nil {
return nil, fmt.Errorf("could not create page: %v", err)
}
defer page.Close()
if _, err = page.Goto(urlStr, playwright.PageGotoOptions{
WaitUntil: playwright.WaitUntilStateNetworkidle,
}); err != nil {
return nil, fmt.Errorf("could not go to page: %v", err)
}
links, err := page.Evaluate(`() => {
const anchors = document.querySelectorAll('a');
return Array.from(anchors).map(a => a.href);
}`)
if err != nil {
return nil, fmt.Errorf("could not extract links: %v", err)
}
var result []string
for _, link := range links.([]interface{}) {
// Normalize URL by removing trailing slash
normalizedLink := strings.TrimRight(link.(string), "/")
result = append(result, normalizedLink)
}
logger.Printf("Extracted %d links\n", len(result))
return result, nil
}
// ExtractContentWithCSS extracts content from HTML using a CSS selector // ExtractContentWithCSS extracts content from HTML using a CSS selector
func ExtractContentWithCSS(content, includeSelector string, excludeSelectors []string) (string, error) { func ExtractContentWithCSS(content, includeSelector string, excludeSelectors []string) (string, error) {
logger.Printf("Extracting content with CSS selector: %s\n", includeSelector) logger.Printf("Extracting content with CSS selector: %s\n", includeSelector)
@@ -627,3 +663,14 @@ func ExtractContentWithCSS(content, includeSelector string, excludeSelectors []s
logger.Printf("Extracted content length: %d\n", len(selectedContent)) logger.Printf("Extracted content length: %d\n", len(selectedContent))
return selectedContent, nil return selectedContent, nil
} }
func resolveURL(href, base string) string {
parsedBase, err := url.Parse(base)
if err != nil {
return href
}
parsedHref, err := url.Parse(href)
if err != nil {
return href
}
return parsedBase.ResolveReference(parsedHref).String()
}

View File

@@ -3,8 +3,8 @@ package scraper
import ( import (
"io" "io"
"log" "log"
// "net/http" "net/http"
// "net/http/httptest" "net/http/httptest"
"reflect" "reflect"
"strings" "strings"
"testing" "testing"
@@ -143,39 +143,39 @@ This is a **test** paragraph.
} }
} }
// func TestExtractLinks(t *testing.T) { func TestExtractLinks(t *testing.T) {
// // Initialize Playwright before running the test // Initialize Playwright before running the test
// if err := InitPlaywright(); err != nil { if err := InitPlaywright(); err != nil {
// t.Fatalf("Failed to initialize Playwright: %v", err) t.Fatalf("Failed to initialize Playwright: %v", err)
// } }
// defer ClosePlaywright() defer ClosePlaywright()
// server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// w.Header().Set("Content-Type", "text/html") w.Header().Set("Content-Type", "text/html")
// w.Write([]byte(` w.Write([]byte(`
// <html> <html>
// <body> <body>
// <a href="https://example.com/page1">Page 1</a> <a href="https://example.com/page1">Page 1</a>
// <a href="https://example.com/page2">Page 2</a> <a href="https://example.com/page2">Page 2</a>
// <a href="https://othersite.com">Other Site</a> <a href="https://othersite.com">Other Site</a>
// </body> </body>
// </html> </html>
// `)) `))
// })) }))
// defer server.Close() defer server.Close()
// links, err := ExtractLinks(server.URL) links, err := ExtractLinks(server.URL)
// if err != nil { if err != nil {
// t.Fatalf("ExtractLinks() returned error: %v", err) t.Fatalf("ExtractLinks() returned error: %v", err)
// } }
// expectedLinks := []string{ expectedLinks := []string{
// "https://example.com/page1", "https://example.com/page1",
// "https://example.com/page2", "https://example.com/page2",
// "https://othersite.com", "https://othersite.com",
// } }
// if !reflect.DeepEqual(links, expectedLinks) { if !reflect.DeepEqual(links, expectedLinks) {
// t.Errorf("ExtractLinks() = %v, want %v", links, expectedLinks) t.Errorf("ExtractLinks() = %v, want %v", links, expectedLinks)
// } }
// } }

31
main.go
View File

@@ -2,13 +2,42 @@ package main
import ( import (
"fmt" "fmt"
"log"
"os" "os"
"github.com/tnypxl/rollup/cmd" "github.com/tnypxl/rollup/cmd"
"github.com/tnypxl/rollup/internal/config"
"github.com/tnypxl/rollup/internal/scraper"
) )
var cfg *config.Config
func main() { func main() {
if err := cmd.Execute(); err != nil { // 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 := config.DefaultConfigPath()
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 {
fmt.Println(err) fmt.Println(err)
os.Exit(1) os.Exit(1)
} }