New : Complete code coverage

100% code coverage & throw error if not provided object to sort fn

Author: DawnImpulse

.gitignore

@@ -1,2 +1,5 @@
 node_modules/*
-exclude/*
+exclude/*
+.idea/*
+.nyc_output/*
+coverage/*

.nycrc.json

@@ -0,0 +1,11 @@
+{
+  "cache": false,
+  "branches": 100,
+  "lines": 100,
+  "functions": 100,
+  "statements": 100,
+  "check-coverage": true,
+  "reporter": ["text", "lcov"],
+  "sourceMap": true,
+  "instrument": true
+}

.travis.yml

@@ -4,6 +4,8 @@ node_js:
  - 'stable'
 install:
   - npm install
+script:
+  - npm run coverage
 branches:
   only:
     - master

LICENSE.txt

@@ -1,6 +1,6 @@
 ISC License
 
-Copyright 2018, Saksham (DawnImpulse)
+Copyright 2018-2019, Saksham (DawnImpulse)
 
 Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,
 provided that the above copyright notice and this permission notice appear in all copies.

README.md

@@ -1,10 +1,12 @@
 # json-keys-sort    
-[![Build Status](https://travis-ci.org/DawnImpulse/json-keys-sort.svg?branch=master)](https://travis-ci.org/DawnImpulse/json-keys-sort) ![wait-loop](https://img.shields.io/npm/dt/json-keys-sort.svg)
+[![Build Status](https://travis-ci.org/DawnImpulse/json-keys-sort.svg?branch=master)](https://travis-ci.org/DawnImpulse/json-keys-sort) [![Coverage Status](https://coveralls.io/repos/github/DawnImpulse/json-keys-sort/badge.svg?branch=master)](https://coveralls.io/github/DawnImpulse/json-keys-sort?branch=master) ![wait-loop](https://img.shields.io/npm/dt/json-keys-sort.svg)
  > Sorting a json object based on keys either ascending or descending & even recursively    
 
 ### Latest Changes	
-- Added support for Typescript
- ### Example -   
+- **sort** now throws an error if not provided with an object
+- added support for Typescript
+
+### Example -   
 > Note : focus on **keys** not values  
   
 ~~~~    
@@ -53,6 +55,10 @@ Output will be -
 + The function work recursively and sort all the inner json objects too.  
 
 ### Versions
++ `v2.0.0`
+	+ New : **100%** code coverage
+	+ Improvement : **sort** now throws an error if not provided with an object
+
 + `v1.3.1`
 	+ Bug Fix : Fixed type of parameter in sort function from JSON to object
 

bash.exe.stackdump

@@ -45,17 +45,19 @@ const typeOf = function (data) {
  * @return {{}} - a sorted json object
  */
 function jsonSort(data, sort) {
+
     if (typeOf(data) === "ARRAY") {
         let newData = [];
         for (let w = 0; w < data.length; w++) {
             let d = data[w];
             if (typeOf(d) === "OBJECT" || typeOf(d) === "ARRAY")
                 newData.push(jsonSort(d, sort));
-            else
+            else {
                 newData.push(d)
+            }
         }
         return newData
-    } else {
+    } else if (typeOf(data)=== "OBJECT") {
         let newKeys = [],
             keys,
             newData = {};
@@ -90,6 +92,8 @@ function jsonSort(data, sort) {
 
         return newData
     }
+    else
+        throw new Error("must be an object/array")
 }
 
 // exporting with name as sort

index.js

@@ -1,15 +1,17 @@
 {
   "name": "json-keys-sort",
-  "version": "1.3.1",
+  "version": "2.0.0",
   "description": "Sorting a json object based on keys either ascending or descending & even recursively",
   "main": "index.js",
   "types": "index.d.ts",
   "scripts": {
-    "test": "mocha index.test.js"
+    "test": "mocha",
+    "test:coverage" : "nyc npm test",
+    "coverage": "nyc npm test && nyc report --reporter=text-lcov | coveralls"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/DawnImpulse/json-keys-sort-js.git"
+    "url": "https://github.com/DawnImpulse/json-keys-sort.git"
   },
   "keywords": [
     "json",
@@ -26,8 +28,11 @@
   "author": "DawnImpulse",
   "license": "ISC",
   "devDependencies": {
-    "chai": "^4.2.0",
-    "mocha": "^5.2.0"
+    "chai": "4.2.0",
+    "coveralls": "3.0.9",
+    "mocha": "6.2.2",
+    "nyc": "15.0.0",
+    "rewire": "4.0.1"
   },
   "dependencies": {}
 }

package.json

@@ -1,5 +1,7 @@
 const chai = require('chai');
-const index = require('./index');
+const rewire = require("rewire");
+const index = require('../index');
+const main = rewire('../index');
 const expect = chai.expect;
 chai.should();
 
@@ -357,9 +359,11 @@ describe('json array tests', () => {
                     {
                         dear: 3,
                         abe: 4
-                    }
+                    },
+                    "some string"
                 ]
-            }
+            },
+            "some data"
         ];
         let result;
 
@@ -377,10 +381,41 @@ describe('json array tests', () => {
             expect(Object.keys(obj)[0]).to.be.equal("boy")
         });
 
+        it('expect object 1.1 key 1 to be string', function () {
+            const key = Object.keys(result[1])[0];
+            const actual = result[1][key][1];
+            expect(actual).to.equal("some string")
+        });
+
         it('expect object 1.0 [0] key 0 to be abe', function () {
             let key = Object.keys(result[1])[0];
             let obj = result[1][key];
             expect(Object.keys(obj[0])[0]).to.be.equal("abe")
         });
+
+        it('expect key 2 to be a string', function () {
+            expect(result[2]).to.equal("some data")
+        });
     })
+});
+
+describe('sort()', () => {
+    it('given invalid object : should throw error', function () {
+        const given = "string";
+        try {
+            const should = index.sort(given);
+            expect.fail(should);
+        } catch (e) {
+            expect(e.toString()).to.equal("Error: must be an object/array")
+        }
+    });
+});
+
+describe('typeOf()', () => {
+
+    it('given any string : should return STRING', function () {
+        const given = "any thing";
+        const should = main.__get__("typeOf")(given);
+        expect(should).to.equal("STRING");
+    });
 });