https://github.com/chialab/epubchecker

Validation tool for ePub.
https://github.com/chialab/epubchecker

Last synced: about 2 months ago
JSON representation

Validation tool for ePub.

• Host: GitHub
• URL: https://github.com/chialab/epubchecker
• Owner: chialab
• License: mit
• Created: 2018-09-27T10:41:29.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2023-11-17T12:17:16.000Z (about 1 year ago)
• Last Synced: 2024-11-01T23:16:54.754Z (2 months ago)
• Language: JavaScript
• Size: 34.2 KB
• Stars: 11
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ePubChecker

Use [`epubcheck`](https://github.com/w3c/epubcheck) by W3C to get a validation report of an ePub.

[![npm](https://img.shields.io/npm/v/epubchecker.svg?style=flat-square)](https://www.npmjs.com/package/epubchecker)

## Usage

### Node API

Install the package:

```

npm install epubchecker

```

Require and use:

```js

const epubchecker = require('epubchecker');

const report = await epubchecker('public/the-little-prince.epub', {

    includeWarnings: true,

    // do not check CSS and font files

    exclude: /\.(css|ttf|opf|woff|woff2)$/,

});

```

#### Options

Here is a complete list of `epubchecker` options:

| Name | Type | Default | Description |

| ---- | ---- | ------- | ----------- |

| includeWarnings | `boolean` | `false` | Report should include warnings.     |

| includeNotices  | `boolean` | `false` | Report should include notices.      |

| output          | `string`  | `null`  | The path where to store the report. |

| ignore          | `RegExp`  | `null`  | Regex for messages to ignore.       |

| exclude         | `RegExp`  | `null`  | Regex for files to exclude.         |

| include         | `RegExp`  | `null`  | Regex for files to include.         |

### CLI

Install the CLI globally:

```sh

npm install epubchecker -g

```

Use the `epubchecker` in your terminal:

```

$ epubchecker --help

Usage: epubchecker [options] 

Options:

  -v, --version        output the version number

  -O, --output   store json report

  --no-warnings        remove warnings from report

  --no-notices         remove notices from report

  --ignore      regex for messages to ignore

  --exclude     regex for files to exclude

  --include     regex for files to include

  --silent             do not log errors

  -h, --help           output usage information

```