swift-readability

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #go #android #rust #deep-learning #linux #docker #java #windows #awesome #open-source

swift-readability

(★ 12)

No description available.

swift-readability Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# SwiftReadability

A Swift 6.2 port of Mozilla's Readability.js using SwiftSoup for DOM parsing.

## Requirements

- Swift 6.2
- iOS 15+, macOS 13+

## Installation (SwiftPM)

Add the package dependency:

```
.package(url: "https://github.com/lake-of-fire/swift-readability", from: "0.1.0")
```

Then add `SwiftReadability` to your target dependencies.

## Usage

Basic extraction:

```swift
import SwiftReadability

let reader = Readability(
    html: htmlString,
    url: URL(string: "https://example.com")!
)
let result = try reader.parse()
print(result?.title ?? "(no title)")
print(result?.contentHTML ?? "(no content)")
```

Custom serialization (mirrors Readability.js `serializer`):

```swift
let result = try reader.parse { element in
    // Return any type you want from the article content element.
    element
}
```

Readerable check:

```swift
let readerable = Readability.isProbablyReaderable(html: htmlString)
```

## Options

`ReadabilityOptions` mirrors Readability.js:

- `debug` (Bool)
- `maxElemsToParse` (Int)
- `nbTopCandidates` (Int)
- `charThreshold` (Int)
- `classesToPreserve` ([String])
- `keepClasses` (Bool)
- `serializer` ((Element) -> String)
- `useXMLSerializer` (Bool, defaults to `false` for parity with Readability.js). The test suite enables XML serialization explicitly to match Mozilla's fixture expectations for boolean attributes.
- `disableJSONLD` (Bool)
- `allowedVideoRegex` (NSRegularExpression)
- `linkDensityModifier` (Double)

## Parity notes

- Fixture parity: the fixture tests enable `useXMLSerializer: true` to preserve boolean attribute values (Mozilla fixtures expect `itemscope="itemscope"`).
- Live DOM: `Readability(document:)` operates directly on the passed `Document` (no reparse), matching JS behavior and improving performance.
- Serializer parity: default output uses HTML serialization (JS `innerHTML`), while XML serialization is available via `useXMLSerializer`.

## Tests

The test suite ports Mozilla's `test-readability.js` and `test-isProbablyReaderable.js`,
including the full fixture corpus under `Tests/SwiftReadabilityTests/Fixtures`.
Ported against `@mozilla/readability` **v0.6.0** (Readability.js) to keep behavior and fixtures aligned.

Run all tests:

```
mise run test:parity
```

If mise has not trusted this package config yet, run `mise trust` in this
directory first. From the app repository root, `mise run test:readability-parity`
runs the same parity suite without requiring the submodule config to be trusted.

Filter fixtures:

```
SWIFT_READABILITY_FIXTURES=nytimes-3 mise run test:parity
```

Run only the Swift suite:

```
mise run test:swift
```

Run only the JavaScript parity suite:

```
mise run test:javascript
```

The JavaScript suite uses `Sources/SwiftReadability/Resources/Readability.js`
and `Sources/SwiftReadability/Resources/Readability-readerable.js`. Both Swift
and JavaScript read `Tests/SwiftReadabilityTests/Fixtures/readability-suite.json`
for shared fixture settings. `SWIFT_READABILITY_FIXTURES` and
`SWIFT_READABILITY_FIXTURE_REGEX` can be used to run specific fixtures from the
shared Mozilla-format corpus.

Known JS-vs-Swift fixture divergences are listed in the shared manifest and are
skipped by default for the affected runner. Include them for parity investigation
with:

```
SWIFT_READABILITY_INCLUDE_KNOWN_FAILURES=1 SWIFT_READABILITY_FIXTURE_REGEX='.*' mise run test:javascript
```

## Benchmark

Run the local benchmark harness (fixtures-based):

```
swift run SwiftReadabilityBench --iterations 5 --warmup 1
```

swift-readability

swift-readability Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

swift-readability

swift-readability Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README