openbibleinfo / Bible-Passage-Reference-Parser

Coffeescript to identify and understand Bible references like "John 3:16."
223 stars 65 forks source link

Plans to release as npm module? #13

Closed bricejlin closed 9 years ago

bricejlin commented 9 years ago

Would love to be able to access over npm!

openbibleinfo commented 9 years ago

My hesitation with npm involves two separate but related issues: (1) All the "eu" scripts double the size of the download; and (2) All the different languages might make it confusing for someone to know which script to require in their project. Do you think I'm overthinking these problems?

bricejlin commented 9 years ago

What are the eu scripts for? You can put it in a .npmignore file so it won't get downloaded. And I'm sure people can figure it out, the readme is pretty clear

sortofbusy commented 9 years ago

Strong second on this; I've looked at Bible-parsing npm modules and none of them are as clear and well-documented as this one. Please consider it!

openbibleinfo commented 9 years ago

I'm tentatively planning on this in the November 2015 release.

jamlen commented 9 years ago

:+1: certainly for a node.js based application where I am not sending this to a browser, I am not that concerned about the package size.

openbibleinfo commented 9 years ago

I've published a first pass on npm here: https://www.npmjs.com/package/bible-passage-reference-parser

This is the first npm module I've created, so I'd appreciate any feedback before incorporating it into the Github repo in November.

To install:

npm install bible-passage-reference-parser

To run:

var bcv_parser = require("bible-passage-reference-parser/js/en_bcv_parser").bcv_parser;
var bcv = new bcv_parser;
bcv.parse("matt6:2").osis(); // "Matt.6.2"
sortofbusy commented 9 years ago

Awesome! I'll be working with it in the next few days and will let you know how it goes.

openbibleinfo commented 9 years ago

Version 1.0.0 is now released on npm.