openreader-parser

Stars12

Forks3

UpdatedJuly 6, 2026 at 09:03

Parser and import guardrails for OpenReader book sources, CSS selectors, XPath-like rules, RSS, TXT/EPUB/PDF/Markdown/UMD imports, chapter catalogs, cache, and content cleanup.

Installation

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

Source

changshengyu

changshengyu/openreader

View GitHub Repository View Creator Repositories

Download

Related occupationsSOC

Based on SOC occupation classification

Software DevelopersComputer and Mathematical Occupations·SOC 15-1252

SKILL.md

readonly

name	openreader-parser
description	Parser and import guardrails for OpenReader book sources, CSS selectors, XPath-like rules, RSS, TXT/EPUB/PDF/Markdown/UMD imports, chapter catalogs, cache, and content cleanup.

OpenReader Parser

Use this skill when modifying source parsing, chapter parsing, import preview/import, RSS parsing, content cleanup, or cache generation.

Compatibility rules

Treat upstream reader-dev rules as semantic reference for book source fields and reader3-compatible APIs.
Preserve existing local book import data and staged import tokens.
Do not make catalog parsing depend on network speed once the file has been uploaded or staged.
Reparse/import flows should reuse staged data instead of requiring repeated uploads.

Remote source rules

CSS selector and rule changes must be covered by tests with fixture HTML.
Handle charset, headers, pagination, relative URLs, redirects, and empty results explicitly.
Remote requests must respect timeout, size limit, redirect limit, and safe scheme/host rules.
Do not let a single bad source block unrelated source searches.

Local import rules

TXT catalog detection must be deterministic for the same file and rule.
EPUB/ZIP-style formats must guard against zip-slip and decompression bombs.
PDF/UMD/TXT parsers must have size and time considerations; avoid unbounded reads into memory unless already bounded.
Preview errors should preserve enough staged context for the user to adjust rules and retry.

Required checks

Run targeted parser tests plus full backend tests:

cd backend && go test ./engine ./services/localbook ./api
cd backend && go test ./...

More from this repository

same repository

api-contract-compat

changshengyu/openreader

API compatibility workflow for OpenReader. Use when changing routes, Gin handlers, auth, request bodies, query parameters, response schemas, status codes, API errors, or frontend API clients.

2026-07-0612

booksource-parser-compat

changshengyu/openreader

Book source and parser compatibility workflow for OpenReader. Use when changing online sources, CSS selectors, XPath-like rules, RSS, chapter parsing, content cleaning, import preview/import, or local book parsing.

2026-07-0612

data-migration-compat

changshengyu/openreader

Data compatibility workflow for OpenReader. Use when changing GORM models, SQLite migrations, cache, library, uploads, local store, backup/restore, WebDAV storage, or persistent settings.

2026-07-0612

frontend-ux-compat

changshengyu/openreader

Frontend UX compatibility workflow for OpenReader. Use when changing Vue pages, routing, Pinia stores, reader UI, bookshelf, settings, import, WebDAV, sidebars, touch gestures, keyboard handling, or local persisted state.

2026-07-0612

openreader-backend

changshengyu/openreader

Backend architecture guardrails for OpenReader Go/Gin/GORM/SQLite changes. Use when modifying handlers, services, models, migrations, WebSocket sync, WebDAV, backup, imports, cache, or any backend API behavior.

2026-07-0612

openreader-docker-release

changshengyu/openreader

Local Docker release workflow for OpenReader. Use before building or publishing GHCR images, tagging releases, validating image metadata, or reporting Docker release progress.

2026-07-0612

name	openreader-parser
description	Parser and import guardrails for OpenReader book sources, CSS selectors, XPath-like rules, RSS, TXT/EPUB/PDF/Markdown/UMD imports, chapter catalogs, cache, and content cleanup.

OpenReader Parser

Use this skill when modifying source parsing, chapter parsing, import preview/import, RSS parsing, content cleanup, or cache generation.

Compatibility rules

Treat upstream reader-dev rules as semantic reference for book source fields and reader3-compatible APIs.
Preserve existing local book import data and staged import tokens.
Do not make catalog parsing depend on network speed once the file has been uploaded or staged.
Reparse/import flows should reuse staged data instead of requiring repeated uploads.

Remote source rules

CSS selector and rule changes must be covered by tests with fixture HTML.
Handle charset, headers, pagination, relative URLs, redirects, and empty results explicitly.
Remote requests must respect timeout, size limit, redirect limit, and safe scheme/host rules.
Do not let a single bad source block unrelated source searches.

Local import rules

TXT catalog detection must be deterministic for the same file and rule.
EPUB/ZIP-style formats must guard against zip-slip and decompression bombs.
PDF/UMD/TXT parsers must have size and time considerations; avoid unbounded reads into memory unless already bounded.
Preview errors should preserve enough staged context for the user to adjust rules and retry.

Required checks

Run targeted parser tests plus full backend tests:

cd backend && go test ./engine ./services/localbook ./api
cd backend && go test ./...