geo-lib - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

app/app.js

@@ -12,5 +12,4 @@ /*
 
-var App = require(appPath + 'lib/my-app');
-var app = new App();
+var app = require(appPath + 'lib/geo-lib');
 
 module.exports = app;

Gruntfile.js

@@ -36,2 +36,14 @@ /*
 
+        jsdoc: {
+            dist: {
+                src: ['lib/**/*.js', 'app/**/*.js'],
+                options: {
+                    tutorials: 'tutorials',
+                    destination: 'doc',
+                    template: 'node_modules/ink-docstrap/template',
+                    configure: 'node_modules/ink-docstrap/template/jsdoc.conf.json'
+                }
+            }
+        },
+
         watch: {
@@ -108,2 +120,3 @@ all: {
     grunt.loadNpmTasks('grunt-coveralls');
+    grunt.loadNpmTasks("grunt-jsdoc");
 
@@ -116,5 +129,6 @@ // Default task.
     grunt.registerTask('run', ['buster:unit', 'nodemon:dev']);
-    grunt.registerTask('artifact', ['shell', 'coveralls:real_coverage']);
+    grunt.registerTask('artifact', ['shell', 'coveralls:real_coverage', 'jsdoc']);
+    grunt.registerTask('doc', ['jsdoc']);
     grunt.registerTask('report', ['coveralls:real_coverage']);
 
 };

package.json

 {
   "name": "geo-lib",
   "description": "A Node.js module with useful geo functions. Made with performance in mind.",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "homepage": "https://github.com/5orenso/geo-lib",
@@ -37,8 +37,9 @@ "repository": {
     "grunt-jscs": "^3.0.0",
+    "grunt-jsdoc": "^2.1.0",
     "grunt-nodemon": "^0.4.0",
-    "grunt-shell": "^1.1.2"
+    "grunt-shell": "^1.1.2",
+    "ink-docstrap": "^1.2.1"
   },
   "keywords": [],
-  "dependencies": {
-  }
+  "dependencies": {}
 }

README.md

@@ -9,2 +9,3 @@ # Boilerplate for your brand new Node.js module - NPM ready
 
+
 ### Howto to get started
@@ -49,13 +50,15 @@ ```bash
 ```bash
-npm install buster --save-dev
-npm install buster-istanbul --save-dev
-npm install grunt --save-dev
-npm install grunt-buster --save-dev
-npm install grunt-contrib-jshint --save-dev
-npm install grunt-contrib-nodeunit --save-dev
-npm install grunt-contrib-watch --save-dev
-npm install grunt-coveralls --save-dev
-npm install grunt-jscs --save-dev
-npm install grunt-nodemon --save-dev
-npm install grunt-shell --save-dev
+$ npm install buster --save-dev
+$ npm install buster-istanbul --save-dev
+$ npm install grunt --save-dev
+$ npm install grunt-buster --save-dev
+$ npm install grunt-contrib-jshint --save-dev
+$ npm install grunt-contrib-nodeunit --save-dev
+$ npm install grunt-contrib-watch --save-dev
+$ npm install grunt-coveralls --save-dev
+$ npm install grunt-jscs --save-dev
+$ npm install grunt-nodemon --save-dev
+$ npm install grunt-shell --save-dev
+$ npm install grunt-jsdoc --save-dev
+
 ```
@@ -62,0 +65,0 @@

test/app-test.js

@@ -18,3 +18,3 @@ /*
     tearDown: () => {
-        delete require.cache[require.resolve(appPath + 'lib/my-app')];
+        delete require.cache[require.resolve(appPath + 'lib/geo-lib')];
     },
@@ -24,4 +24,12 @@ 'Test module:': {
             let app = require(appPath + 'app/app');
-            let result = app.run();
-            assert.equals(result, 'Yo!');
+            let result = app.distance({
+                p1: { lat: 70.3369224, lon: 30.3411273 },
+                p2: { lat: 59.8939528, lon: 10.6450348 },
+                unit: 'km'
+            });
+            assert.equals(result, {
+                distance: 1468.28,
+                unit: 'km',
+                method: 'haversine'
+            });
         }
@@ -28,0 +36,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

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

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

48109

increased by98.69%

Number of package files

26

increased by18.18%

Lines of code

830

increased by157.76%

Number of lines in readme file

70

increased by4.48%

Worsened metrics

Dev dependency count

13

increased by18.18%

Number of low supply chain risk alerts

15

increased by150%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes