# proskomma-json-tools

> Tools for working with Proskomma-derived formats such as PERF and SOFRIA

Latest version **0.9.1** (published 2025-09-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install proskomma-json-tools
pnpm add proskomma-json-tools
yarn add proskomma-json-tools
bun add proskomma-json-tools
```

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.9.1 |
| Published | 2025-09-16 |
| First published | 2022-06-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 325.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Mark Howe |
| Maintainers | mvahowe, danielc-n, gabrielaillet |

## Links

- npm: https://www.npmjs.com/package/proskomma-json-tools
- Repository: https://github.com/Proskomma/proskomma-json-tools
- Homepage: https://github.com/Proskomma/proskomma-json-tools#readme
- Issues: https://github.com/Proskomma/proskomma-json-tools/issues
- npm.io page: https://npm.io/package/proskomma-json-tools

## Dependencies (7)

- [ajv](https://npm.io/package/ajv.md) ^8.12.0
- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.12
- [usfm-js](https://npm.io/package/usfm-js.md) ^3.4.2
- [xregexp](https://npm.io/package/xregexp.md) ^5.1.1
- [deep-equal](https://npm.io/package/deep-equal.md) ^2.2.2
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.23.2
- [@babel/plugin-proposal-throw-expressions](https://npm.io/package/@babel/plugin-proposal-throw-expressions.md) ^7.22.5

## Recent versions

- 0.9.1 (latest) — 2025-09-16
- 0.9.0 — 2025-04-08
- 0.8.21 — 2024-08-30
- 0.8.20 — 2024-08-16
- 0.8.19 — 2024-08-12
- 0.8.18 — 2024-08-12
- 0.8.17 — 2024-08-09
- 0.8.16 — 2024-07-10
- 0.8.15 — 2024-07-10
- 0.8.14 — 2024-07-10
- 0.8.13 — 2024-07-10
- 0.8.12 — 2024-07-01
- 0.8.11 — 2024-06-24
- 0.8.10 — 2024-05-22
- 0.8.9 — 2024-05-20
- … 60 more at https://npm.io/package/proskomma-json-tools/versions

## README

# proskomma-json-tools
Tools for working with Proskomma-derived JSON formats such as PERF and SOFRIA

## Usage
```
npm install proskomma-json-tools
import {perfToUsfm} from 'proskomma-json-tools';
// ...
const usfm = perfToUsfm(perf);
```
## Generate Schema Documentation
Using the Python json schema generator https://github.com/coveooss/json-schema-for-humans :
```
generate-schema-doc src/schema/combined/0_2_1/perf_document_combined.json doc/schema/perf.html
generate-schema-doc src/schema/combined/0_2_1/sofria_document_combined.json doc/schema/sofria.html
```

---
_Source: https://npm.io/package/proskomma-json-tools · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._