mirror of
https://github.com/tnypxl/rollup.git
synced 2025-12-13 06:23:18 +00:00
Compare commits
13 Commits
v0.0.2
...
ff13012408
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ff13012408 | ||
|
|
09608cf073 | ||
|
|
7569aff6ec | ||
|
|
9341a51d09 | ||
|
|
9e9ac903e4 | ||
|
|
645626f763 | ||
|
|
02e39baf38 | ||
| 333b9a366c | |||
|
|
1869dae89a | ||
|
|
d3ff7cb862 | ||
|
|
ea410e4abb | ||
|
|
7d8e25b1ad | ||
|
|
691832e282 |
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
|
||||||
68
README.md
68
README.md
@@ -4,16 +4,18 @@ Rollup aggregates the contents of text-based files and webpages into a markdown
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- File type filtering
|
- File type filtering for targeted content aggregation
|
||||||
- Ignore patterns for excluding files
|
- Ignore patterns for excluding specific files or directories
|
||||||
- Support for code-generated file detection
|
- Support for code-generated file detection and exclusion
|
||||||
- Advanced web scraping functionality
|
- Advanced web scraping functionality with depth control
|
||||||
- Verbose logging option for detailed output
|
- Verbose logging option for detailed operation insights
|
||||||
- Exclusionary CSS selectors for web scraping
|
- Exclusionary CSS selectors for precise web content extraction
|
||||||
- Support for multiple URLs in web scraping
|
- Support for multiple URLs in web scraping operations
|
||||||
- Configurable output format for web scraping (single file or separate files)
|
- Configurable output format for web scraping (single file or separate files)
|
||||||
- Configuration file support (YAML)
|
- Flexible configuration file support (YAML)
|
||||||
- Generation of default configuration file
|
- Automatic generation of default configuration file
|
||||||
|
- Custom output file naming
|
||||||
|
- Rate limiting for web scraping to respect server resources
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@@ -64,24 +66,36 @@ Rollup can be configured using a YAML file. By default, it looks for `rollup.yml
|
|||||||
Example `rollup.yml`:
|
Example `rollup.yml`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
file_types:
|
file_extensions:
|
||||||
- go
|
- go
|
||||||
- md
|
- md
|
||||||
ignore:
|
ignore_paths:
|
||||||
- node_modules/**
|
- node_modules/**
|
||||||
- vendor/**
|
- vendor/**
|
||||||
- .git/**
|
- .git/**
|
||||||
code_generated:
|
code_generated_paths:
|
||||||
- **/generated/**
|
- **/generated/**
|
||||||
scrape:
|
sites:
|
||||||
urls:
|
- base_url: https://example.com
|
||||||
- url: https://example.com
|
css_locator: .content
|
||||||
css_locator: .content
|
exclude_selectors:
|
||||||
exclude_selectors:
|
- .ads
|
||||||
- .ads
|
- .navigation
|
||||||
- .navigation
|
max_depth: 2
|
||||||
output_alias: example
|
allowed_paths:
|
||||||
output_type: single
|
- /blog
|
||||||
|
- /docs
|
||||||
|
exclude_paths:
|
||||||
|
- /admin
|
||||||
|
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
|
||||||
@@ -111,10 +125,22 @@ scrape:
|
|||||||
```
|
```
|
||||||
|
|
||||||
5. Web scraping with separate output files:
|
5. Web scraping with separate output files:
|
||||||
|
|
||||||
```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
|
||||||
```
|
```
|
||||||
|
|
||||||
|
6. Rollup files with specific types and ignore patterns:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
rollup files --types=go,md --ignore=vendor/**,*_test.go
|
||||||
|
```
|
||||||
|
|
||||||
|
7. Web scraping with depth and CSS selector:
|
||||||
|
```bash
|
||||||
|
rollup web --urls=https://example.com --depth=2 --css=.main-content
|
||||||
|
```
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Contributions are welcome! Please feel free to submit a Pull Request.
|
Contributions are welcome! Please feel free to submit a Pull Request.
|
||||||
|
|||||||
66
cmd/files.go
66
cmd/files.go
@@ -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")
|
||||||
}
|
}
|
||||||
@@ -108,19 +108,20 @@ 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, codeGenList, ignoreList []string
|
var types []string
|
||||||
if cfg != nil && len(cfg.FileTypes) > 0 {
|
var codeGenList, ignoreList []string
|
||||||
types = cfg.FileTypes
|
if cfg != nil && len(cfg.FileExtensions) > 0 {
|
||||||
|
types = cfg.FileExtensions
|
||||||
} else {
|
} else {
|
||||||
types = strings.Split(fileTypes, ",")
|
types = strings.Split(fileTypes, ",")
|
||||||
}
|
}
|
||||||
if cfg != nil && len(cfg.CodeGenerated) > 0 {
|
if cfg != nil && len(cfg.CodeGeneratedPaths) > 0 {
|
||||||
codeGenList = cfg.CodeGenerated
|
codeGenList = cfg.CodeGeneratedPaths
|
||||||
} else {
|
} else {
|
||||||
codeGenList = strings.Split(codeGenPatterns, ",")
|
codeGenList = strings.Split(codeGenPatterns, ",")
|
||||||
}
|
}
|
||||||
if cfg != nil && cfg.Ignore != nil && len(cfg.Ignore) > 0 {
|
if cfg != nil && len(cfg.IgnorePaths) > 0 {
|
||||||
ignoreList = cfg.Ignore
|
ignoreList = cfg.IgnorePaths
|
||||||
} else {
|
} else {
|
||||||
ignoreList = strings.Split(ignorePatterns, ",")
|
ignoreList = strings.Split(ignorePatterns, ",")
|
||||||
}
|
}
|
||||||
@@ -145,6 +146,11 @@ 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 {
|
||||||
@@ -160,16 +166,25 @@ 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", path, err)
|
fmt.Printf("Error reading file %s: %v\n", path, err)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -185,12 +200,43 @@ 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)
|
||||||
}
|
}
|
||||||
|
|
||||||
fmt.Printf("Rollup complete. Output file: %s", outputFileName)
|
if showProgress {
|
||||||
|
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])
|
||||||
|
}
|
||||||
|
|||||||
@@ -67,7 +67,7 @@ func TestIsIgnored(t *testing.T) {
|
|||||||
{"subdir/file.log", true},
|
{"subdir/file.log", true},
|
||||||
{"subdir/file.txt", false},
|
{"subdir/file.txt", false},
|
||||||
{".git/config", true},
|
{".git/config", true},
|
||||||
{"src/.git/config", true},
|
{"src/.git/config", false},
|
||||||
{"vendor/package/file.go", true},
|
{"vendor/package/file.go", true},
|
||||||
{"internal/vendor/file.go", false},
|
{"internal/vendor/file.go", false},
|
||||||
}
|
}
|
||||||
@@ -112,9 +112,9 @@ func TestRunRollup(t *testing.T) {
|
|||||||
|
|
||||||
// Set up test configuration
|
// Set up test configuration
|
||||||
cfg = &config.Config{
|
cfg = &config.Config{
|
||||||
FileTypes: []string{"go", "txt", "md"},
|
FileExtensions: []string{"go", "txt", "md"},
|
||||||
Ignore: []string{"*.json", ".git/**", "vendor/**"},
|
IgnorePaths: []string{"*.json", ".git/**", "vendor/**"},
|
||||||
CodeGenerated: []string{"generated_*.go"},
|
CodeGeneratedPaths: []string{"generated_*.go"},
|
||||||
}
|
}
|
||||||
|
|
||||||
// Change working directory to the temp directory
|
// Change working directory to the temp directory
|
||||||
|
|||||||
@@ -38,23 +38,23 @@ func runGenerate(cmd *cobra.Command, args []string) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
cfg := config.Config{
|
cfg := config.Config{
|
||||||
FileTypes: make([]string, 0, len(fileTypes)),
|
FileExtensions: make([]string, 0, len(fileTypes)),
|
||||||
Ignore: []string{"node_modules/**", "vendor/**", ".git/**"},
|
IgnorePaths: []string{"node_modules/**", "vendor/**", ".git/**"},
|
||||||
}
|
}
|
||||||
|
|
||||||
for ext := range fileTypes {
|
for ext := range fileTypes {
|
||||||
cfg.FileTypes = append(cfg.FileTypes, ext)
|
cfg.FileExtensions = append(cfg.FileExtensions, ext)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Sort file types for consistency
|
// Sort file types for consistency
|
||||||
sort.Strings(cfg.FileTypes)
|
sort.Strings(cfg.FileExtensions)
|
||||||
|
|
||||||
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 := config.DefaultConfigPath()
|
outputPath := "rollup.yml"
|
||||||
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)
|
||||||
|
|||||||
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()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
299
cmd/web.go
299
cmd/web.go
@@ -2,7 +2,7 @@ package cmd
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"io/ioutil"
|
"io"
|
||||||
"log"
|
"log"
|
||||||
"net/url"
|
"net/url"
|
||||||
"os"
|
"os"
|
||||||
@@ -18,7 +18,6 @@ import (
|
|||||||
var (
|
var (
|
||||||
urls []string
|
urls []string
|
||||||
outputType string
|
outputType string
|
||||||
depth int
|
|
||||||
includeSelector string
|
includeSelector string
|
||||||
excludeSelectors []string
|
excludeSelectors []string
|
||||||
)
|
)
|
||||||
@@ -29,220 +28,132 @@ 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() {
|
||||||
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", "single", "Output type: 'single' for one file, 'separate' for multiple files")
|
webCmd.Flags().StringVarP(&outputType, "output", "o", "", "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 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(ioutil.Discard)
|
logger.SetOutput(io.Discard)
|
||||||
}
|
|
||||||
logger.Printf("Starting web scraping process with verbose mode: %v", verbose)
|
|
||||||
scraperConfig.Verbose = verbose
|
|
||||||
|
|
||||||
var siteConfigs []scraper.SiteConfig
|
|
||||||
if len(cfg.Scrape.Sites) > 0 {
|
|
||||||
logger.Printf("Using configuration from rollup.yml for %d sites", len(cfg.Scrape.Sites))
|
|
||||||
siteConfigs = make([]scraper.SiteConfig, len(cfg.Scrape.Sites))
|
|
||||||
for i, site := range cfg.Scrape.Sites {
|
|
||||||
siteConfigs[i] = scraper.SiteConfig{
|
|
||||||
BaseURL: site.BaseURL,
|
|
||||||
CSSLocator: site.CSSLocator,
|
|
||||||
ExcludeSelectors: site.ExcludeSelectors,
|
|
||||||
MaxDepth: site.MaxDepth,
|
|
||||||
AllowedPaths: site.AllowedPaths,
|
|
||||||
ExcludePaths: site.ExcludePaths,
|
|
||||||
OutputAlias: site.OutputAlias,
|
|
||||||
PathOverrides: convertPathOverrides(site.PathOverrides),
|
|
||||||
}
|
|
||||||
logger.Printf("Site %d configuration: BaseURL=%s, CSSLocator=%s, MaxDepth=%d, AllowedPaths=%v",
|
|
||||||
i+1, site.BaseURL, site.CSSLocator, site.MaxDepth, site.AllowedPaths)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
logger.Printf("No sites defined in rollup.yml, falling back to URL-based configuration")
|
|
||||||
siteConfigs = make([]scraper.SiteConfig, len(urls))
|
|
||||||
for i, u := range urls {
|
|
||||||
siteConfigs[i] = scraper.SiteConfig{
|
|
||||||
BaseURL: u,
|
|
||||||
CSSLocator: includeSelector,
|
|
||||||
ExcludeSelectors: excludeSelectors,
|
|
||||||
MaxDepth: depth,
|
|
||||||
}
|
|
||||||
logger.Printf("URL %d configuration: BaseURL=%s, CSSLocator=%s, MaxDepth=%d",
|
|
||||||
i+1, u, includeSelector, depth)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(siteConfigs) == 0 {
|
|
||||||
logger.Println("Error: No sites or URLs provided")
|
|
||||||
return fmt.Errorf("no sites or URLs provided. Use --urls flag with comma-separated URLs or set 'scrape.sites' in the rollup.yml file")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set default values for rate limiting
|
|
||||||
defaultRequestsPerSecond := 1.0
|
|
||||||
defaultBurstLimit := 3
|
|
||||||
|
|
||||||
// Use default values if not set in the configuration
|
|
||||||
requestsPerSecond := cfg.Scrape.RequestsPerSecond
|
|
||||||
if requestsPerSecond == 0 {
|
|
||||||
requestsPerSecond = defaultRequestsPerSecond
|
|
||||||
}
|
|
||||||
burstLimit := cfg.Scrape.BurstLimit
|
|
||||||
if burstLimit == 0 {
|
|
||||||
burstLimit = defaultBurstLimit
|
|
||||||
}
|
|
||||||
|
|
||||||
scraperConfig := scraper.Config{
|
|
||||||
Sites: siteConfigs,
|
|
||||||
OutputType: outputType,
|
|
||||||
Verbose: verbose,
|
|
||||||
Scrape: scraper.ScrapeConfig{
|
|
||||||
RequestsPerSecond: requestsPerSecond,
|
|
||||||
BurstLimit: burstLimit,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
logger.Printf("Scraper configuration: OutputType=%s, RequestsPerSecond=%f, BurstLimit=%d",
|
|
||||||
outputType, requestsPerSecond, burstLimit)
|
|
||||||
|
|
||||||
logger.Println("Starting scraping process")
|
|
||||||
scrapedContent, err := scraper.ScrapeSites(scraperConfig)
|
|
||||||
if err != nil {
|
|
||||||
logger.Printf("Error occurred during scraping: %v", err)
|
|
||||||
return fmt.Errorf("error scraping content: %v", err)
|
|
||||||
}
|
|
||||||
logger.Printf("Scraping completed. Total content scraped: %d", len(scrapedContent))
|
|
||||||
|
|
||||||
if outputType == "single" {
|
|
||||||
logger.Println("Writing content to a single file")
|
|
||||||
return writeSingleFile(scrapedContent)
|
|
||||||
} else {
|
|
||||||
logger.Println("Writing content to multiple files")
|
|
||||||
return writeMultipleFiles(scrapedContent)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
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()
|
logger.Printf("Starting web scraping process with verbose mode: %v", verbose)
|
||||||
|
scraperConfig.Verbose = verbose
|
||||||
|
|
||||||
for url, c := range content {
|
var siteConfigs []scraper.SiteConfig
|
||||||
_, err = fmt.Fprintf(file, "# Content from %s\n\n%s\n\n---\n\n", url, c)
|
if len(cfg.Sites) > 0 {
|
||||||
if err != nil {
|
logger.Printf("Using configuration from rollup.yml for %d sites", len(cfg.Sites))
|
||||||
return fmt.Errorf("error writing content to file: %v", err)
|
siteConfigs = make([]scraper.SiteConfig, len(cfg.Sites))
|
||||||
}
|
for i, site := range cfg.Sites {
|
||||||
}
|
siteConfigs[i] = scraper.SiteConfig{
|
||||||
|
BaseURL: site.BaseURL,
|
||||||
fmt.Printf("Content has been extracted from %d URL(s) and saved to %s\n", len(content), outputFile)
|
CSSLocator: site.CSSLocator,
|
||||||
return nil
|
ExcludeSelectors: site.ExcludeSelectors,
|
||||||
}
|
AllowedPaths: site.AllowedPaths,
|
||||||
|
ExcludePaths: site.ExcludePaths,
|
||||||
func writeMultipleFiles(content map[string]string) error {
|
PathOverrides: convertPathOverrides(site.PathOverrides),
|
||||||
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 scrapeRecursively(urlStr string, depth int) (string, error) {
|
|
||||||
visited := make(map[string]bool)
|
|
||||||
return scrapeURL(urlStr, depth, visited)
|
|
||||||
}
|
|
||||||
|
|
||||||
func scrapeURL(urlStr string, depth int, visited map[string]bool) (string, error) {
|
|
||||||
if depth < 0 || visited[urlStr] {
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
visited[urlStr] = true
|
|
||||||
|
|
||||||
content, err := testExtractAndConvertContent(urlStr)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
if depth > 0 {
|
|
||||||
links, err := testExtractLinks(urlStr)
|
|
||||||
if err != nil {
|
|
||||||
return content, fmt.Errorf("error extracting links: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, link := range links {
|
|
||||||
subContent, err := scrapeURL(link, depth-1, visited)
|
|
||||||
if err != nil {
|
|
||||||
fmt.Printf("Warning: Error scraping %s: %v\n", link, err)
|
|
||||||
continue
|
|
||||||
}
|
}
|
||||||
content += "\n\n---\n\n" + subContent
|
logger.Printf("Site %d configuration: BaseURL=%s, CSSLocator=%s, AllowedPaths=%v",
|
||||||
|
i+1, site.BaseURL, site.CSSLocator, site.AllowedPaths)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
logger.Printf("No sites defined in rollup.yml, falling back to URL-based configuration")
|
||||||
|
siteConfigs = make([]scraper.SiteConfig, len(urls))
|
||||||
|
for i, u := range urls {
|
||||||
|
siteConfigs[i] = scraper.SiteConfig{
|
||||||
|
BaseURL: u,
|
||||||
|
CSSLocator: includeSelector,
|
||||||
|
ExcludeSelectors: excludeSelectors,
|
||||||
|
}
|
||||||
|
logger.Printf("URL %d configuration: BaseURL=%s, CSSLocator=%s",
|
||||||
|
i+1, u, includeSelector)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return content, nil
|
if len(siteConfigs) == 0 {
|
||||||
}
|
logger.Println("Error: No sites or URLs provided")
|
||||||
|
return fmt.Errorf("no sites or URLs provided. Use --urls flag with comma-separated URLs or set 'scrape.sites' in the rollup.yml file")
|
||||||
var testExtractAndConvertContent = extractAndConvertContent
|
|
||||||
var testExtractLinks = scraper.ExtractLinks
|
|
||||||
|
|
||||||
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 != "" {
|
// Set default values for rate limiting
|
||||||
content, err = scraper.ExtractContentWithCSS(content, includeSelector, excludeSelectors)
|
defaultRequestsPerSecond := 1.0
|
||||||
if err != nil {
|
defaultBurstLimit := 3
|
||||||
return "", fmt.Errorf("error extracting content with CSS: %v", err)
|
|
||||||
|
// Use default values if not set in the configuration
|
||||||
|
requestsPerSecond := defaultRequestsPerSecond
|
||||||
|
if cfg.RequestsPerSecond != nil {
|
||||||
|
requestsPerSecond = *cfg.RequestsPerSecond
|
||||||
|
}
|
||||||
|
burstLimit := defaultBurstLimit
|
||||||
|
if cfg.BurstLimit != nil {
|
||||||
|
burstLimit = *cfg.BurstLimit
|
||||||
|
}
|
||||||
|
|
||||||
|
scraperConfig := scraper.Config{
|
||||||
|
Sites: siteConfigs,
|
||||||
|
OutputType: outputType,
|
||||||
|
Verbose: verbose,
|
||||||
|
Scrape: scraper.ScrapeConfig{
|
||||||
|
RequestsPerSecond: requestsPerSecond,
|
||||||
|
BurstLimit: burstLimit,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
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
|
||||||
|
|
||||||
markdown, err := scraper.ProcessHTMLContent(content, scraper.Config{})
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("error processing HTML content: %v", err)
|
logger.Printf("Error occurred during scraping: %v", err)
|
||||||
|
return fmt.Errorf("error scraping content: %v", err)
|
||||||
}
|
}
|
||||||
|
logger.Println("Scraping completed")
|
||||||
|
|
||||||
parsedURL, err := url.Parse(urlStr)
|
return nil
|
||||||
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) {
|
||||||
|
|||||||
@@ -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,58 +97,3 @@ func TestGetFilenameFromContent(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Mock functions for testing
|
|
||||||
func mockExtractAndConvertContent(urlStr string) (string, error) {
|
|
||||||
return "Mocked content for " + urlStr, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func mockExtractLinks(urlStr string) ([]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)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
21
docs/CHANGELOG.md
Normal file
21
docs/CHANGELOG.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
## [0.0.3] - 2024-09-22
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Implemented web scraping functionality using Playwright
|
||||||
|
- Added support for CSS selectors to extract specific content
|
||||||
|
- Introduced rate limiting for web requests
|
||||||
|
- Created configuration options for scraping settings
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Improved error handling and logging throughout the application
|
||||||
|
- Enhanced URL parsing and validation
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Resolved issues with concurrent scraping operations
|
||||||
@@ -7,35 +7,64 @@ import (
|
|||||||
"gopkg.in/yaml.v2"
|
"gopkg.in/yaml.v2"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Config represents the configuration for the rollup tool
|
||||||
type Config struct {
|
type Config struct {
|
||||||
FileTypes []string `yaml:"file_types"`
|
// FileExtensions is a list of file extensions to include in the rollup
|
||||||
Ignore []string `yaml:"ignore"`
|
FileExtensions []string `yaml:"file_extensions"`
|
||||||
CodeGenerated []string `yaml:"code_generated"`
|
|
||||||
Scrape ScrapeConfig `yaml:"scrape"`
|
// IgnorePaths is a list of glob patterns for paths to ignore
|
||||||
}
|
IgnorePaths []string `yaml:"ignore_paths"`
|
||||||
|
|
||||||
type ScrapeConfig struct {
|
// CodeGeneratedPaths is a list of glob patterns for code-generated files
|
||||||
Sites []SiteConfig `yaml:"sites"`
|
CodeGeneratedPaths []string `yaml:"code_generated_paths"`
|
||||||
OutputType string `yaml:"output_type"`
|
|
||||||
RequestsPerSecond float64 `yaml:"requests_per_second"`
|
// Sites is a list of site configurations for web scraping
|
||||||
BurstLimit int `yaml:"burst_limit"`
|
Sites []SiteConfig `yaml:"sites"`
|
||||||
|
|
||||||
|
// 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 string `yaml:"base_url"`
|
// BaseURL is the starting point for scraping this site
|
||||||
CSSLocator string `yaml:"css_locator"`
|
BaseURL string `yaml:"base_url"`
|
||||||
ExcludeSelectors []string `yaml:"exclude_selectors"`
|
|
||||||
MaxDepth int `yaml:"max_depth"`
|
// CSSLocator is used to extract specific content
|
||||||
AllowedPaths []string `yaml:"allowed_paths"`
|
CSSLocator string `yaml:"css_locator"`
|
||||||
ExcludePaths []string `yaml:"exclude_paths"`
|
|
||||||
OutputAlias string `yaml:"output_alias"`
|
// ExcludeSelectors lists CSS selectors for content to exclude
|
||||||
PathOverrides []PathOverride `yaml:"path_overrides"`
|
ExcludeSelectors []string `yaml:"exclude_selectors"`
|
||||||
|
|
||||||
|
// 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 string `yaml:"path"`
|
// Path is the URL path this override applies to
|
||||||
CSSLocator string `yaml:"css_locator"`
|
Path string `yaml:"path"`
|
||||||
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) {
|
||||||
@@ -50,15 +79,36 @@ 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 {
|
||||||
|
return nil, fmt.Errorf("invalid configuration: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
return &config, nil
|
return &config, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func DefaultConfigPath() string {
|
// Validate checks the configuration for any invalid values
|
||||||
return "rollup.yml"
|
func (c *Config) Validate() error {
|
||||||
}
|
if len(c.FileExtensions) == 0 && len(c.Sites) == 0 {
|
||||||
|
return fmt.Errorf("file_extensions or sites must be specified")
|
||||||
|
}
|
||||||
|
|
||||||
func FileExists(filename string) bool {
|
if c.OutputType != "" && c.OutputType != "single" && c.OutputType != "separate" {
|
||||||
_, err := os.Stat(filename)
|
return fmt.Errorf("output_type must be 'single' or 'separate'")
|
||||||
return err == nil
|
}
|
||||||
}
|
|
||||||
|
|
||||||
|
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
|
||||||
|
}
|
||||||
|
|||||||
@@ -9,34 +9,33 @@ 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_types:
|
file_extensions:
|
||||||
- go
|
- go
|
||||||
- md
|
- md
|
||||||
ignore:
|
ignore_paths:
|
||||||
- "*.tmp"
|
- "*.tmp"
|
||||||
- "**/*.log"
|
- "**/*.log"
|
||||||
code_generated:
|
code_generated_paths:
|
||||||
- "generated_*.go"
|
- "generated_*.go"
|
||||||
scrape:
|
sites:
|
||||||
sites:
|
- base_url: "https://example.com"
|
||||||
- base_url: "https://example.com"
|
css_locator: "main"
|
||||||
css_locator: "main"
|
exclude_selectors:
|
||||||
exclude_selectors:
|
- ".ads"
|
||||||
- ".ads"
|
max_depth: 2
|
||||||
max_depth: 2
|
allowed_paths:
|
||||||
allowed_paths:
|
- "/blog"
|
||||||
- "/blog"
|
exclude_paths:
|
||||||
exclude_paths:
|
- "/admin"
|
||||||
- "/admin"
|
file_name_prefix: "example"
|
||||||
output_alias: "example"
|
path_overrides:
|
||||||
path_overrides:
|
- path: "/special"
|
||||||
- path: "/special"
|
css_locator: ".special-content"
|
||||||
css_locator: ".special-content"
|
exclude_selectors:
|
||||||
exclude_selectors:
|
- ".sidebar"
|
||||||
- ".sidebar"
|
output_type: "single"
|
||||||
output_type: "single"
|
requests_per_second: 1.0
|
||||||
requests_per_second: 1.0
|
burst_limit: 5
|
||||||
burst_limit: 5
|
|
||||||
`)
|
`)
|
||||||
|
|
||||||
tmpfile, err := os.CreateTemp("", "config*.yml")
|
tmpfile, err := os.CreateTemp("", "config*.yml")
|
||||||
@@ -45,10 +44,10 @@ scrape:
|
|||||||
}
|
}
|
||||||
defer os.Remove(tmpfile.Name())
|
defer os.Remove(tmpfile.Name())
|
||||||
|
|
||||||
if _, err := tmpfile.Write(content); err != nil {
|
if _, err = tmpfile.Write(content); err != nil {
|
||||||
t.Fatalf("Failed to write to temp file: %v", err)
|
t.Fatalf("Failed to write to temp file: %v", err)
|
||||||
}
|
}
|
||||||
if err := tmpfile.Close(); err != nil {
|
if err = tmpfile.Close(); err != nil {
|
||||||
t.Fatalf("Failed to close temp file: %v", err)
|
t.Fatalf("Failed to close temp file: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -59,33 +58,32 @@ scrape:
|
|||||||
}
|
}
|
||||||
|
|
||||||
// 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{
|
||||||
FileTypes: []string{"go", "md"},
|
FileExtensions: []string{"go", "md"},
|
||||||
Ignore: []string{"*.tmp", "**/*.log"},
|
IgnorePaths: []string{"*.tmp", "**/*.log"},
|
||||||
CodeGenerated: []string{"generated_*.go"},
|
CodeGeneratedPaths: []string{"generated_*.go"},
|
||||||
Scrape: ScrapeConfig{
|
Sites: []SiteConfig{
|
||||||
Sites: []SiteConfig{
|
{
|
||||||
{
|
BaseURL: "https://example.com",
|
||||||
BaseURL: "https://example.com",
|
CSSLocator: "main",
|
||||||
CSSLocator: "main",
|
ExcludeSelectors: []string{".ads"},
|
||||||
ExcludeSelectors: []string{".ads"},
|
AllowedPaths: []string{"/blog"},
|
||||||
MaxDepth: 2,
|
ExcludePaths: []string{"/admin"},
|
||||||
AllowedPaths: []string{"/blog"},
|
FileNamePrefix: "example",
|
||||||
ExcludePaths: []string{"/admin"},
|
PathOverrides: []PathOverride{
|
||||||
OutputAlias: "example",
|
{
|
||||||
PathOverrides: []PathOverride{
|
Path: "/special",
|
||||||
{
|
CSSLocator: ".special-content",
|
||||||
Path: "/special",
|
ExcludeSelectors: []string{".sidebar"},
|
||||||
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) {
|
||||||
@@ -93,28 +91,83 @@ scrape:
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDefaultConfigPath(t *testing.T) {
|
func TestValidate(t *testing.T) {
|
||||||
expected := "rollup.yml"
|
tests := []struct {
|
||||||
result := DefaultConfigPath()
|
name string
|
||||||
if result != expected {
|
config Config
|
||||||
t.Errorf("DefaultConfigPath() = %q, want %q", result, expected)
|
wantErr bool
|
||||||
}
|
}{
|
||||||
}
|
{
|
||||||
|
name: "Valid config",
|
||||||
func TestFileExists(t *testing.T) {
|
config: Config{
|
||||||
// Test with an existing file
|
FileExtensions: []string{"go"},
|
||||||
tmpfile, err := os.CreateTemp("", "testfile")
|
Sites: []SiteConfig{
|
||||||
if err != nil {
|
{BaseURL: "https://example.com"},
|
||||||
t.Fatalf("Failed to create temp file: %v", err)
|
},
|
||||||
}
|
},
|
||||||
defer os.Remove(tmpfile.Name())
|
wantErr: false,
|
||||||
|
},
|
||||||
if !FileExists(tmpfile.Name()) {
|
{
|
||||||
t.Errorf("FileExists(%q) = false, want true", tmpfile.Name())
|
name: "No file extensions",
|
||||||
}
|
config: Config{},
|
||||||
|
wantErr: true,
|
||||||
// Test with a non-existing file
|
},
|
||||||
if FileExists("non_existing_file.txt") {
|
{
|
||||||
t.Errorf("FileExists(\"non_existing_file.txt\") = true, want false")
|
name: "Invalid requests per second",
|
||||||
|
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)
|
||||||
|
}
|
||||||
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,21 +1,22 @@
|
|||||||
package scraper
|
package scraper
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io/ioutil"
|
"io"
|
||||||
"log"
|
"log"
|
||||||
"math/rand"
|
"math/rand"
|
||||||
"net/url"
|
"net/url"
|
||||||
"os"
|
"os"
|
||||||
|
"path/filepath"
|
||||||
"regexp"
|
"regexp"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
|
||||||
"sync"
|
"sync"
|
||||||
"context"
|
"time"
|
||||||
|
|
||||||
|
md "github.com/JohannesKaufmann/html-to-markdown"
|
||||||
"github.com/PuerkitoBio/goquery"
|
"github.com/PuerkitoBio/goquery"
|
||||||
"github.com/playwright-community/playwright-go"
|
"github.com/playwright-community/playwright-go"
|
||||||
md "github.com/JohannesKaufmann/html-to-markdown"
|
|
||||||
"golang.org/x/time/rate"
|
"golang.org/x/time/rate"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -45,10 +46,9 @@ 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
|
||||||
OutputAlias string
|
FileNamePrefix string
|
||||||
PathOverrides []PathOverride
|
PathOverrides []PathOverride
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -59,209 +59,166 @@ type PathOverride struct {
|
|||||||
ExcludeSelectors []string
|
ExcludeSelectors []string
|
||||||
}
|
}
|
||||||
|
|
||||||
func ScrapeSites(config Config) (map[string]string, error) {
|
func ScrapeSites(config Config) 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
|
||||||
err error
|
site SiteConfig // Add site config to track which site the content came from
|
||||||
})
|
err error
|
||||||
|
})
|
||||||
|
|
||||||
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", config.Scrape.RequestsPerSecond, config.Scrape.BurstLimit)
|
logger.Printf("Rate limiter configured with %f requests per second and burst limit of %d\n",
|
||||||
|
config.Scrape.RequestsPerSecond, config.Scrape.BurstLimit)
|
||||||
|
|
||||||
var wg sync.WaitGroup
|
var wg sync.WaitGroup
|
||||||
totalURLs := 0
|
totalURLs := 0
|
||||||
for _, site := range config.Sites {
|
for _, site := range config.Sites {
|
||||||
logger.Printf("Processing site: %s\n", site.BaseURL)
|
totalURLs += len(site.AllowedPaths)
|
||||||
wg.Add(1)
|
}
|
||||||
go func(site SiteConfig) {
|
for _, site := range config.Sites {
|
||||||
defer wg.Done()
|
logger.Printf("Processing site: %s\n", site.BaseURL)
|
||||||
for _, path := range site.AllowedPaths {
|
wg.Add(1)
|
||||||
fullURL := site.BaseURL + path
|
go func(site SiteConfig) {
|
||||||
totalURLs++
|
defer wg.Done()
|
||||||
logger.Printf("Queueing URL for scraping: %s\n", fullURL)
|
for _, path := range site.AllowedPaths {
|
||||||
scrapeSingleURL(fullURL, site, config, results, limiter)
|
fullURL := site.BaseURL + path
|
||||||
}
|
logger.Printf("Queueing URL for scraping: %s\n", fullURL)
|
||||||
}(site)
|
scrapeSingleURL(fullURL, site, results, limiter)
|
||||||
}
|
}
|
||||||
|
}(site)
|
||||||
|
}
|
||||||
|
|
||||||
go func() {
|
go func() {
|
||||||
wg.Wait()
|
wg.Wait()
|
||||||
close(results)
|
close(results)
|
||||||
logger.Println("All goroutines completed, results channel closed")
|
logger.Println("All goroutines completed, results channel closed")
|
||||||
}()
|
}()
|
||||||
|
|
||||||
scrapedContent := make(map[string]string)
|
// Use a map that includes site configuration
|
||||||
for result := range results {
|
scrapedContent := make(map[string]struct {
|
||||||
if result.err != nil {
|
content string
|
||||||
logger.Printf("Error scraping %s: %v\n", result.url, result.err)
|
site SiteConfig
|
||||||
continue
|
})
|
||||||
}
|
|
||||||
logger.Printf("Successfully scraped content from %s (length: %d)\n", result.url, len(result.content))
|
|
||||||
scrapedContent[result.url] = result.content
|
|
||||||
}
|
|
||||||
|
|
||||||
logger.Printf("Total URLs processed: %d\n", totalURLs)
|
for result := range results {
|
||||||
logger.Printf("Successfully scraped content from %d URLs\n", len(scrapedContent))
|
if result.err != nil {
|
||||||
|
logger.Printf("Error scraping %s: %v\n", result.url, result.err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
logger.Printf("Successfully scraped content from %s (length: %d)\n",
|
||||||
|
result.url, len(result.content))
|
||||||
|
scrapedContent[result.url] = struct {
|
||||||
|
content string
|
||||||
|
site SiteConfig
|
||||||
|
}{
|
||||||
|
content: result.content,
|
||||||
|
site: result.site,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
return scrapedContent, nil
|
logger.Printf("Total URLs processed: %d\n", totalURLs)
|
||||||
|
logger.Printf("Successfully scraped content from %d URLs\n", len(scrapedContent))
|
||||||
|
|
||||||
|
return SaveToFiles(scrapedContent, config)
|
||||||
}
|
}
|
||||||
|
|
||||||
func scrapeSingleURL(url string, site SiteConfig, config Config, results chan<- struct {
|
func scrapeSingleURL(url string, site SiteConfig, results chan<- struct {
|
||||||
url string
|
url string
|
||||||
content string
|
content string
|
||||||
err error
|
site SiteConfig
|
||||||
|
err error
|
||||||
}, limiter *rate.Limiter) {
|
}, limiter *rate.Limiter) {
|
||||||
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 {
|
results <- struct {
|
||||||
logger.Printf("Rate limiter error for %s: %v\n", url, err)
|
url string
|
||||||
results <- struct {
|
content string
|
||||||
url string
|
site SiteConfig
|
||||||
content string
|
err error
|
||||||
err error
|
}{url, "", site, fmt.Errorf("rate limiter error: %v", err)}
|
||||||
}{url, "", fmt.Errorf("rate limiter error: %v", err)}
|
return
|
||||||
return
|
}
|
||||||
}
|
|
||||||
|
|
||||||
cssLocator, excludeSelectors := getOverrides(url, site)
|
cssLocator, excludeSelectors := getOverrides(url, site)
|
||||||
logger.Printf("Using CSS locator for %s: %s\n", url, cssLocator)
|
content, err := scrapeURL(url, cssLocator, excludeSelectors)
|
||||||
logger.Printf("Exclude selectors for %s: %v\n", url, excludeSelectors)
|
if err != nil {
|
||||||
|
results <- struct {
|
||||||
|
url string
|
||||||
|
content string
|
||||||
|
site SiteConfig
|
||||||
|
err error
|
||||||
|
}{url, "", site, err}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
content, err := scrapeURL(url, cssLocator, excludeSelectors)
|
results <- struct {
|
||||||
if err != nil {
|
url string
|
||||||
logger.Printf("Error scraping %s: %v\n", url, err)
|
content string
|
||||||
results <- struct {
|
site SiteConfig
|
||||||
url string
|
err error
|
||||||
content string
|
}{url, content, site, nil}
|
||||||
err error
|
|
||||||
}{url, "", err}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if content == "" {
|
|
||||||
logger.Printf("Warning: Empty content scraped from %s\n", url)
|
|
||||||
} else {
|
|
||||||
logger.Printf("Successfully scraped content from %s (length: %d)\n", url, len(content))
|
|
||||||
}
|
|
||||||
|
|
||||||
results <- struct {
|
|
||||||
url string
|
|
||||||
content string
|
|
||||||
err error
|
|
||||||
}{url, content, nil}
|
|
||||||
}
|
|
||||||
|
|
||||||
func scrapeSite(site SiteConfig, config Config, 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 {
|
||||||
parsedURL, err := url.Parse(urlStr)
|
parsedURL, err := url.Parse(urlStr)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
baseURL, _ := url.Parse(site.BaseURL)
|
baseURL, _ := url.Parse(site.BaseURL)
|
||||||
if parsedURL.Host != baseURL.Host {
|
if parsedURL.Host != baseURL.Host {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
path := parsedURL.Path
|
path := parsedURL.Path
|
||||||
for _, allowedPath := range site.AllowedPaths {
|
for _, allowedPath := range site.AllowedPaths {
|
||||||
if strings.HasPrefix(path, allowedPath) {
|
if strings.HasPrefix(path, allowedPath) {
|
||||||
for _, excludePath := range site.ExcludePaths {
|
for _, excludePath := range site.ExcludePaths {
|
||||||
if strings.HasPrefix(path, excludePath) {
|
if strings.HasPrefix(path, excludePath) {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
func getOverrides(urlStr string, site SiteConfig) (string, []string) {
|
func getOverrides(urlStr string, site SiteConfig) (string, []string) {
|
||||||
parsedURL, _ := url.Parse(urlStr)
|
parsedURL, _ := url.Parse(urlStr)
|
||||||
path := parsedURL.Path
|
path := parsedURL.Path
|
||||||
|
|
||||||
for _, override := range site.PathOverrides {
|
for _, override := range site.PathOverrides {
|
||||||
if strings.HasPrefix(path, override.Path) {
|
if strings.HasPrefix(path, override.Path) {
|
||||||
if override.CSSLocator != "" {
|
if override.CSSLocator != "" {
|
||||||
return override.CSSLocator, override.ExcludeSelectors
|
return override.CSSLocator, override.ExcludeSelectors
|
||||||
}
|
}
|
||||||
return site.CSSLocator, override.ExcludeSelectors
|
return site.CSSLocator, override.ExcludeSelectors
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return site.CSSLocator, site.ExcludeSelectors
|
return site.CSSLocator, site.ExcludeSelectors
|
||||||
}
|
}
|
||||||
|
|
||||||
func scrapeURL(url, cssLocator string, excludeSelectors []string) (string, error) {
|
func scrapeURL(url, cssLocator string, excludeSelectors []string) (string, error) {
|
||||||
content, err := FetchWebpageContent(url)
|
content, err := FetchWebpageContent(url)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
|
|
||||||
if cssLocator != "" {
|
if cssLocator != "" {
|
||||||
content, err = ExtractContentWithCSS(content, cssLocator, excludeSelectors)
|
content, err = ExtractContentWithCSS(content, cssLocator, excludeSelectors)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return ProcessHTMLContent(content, Config{})
|
return ProcessHTMLContent(content, Config{})
|
||||||
}
|
}
|
||||||
|
|
||||||
func getFilenameFromContent(content, url string) string {
|
func getFilenameFromContent(content, url string) string {
|
||||||
@@ -278,9 +235,14 @@ func getFilenameFromContent(content, url string) string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func sanitizeFilename(name string) string {
|
func sanitizeFilename(name string) string {
|
||||||
// Remove any character that isn't alphanumeric, dash, or underscore
|
// Replace all non-alphanumeric characters with dashes
|
||||||
reg, _ := regexp.Compile("[^a-zA-Z0-9-_]+")
|
reg := regexp.MustCompile("[^a-zA-Z0-9]+")
|
||||||
return reg.ReplaceAllString(name, "_")
|
name = 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
|
||||||
@@ -288,7 +250,7 @@ type URLConfig struct {
|
|||||||
URL string
|
URL string
|
||||||
CSSLocator string
|
CSSLocator string
|
||||||
ExcludeSelectors []string
|
ExcludeSelectors []string
|
||||||
OutputAlias string
|
FileNamePrefix string
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetupLogger initializes the logger based on the verbose flag
|
// SetupLogger initializes the logger based on the verbose flag
|
||||||
@@ -296,7 +258,7 @@ func SetupLogger(verbose bool) {
|
|||||||
if verbose {
|
if verbose {
|
||||||
logger = log.New(os.Stdout, "SCRAPER: ", log.LstdFlags)
|
logger = log.New(os.Stdout, "SCRAPER: ", log.LstdFlags)
|
||||||
} else {
|
} else {
|
||||||
logger = log.New(ioutil.Discard, "", 0)
|
logger = log.New(io.Discard, "", 0)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -316,7 +278,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 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"
|
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"
|
||||||
|
|
||||||
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)},
|
||||||
@@ -349,6 +311,119 @@ 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)
|
||||||
@@ -387,7 +462,9 @@ func FetchWebpageContent(urlStr string) (string, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
logger.Println("Waiting for body element")
|
logger.Println("Waiting for body element")
|
||||||
_, err = page.WaitForSelector("body", playwright.PageWaitForSelectorOptions{
|
|
||||||
|
bodyElement := page.Locator("body")
|
||||||
|
err = bodyElement.WaitFor(playwright.LocatorWaitForOptions{
|
||||||
State: playwright.WaitForSelectorStateVisible,
|
State: playwright.WaitForSelectorStateVisible,
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -404,7 +481,7 @@ func FetchWebpageContent(urlStr string) (string, error) {
|
|||||||
|
|
||||||
if content == "" {
|
if content == "" {
|
||||||
logger.Println(" content is empty, falling back to body content")
|
logger.Println(" content is empty, falling back to body content")
|
||||||
content, err = page.InnerHTML("body")
|
content, err = bodyElement.InnerHTML()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
logger.Printf("Error getting body content: %v\n", err)
|
logger.Printf("Error getting body content: %v\n", err)
|
||||||
return "", fmt.Errorf("could not get body content: %v", err)
|
return "", fmt.Errorf("could not get body content: %v", err)
|
||||||
@@ -488,7 +565,8 @@ func scrollPage(page playwright.Page) error {
|
|||||||
|
|
||||||
previousHeight = currentHeight
|
previousHeight = currentHeight
|
||||||
|
|
||||||
page.WaitForTimeout(500)
|
// 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")
|
||||||
@@ -502,41 +580,6 @@ 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)
|
||||||
|
|||||||
@@ -1,13 +1,13 @@
|
|||||||
package scraper
|
package scraper
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"testing"
|
"io"
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"strings"
|
|
||||||
"reflect"
|
|
||||||
"log"
|
"log"
|
||||||
"io/ioutil"
|
// "net/http"
|
||||||
|
// "net/http/httptest"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestIsAllowedURL(t *testing.T) {
|
func TestIsAllowedURL(t *testing.T) {
|
||||||
@@ -51,9 +51,9 @@ func TestGetOverrides(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
url string
|
url string
|
||||||
expectedLocator string
|
expectedLocator string
|
||||||
expectedExcludes []string
|
expectedExcludes []string
|
||||||
}{
|
}{
|
||||||
{"https://example.com/normal", "main", []string{".ads"}},
|
{"https://example.com/normal", "main", []string{".ads"}},
|
||||||
{"https://example.com/special", ".special-content", []string{".sidebar"}},
|
{"https://example.com/special", ".special-content", []string{".sidebar"}},
|
||||||
@@ -73,7 +73,7 @@ func TestGetOverrides(t *testing.T) {
|
|||||||
|
|
||||||
func TestExtractContentWithCSS(t *testing.T) {
|
func TestExtractContentWithCSS(t *testing.T) {
|
||||||
// Initialize logger for testing
|
// Initialize logger for testing
|
||||||
logger = log.New(ioutil.Discard, "", 0)
|
logger = log.New(io.Discard, "", 0)
|
||||||
|
|
||||||
html := `
|
html := `
|
||||||
<html>
|
<html>
|
||||||
@@ -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
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 := 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)
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user