mirror of
https://github.com/tnypxl/rollup.git
synced 2025-12-15 15:03:17 +00:00
Compare commits
5 Commits
9341a51d09
...
claude/fix
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
52c326eed1 | ||
|
|
ff13012408 | ||
|
|
877a7876c0 | ||
|
|
09608cf073 | ||
|
|
7569aff6ec |
53
CLAUDE.md
Normal file
53
CLAUDE.md
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
# 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
|
||||||
@@ -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")
|
filesCmd.Flags().StringVarP(&fileTypes, "types", "t", "go,md,txt", "Comma-separated list of file extensions to include (without leading dot)")
|
||||||
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")
|
||||||
}
|
}
|
||||||
|
|||||||
32
cmd/root.go
32
cmd/root.go
@@ -1,8 +1,10 @@
|
|||||||
package cmd
|
package cmd
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"log"
|
||||||
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
config "github.com/tnypxl/rollup/internal/config"
|
"github.com/tnypxl/rollup/internal/config"
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
@@ -15,13 +17,31 @@ 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(conf *config.Config) error {
|
func Execute() 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()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
103
cmd/web.go
103
cmd/web.go
@@ -28,7 +28,19 @@ 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.`,
|
||||||
RunE: runWeb,
|
PreRunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
// 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() {
|
||||||
@@ -144,95 +156,6 @@ func runWeb(cmd *cobra.Command, args []string) error {
|
|||||||
return nil
|
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) {
|
func getFilenameFromContent(content, urlStr string) (string, error) {
|
||||||
// Try to extract title from content
|
// Try to extract title from content
|
||||||
titleStart := strings.Index(content, "<title>")
|
titleStart := strings.Index(content, "<title>")
|
||||||
|
|||||||
@@ -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
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -88,6 +88,14 @@ func Load(configPath string) (*Config, error) {
|
|||||||
|
|
||||||
// Validate checks the configuration for any invalid values
|
// Validate checks the configuration for any invalid values
|
||||||
func (c *Config) Validate() error {
|
func (c *Config) Validate() error {
|
||||||
|
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 {
|
if c.RequestsPerSecond != nil && *c.RequestsPerSecond <= 0 {
|
||||||
return fmt.Errorf("requests_per_second must be positive")
|
return fmt.Errorf("requests_per_second must be positive")
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,8 +10,8 @@ func TestLoad(t *testing.T) {
|
|||||||
// Create a temporary config file
|
// Create a temporary config file
|
||||||
content := []byte(`
|
content := []byte(`
|
||||||
file_extensions:
|
file_extensions:
|
||||||
- .go
|
- go
|
||||||
- .md
|
- md
|
||||||
ignore_paths:
|
ignore_paths:
|
||||||
- "*.tmp"
|
- "*.tmp"
|
||||||
- "**/*.log"
|
- "**/*.log"
|
||||||
@@ -27,7 +27,7 @@ sites:
|
|||||||
- "/blog"
|
- "/blog"
|
||||||
exclude_paths:
|
exclude_paths:
|
||||||
- "/admin"
|
- "/admin"
|
||||||
file_name_prefix: "example"
|
file_name_prefix: "example"
|
||||||
path_overrides:
|
path_overrides:
|
||||||
- path: "/special"
|
- path: "/special"
|
||||||
css_locator: ".special-content"
|
css_locator: ".special-content"
|
||||||
@@ -61,7 +61,7 @@ burst_limit: 5
|
|||||||
rps := 1.0
|
rps := 1.0
|
||||||
bl := 5
|
bl := 5
|
||||||
expectedConfig := &Config{
|
expectedConfig := &Config{
|
||||||
FileExtensions: []string{".go", ".md"},
|
FileExtensions: []string{"go", "md"},
|
||||||
IgnorePaths: []string{"*.tmp", "**/*.log"},
|
IgnorePaths: []string{"*.tmp", "**/*.log"},
|
||||||
CodeGeneratedPaths: []string{"generated_*.go"},
|
CodeGeneratedPaths: []string{"generated_*.go"},
|
||||||
Sites: []SiteConfig{
|
Sites: []SiteConfig{
|
||||||
@@ -100,7 +100,7 @@ func TestValidate(t *testing.T) {
|
|||||||
{
|
{
|
||||||
name: "Valid config",
|
name: "Valid config",
|
||||||
config: Config{
|
config: Config{
|
||||||
FileExtensions: []string{".go"},
|
FileExtensions: []string{"go"},
|
||||||
Sites: []SiteConfig{
|
Sites: []SiteConfig{
|
||||||
{BaseURL: "https://example.com"},
|
{BaseURL: "https://example.com"},
|
||||||
},
|
},
|
||||||
@@ -115,7 +115,7 @@ func TestValidate(t *testing.T) {
|
|||||||
{
|
{
|
||||||
name: "Invalid requests per second",
|
name: "Invalid requests per second",
|
||||||
config: Config{
|
config: Config{
|
||||||
FileExtensions: []string{".go"},
|
FileExtensions: []string{"go"},
|
||||||
RequestsPerSecond: func() *float64 { f := -1.0; return &f }(),
|
RequestsPerSecond: func() *float64 { f := -1.0; return &f }(),
|
||||||
},
|
},
|
||||||
wantErr: true,
|
wantErr: true,
|
||||||
@@ -123,7 +123,7 @@ func TestValidate(t *testing.T) {
|
|||||||
{
|
{
|
||||||
name: "Invalid burst limit",
|
name: "Invalid burst limit",
|
||||||
config: Config{
|
config: Config{
|
||||||
FileExtensions: []string{".go"},
|
FileExtensions: []string{"go"},
|
||||||
BurstLimit: func() *int { i := -1; return &i }(),
|
BurstLimit: func() *int { i := -1; return &i }(),
|
||||||
},
|
},
|
||||||
wantErr: true,
|
wantErr: true,
|
||||||
@@ -131,16 +131,32 @@ func TestValidate(t *testing.T) {
|
|||||||
{
|
{
|
||||||
name: "Site without base URL",
|
name: "Site without base URL",
|
||||||
config: Config{
|
config: Config{
|
||||||
FileExtensions: []string{".go"},
|
FileExtensions: []string{"go"},
|
||||||
Sites: []SiteConfig{{}},
|
Sites: []SiteConfig{{}},
|
||||||
},
|
},
|
||||||
wantErr: true,
|
wantErr: true,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "Negative max depth",
|
name: "Valid output type single",
|
||||||
config: Config{
|
config: Config{
|
||||||
FileExtensions: []string{".go"},
|
FileExtensions: []string{"go"},
|
||||||
Sites: []SiteConfig{{BaseURL: "https://example.com"}},
|
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,
|
wantErr: true,
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -74,6 +74,9 @@ func ScrapeSites(config Config) error {
|
|||||||
|
|
||||||
var wg sync.WaitGroup
|
var wg sync.WaitGroup
|
||||||
totalURLs := 0
|
totalURLs := 0
|
||||||
|
for _, site := range config.Sites {
|
||||||
|
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)
|
||||||
@@ -81,7 +84,6 @@ func ScrapeSites(config Config) error {
|
|||||||
defer wg.Done()
|
defer wg.Done()
|
||||||
for _, path := range site.AllowedPaths {
|
for _, path := range site.AllowedPaths {
|
||||||
fullURL := site.BaseURL + path
|
fullURL := site.BaseURL + path
|
||||||
totalURLs++
|
|
||||||
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)
|
||||||
}
|
}
|
||||||
@@ -532,8 +534,6 @@ 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,8 @@ func scrollPage(page playwright.Page) error {
|
|||||||
|
|
||||||
previousHeight = currentHeight
|
previousHeight = currentHeight
|
||||||
|
|
||||||
// Wait for a while before scrolling again
|
// Wait for content to load before scrolling again
|
||||||
|
time.Sleep(100 * time.Millisecond)
|
||||||
}
|
}
|
||||||
|
|
||||||
logger.Println("Scrolling back to top")
|
logger.Println("Scrolling back to top")
|
||||||
|
|||||||
31
main.go
31
main.go
@@ -2,42 +2,13 @@ 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() {
|
||||||
// Check if the command is "help"
|
if err := cmd.Execute(); err != nil {
|
||||||
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 {
|
|
||||||
fmt.Println(err)
|
fmt.Println(err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user