chapter-and-verse - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

index.js

@@ -1,7 +0,7 @@
-const example = require('./js/example')
+const cv = require('./js/cv')
 
-const main = () => {
-  return example()
+const main = str => {
+  return cv(str)
 }
 
 module.exports = main

package.json

 {
   "name": "chapter-and-verse",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Given a string returns an object with the bible book, chapter and verse",
@@ -19,2 +19,3 @@ "author": "danday74",
     "chai": "^4.1.2",
+    "chai-subset": "^1.6.0",
     "coveralls": "2.11.16",
@@ -27,3 +28,11 @@ "eslint": "^4.17.0",
   },
-  "comment": "coveralls@2.11.16"
+  "comment": "coveralls@2.11.16",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/danday74/chapter-and-verse.git"
+  },
+  "bugs": {
+    "url": "https://github.com/danday74/chapter-and-verse/issues"
+  },
+  "homepage": "https://github.com/danday74/chapter-and-verse#readme"
 }

README.md

 # chapter-and-verse
 
-[![Linux Build](https://img.shields.io/travis/danday74/chapter-and-verse/master.svg?label=linux)](https://travis-ci.org/danday74/chapter-and-verse)
-[![Coverage Status](https://coveralls.io/repos/github/danday74/chapter-and-verse/badge.svg)](https://coveralls.io/github/danday74/chapter-and-verse)
+[![build](https://img.shields.io/travis/danday74/chapter-and-verse/master.svg?label=linux)](https://travis-ci.org/danday74/chapter-and-verse)
+[![coverage](https://coveralls.io/repos/github/danday74/chapter-and-verse/badge.svg)](https://coveralls.io/github/danday74/chapter-and-verse)
 [![npm](https://img.shields.io/npm/v/chapter-and-verse.svg)](https://www.npmjs.com/package/chapter-and-verse)
-[![Dependencies Status](https://david-dm.org/danday74/chapter-and-verse/status.svg)](https://david-dm.org/danday74/chapter-and-verse)
-[![npm](https://img.shields.io/npm/dm/chapter-and-verse.svg)](https://www.npmjs.com/package/chapter-and-verse)
+[![dependencies](https://david-dm.org/danday74/chapter-and-verse/status.svg)](https://david-dm.org/danday74/chapter-and-verse)
+[![downloads](https://img.shields.io/npm/dm/chapter-and-verse.svg)](https://www.npmjs.com/package/chapter-and-verse)
 
 **Given a string returns an object with the bible book, chapter and verse**
+
+
+
+<br>
+
+## Introduction
+
+Throw a bible reference at `chapter-and-verse` and it returns a detailed JSON object for that reference.
+
+`chapter-and-verse` understands all common bible book abbreviations and more.
+
+It is particularly useful when dealing with complex bible APIs or raw user input.
+
+`chapter-and-verse` handles all the following reference formats:
+
+| format              	| example       	| notes                     	|
+|---------------------	|---------------	|---------------------------	|
+| book                	| Genesis       	|                           	|
+| book chapter        	| Genesis 5     	|                           	|
+| book verse          	| Obadiah 3     	| single chapter books only 	|
+| book verses         	| Obadiah 3-5   	| single chapter books only 	|
+| book chapter:verse  	| Genesis 5:1   	|                           	|
+| book chapter:verses 	| Genesis 5:1-4 	|                           	|
+
+
+
+<br>
+
+## Usage
+
+```javascript 1.7
+const chapterAndVerse = require('chapter-and-verse')
+let cv = chapterAndVerse('Dan 4:1-3')
+```
+
+And `cv` now looks like:
+
+```json
+{
+  "book": {
+    "id": "Dan",
+    "name": "Daniel",
+    "testament": "O",
+    "start": "dan",
+    "abbr": ["da", "dn"],
+    "chapters": 12
+  },
+  "reason": "matches book.id",
+  "chapter": 4,
+  "from": 1,
+  "to": 3,
+  "range": [1, 2, 3]
+}
+```
+
+You can also use `cv.toString()` and `cv.toShortString()` as follows:
+
+```javascript 1.7
+cv = chapterAndVerse('Dan 4:1-3')
+cv.toString() // returns 'Daniel 4:1-3'
+cv.toShortString() // returns 'Daniel 4:1-3' .. no difference because Daniel has multiple chapters
+
+cv = chapterAndVerse('ob 1-3')
+cv.toString() // returns 'Obadiah 1:1-3'
+cv.toShortString() // returns 'Obadiah 1-3' .. difference because Obadiah only has a single chapter
+```
+
+
+
+<br>
+
+## Author says
+
+The Lord bless you and keep you;
+
+the Lord make his face to shine upon you and be gracious to you;
+
+the Lord lift up his countenance upon you and give you peace.
+
+[Numbers 6:24-26 ESV](https://www.biblegateway.com/passage/?search=Numbers+6%3A24-26&version=ESV "Jesus loves you")
+
+
+
+<br><br><br>

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

81811

increased by2184.59%

Number of package files

19

increased by58.33%

Lines of code

446

increased by2247.37%

Number of low maintenance alerts

0

decreased by-100%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

94

increased by840%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

8

increased by14.29%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes