{"id":20056259,"url":"https://github.com/chialab/epubchecker","last_synced_at":"2025-05-05T14:30:20.230Z","repository":{"id":57226467,"uuid":"150571237","full_name":"chialab/epubchecker","owner":"chialab","description":"Validation tool for ePub.","archived":false,"fork":false,"pushed_at":"2023-11-17T12:17:16.000Z","size":35,"stargazers_count":11,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-24T21:06:34.808Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chialab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-27T10:41:29.000Z","updated_at":"2024-04-29T18:27:58.000Z","dependencies_parsed_at":"2024-06-19T13:23:06.496Z","dependency_job_id":"c105cec0-29bf-4204-ad45-4c9c1a2fb96f","html_url":"https://github.com/chialab/epubchecker","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chialab%2Fepubchecker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chialab%2Fepubchecker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chialab%2Fepubchecker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chialab%2Fepubchecker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chialab","download_url":"https://codeload.github.com/chialab/epubchecker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252514721,"owners_count":21760421,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T12:52:56.257Z","updated_at":"2025-05-05T14:30:19.897Z","avatar_url":"https://github.com/chialab.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ePubChecker\n\nUse [`epubcheck`](https://github.com/w3c/epubcheck) by W3C to get a validation report of an ePub.\n\n\n[![npm](https://img.shields.io/npm/v/epubchecker.svg?style=flat-square)](https://www.npmjs.com/package/epubchecker)\n\n## Usage\n\n### Node API\n\nInstall the package:\n\n```\nnpm install epubchecker\n```\n\nRequire and use:\n\n```js\nconst epubchecker = require('epubchecker');\n\nconst report = await epubchecker('public/the-little-prince.epub', {\n    includeWarnings: true,\n    // do not check CSS and font files\n    exclude: /\\.(css|ttf|opf|woff|woff2)$/,\n});\n```\n\n#### Options\n\nHere is a complete list of `epubchecker` options:\n\n| Name | Type | Default | Description |\n| ---- | ---- | ------- | ----------- |\n| includeWarnings | `boolean` | `false` | Report should include warnings.     |\n| includeNotices  | `boolean` | `false` | Report should include notices.      |\n| output          | `string`  | `null`  | The path where to store the report. |\n| ignore          | `RegExp`  | `null`  | Regex for messages to ignore.       |\n| exclude         | `RegExp`  | `null`  | Regex for files to exclude.         |\n| include         | `RegExp`  | `null`  | Regex for files to include.         |\n\n\n### CLI\n\nInstall the CLI globally:\n```sh\nnpm install epubchecker -g\n```\n\nUse the `epubchecker` in your terminal:\n```\n$ epubchecker --help\nUsage: epubchecker [options] \u003cfile\u003e\n\nOptions:\n\n  -v, --version        output the version number\n  -O, --output \u003cpath\u003e  store json report\n  --no-warnings        remove warnings from report\n  --no-notices         remove notices from report\n  --ignore \u003cregex\u003e     regex for messages to ignore\n  --exclude \u003cregex\u003e    regex for files to exclude\n  --include \u003cregex\u003e    regex for files to include\n  --silent             do not log errors\n  -h, --help           output usage information\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchialab%2Fepubchecker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchialab%2Fepubchecker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchialab%2Fepubchecker/lists"}