scripture-utilities

[![Build Status][github-actions-status]][github-actions-url]
[![CodeQL][gitghub-codeql-status]][gitghub-codeql-url]
[![Github Tag][npm-version-image]][npm-version-url]

Utilities for working with Scripture data.

Features

For data that conforms to USX/USJ v3.1:

- USJ to USX converter.
- USX to USJ converter.

Install

``sh npm install @biblionexus-foundation/scripture-utilities`

`Usage`

`ts import { usxStringToUsj, usjToUsxString } from "@biblionexus-foundation/scripture-utilities";

const emptyUsx = ''; const usx =

World English Bible (WEB)
The Psalms

Blessed is the man who doesn’t walk in the counsel of the wicked,
nor stand on the path of sinners,
nor sit in the seat of scoffers;

;

const emptyUsj = usxStringToUsj(emptyUsx); const usj = usxStringToUsj(usx);

const newUsx = usjToUsxString(usj);`

`Building`

Run nx build utilities to build the library.

`Running unit tests`

Run nx test utilities to execute the unit tests via Jest.

`Develop in App`

To develop these utilities in a target application you can use yalc to link the editor in without having to publish to NPM every time something changes.

1. In this monorepo, publish the editor to yalc, e.g.:`bash nx devpub utilities`2. In the target application repo, link fromyalc:`bash yalc link @biblionexus-foundation/scripture-utilities`3. In this monorepo, make changes and re-publish the editor (see step 1). 4. When you have finished developing in the target application repo, unlink fromyalc:`bash yalc remove @biblionexus-foundation/scripture-utilities && npm i``

License

[MIT][github-license] © BiblioNexus Foundation

[github-actions-status]: https://github.com/BiblioNexus-Foundation/scripture-editors/actions/workflows/test-publish.yml/badge.svg
[github-actions-url]: https://github.com/BiblioNexus-Foundation/scripture-editors/actions
[gitghub-codeql-status]: https://github.com/BiblioNexus-Foundation/scripture-editors/actions/workflows/codeql.yml/badge.svg
[gitghub-codeql-url]: https://github.com/BiblioNexus-Foundation/scripture-editors/actions/workflows/codeql.yml
[npm-version-image]: https://img.shields.io/npm/v/@biblionexus-foundation/scripture-utilities
[npm-version-url]: https://github.com/BiblioNexus-Foundation/scripture-editors/releases
[github-license]: https://github.com/BiblioNexus-Foundation/scripture-editors/blob/main/packages/utilities/LICENSE

Usage

ts
import { usxStringToUsj, usjToUsxString } from "@biblionexus-foundation/scripture-utilities";

const emptyUsx = '';
const usx =

World English Bible (WEB)
The Psalms

Blessed is the man who doesn’t walk in the counsel of the wicked,
nor stand on the path of sinners,
nor sit in the seat of scoffers;

;

const emptyUsj = usxStringToUsj(emptyUsx);
const usj = usxStringToUsj(usx);

const newUsx = usjToUsxString(usj);

Develop in App

To develop these utilities in a target application you can use yalc to link the editor in without having to publish to NPM every time something changes.

1. In this monorepo, publish the editor to yalc

, e.g.:

bash
   nx devpub utilities


2. In the target application repo, link from

yalc

bash
   yalc link @biblionexus-foundation/scripture-utilities


3. In this monorepo, make changes and re-publish the editor (see step 1).
4. When you have finished developing in the target application repo, unlink from

yalc

bash
   yalc remove @biblionexus-foundation/scripture-utilities && npm i

License