Skip to content

A USFM json Parser designed for use in Nodejs Applications

Notifications You must be signed in to change notification settings

unfoldingWord/usfm-js

 
 

Repository files navigation

usfm-js

Build Status npm npm codecov

This library takes in USFM text, and outputs it into a JSON format. It also takes JSON formatted scripture and outputs it into USFM.

Setup

npm install usfm-js

Usage

var usfm = require('usfm-js');
//Convert from USFM to JSON
var toJSON = usfm.toJSON(/**USFM Text**/);

//JSON to USFM
var toUSFM = usfm.toUSFM(toJSON, {forcedNewLines: true}); // if forcedNewLines is true, then USFM word and alignment markers will start on new line (defaults to false)

DOCUMENTATION

  • Expected format for usfm is standard \h \id \c \p \v
  • Expected format for JSON is the same as when exported from USFM
    •  {
         1:{
             1: "This is the first verse",
             2: "This is the second verse",
             ...
           },
          2:{
             1: "This is the first verse of the second chapter",
             2: "This is the second verse of the second chapter",
             ...
            }
       }

DEVELOPMENT

  • Make sure unit tests pass:

    • npm i
    • npm test

About

A USFM json Parser designed for use in Nodejs Applications

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%