Skip to content

Commit

Permalink
Merge pull request #10 from johnie/v2
Browse files Browse the repository at this point in the history
V2
  • Loading branch information
johnie authored Feb 20, 2025
2 parents 12d73bc + 0e2374e commit ba1afd8
Show file tree
Hide file tree
Showing 23 changed files with 1,678 additions and 1,408 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
# xscrape

`xscrape` is a powerful and flexible library designed for extracting and
transforming data from HTML documents using user-defined schemas. It integrates
seamlessly with various schema validation libraries such as Zod, Yup, Joi, and
Effect Schema, allowing you to use your preferred validation tool.
`xscrape` is a powerful and flexible library designed for extracting and transforming data from HTML documents using user-defined schemas.

## Features

Expand All @@ -20,9 +17,9 @@ Effect Schema, allowing you to use your preferred validation tool.
| Schema Library | Status | Notes |
| ---------------------------------------------------- | ------------------- | ------------------------------------------------------------- |
| [Zod](https://github.com/colinhacks/zod) | ✅ Supported | Default schema tool for `xscrape` |
| [Effect/Schema](https://github.com/Effect-TS/effect) | ✅ Supported | Support for Effect/Schema for additional flexibility |
| [Joi](https://github.com/sideway/joi) | ✅ Supported | Support for Joi for validation |
| [Yup](https://github.com/jquense/yup) | ✅ Supported | Support for Yup for validation |
| [Effect/Schema](https://github.com/Effect-TS/effect) | 🔄 In Consideration | Support for Effect/Schema for additional flexibility |
| [Joi](https://github.com/sideway/joi) | 🔄 In Consideration | Support for Joi for validation |
| [Yup](https://github.com/jquense/yup) | 🔄 In Consideration | Support for Yup for validation |
| Others... | 🔄 In Consideration | Potential support for other schema tools as per user feedback |

## Installation
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

27 changes: 15 additions & 12 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "xscrape",
"version": "1.3.1",
"version": "2.0.0",
"description": "A flexible and powerful library designed to extract and transform data from HTML documents using user-defined schemas",
"main": "dist/index.js",
"exports": {
Expand All @@ -19,6 +19,7 @@
"ci": "npm run build && npm run check-format && npm run check-exports && npm run lint && npm run test",
"lint": "tsc",
"test": "vitest run",
"test:watch": "vitest",
"format": "prettier --write ./src",
"check-format": "prettier --check ./src",
"check-exports": "attw --pack .",
Expand Down Expand Up @@ -50,20 +51,22 @@
},
"homepage": "https://github.com/johnie/xscrape#readme",
"devDependencies": {
"@arethetypeswrong/cli": "^0.16.4",
"@changesets/changelog-github": "^0.5.0",
"@changesets/cli": "^2.27.9",
"prettier": "^3.3.3",
"tsup": "^8.3.5",
"typescript": "^5.6.3",
"vite": "^5.4.10",
"vitest": "^2.1.3"
"@arethetypeswrong/cli": "^0.17.3",
"@changesets/changelog-github": "^0.5.1",
"@changesets/cli": "^2.28.1",
"domhandler": "^5.0.3",
"jsdom": "^26.0.0",
"prettier": "^3.5.1",
"tsup": "^8.3.6",
"typescript": "^5.7.3",
"vite": "^6.1.1",
"vitest": "^3.0.6"
},
"dependencies": {
"cheerio": "^1.0.0",
"effect": "^3.10.4",
"effect": "^3.13.2",
"joi": "^17.13.3",
"yup": "^1.4.0",
"zod": "^3.23.8"
"yup": "^1.6.1",
"zod": "^3.24.2"
}
}
Loading

0 comments on commit ba1afd8

Please sign in to comment.