rmsjs - npm Package Compare versions

Comparing version 0.1.6 to 1.0.0

gruntfile.js

 'use strict';
 
-var fs = require('fs');
-var _ = require('lodash');
-var argv = require('minimist')(process.argv.slice(2));
-
 module.exports = function(grunt) {
 
+  var fs = require('fs');
   var moment = require('moment');
-  var pkg = grunt.file.readJSON('package.json');
 
-  var bannerContent = fs.readFileSync('banner.js', { encoding: 'utf8' });
-
   grunt.initConfig({
 
     today: moment().utcOffset(-7),
-    args: argv,
-    pkg: pkg,
+    args: require('minimist')(process.argv.slice(2)),
+    banner: fs.readFileSync('banner.js', { encoding: 'utf8' }),
+    pkg: grunt.file.readJSON('package.json'),
 
@@ -26,4 +21,4 @@ copy: {
             src: ['**'],
-            cwd: 'build/',
-            dest: '../dist/<%= pkg.version %>'
+            cwd: 'tmp/',
+            dest: 'dist/<%= pkg.version %>'
           },
@@ -33,4 +28,4 @@ {
             src: ['**'],
-            cwd: 'build/',
-            dest: '../dist/latest'
+            cwd: 'tmp/',
+            dest: 'dist/latest'
           }
@@ -45,4 +40,4 @@ ]
         files: {
-          'build/rms.full.js': [
-            './index.js'
+          'tmp/rms.full.js': [
+            'lib/client.js'
           ]
@@ -65,3 +60,3 @@ }
         sourceMap: true,
-        sourceMapName: 'build/rms.map',
+        sourceMapName: 'tmp/rms.map',
         mangle: { except: [] },
@@ -94,3 +89,3 @@ preserveComments:false,
         files: {
-          'build/rms.js': ['build/rms.full.js']
+          'tmp/rms.js': ['tmp/rms.full.js']
         }
@@ -100,3 +95,3 @@ }
     clean: {
-      all: ['build']
+      all: ['tmp']
     },
@@ -107,7 +102,7 @@ usebanner: {
           position: 'top',
-          banner: bannerContent,
+          banner: "<%= banner %>",
           linebreak: true
         },
         files: {
-          src: [ 'build/rms.js','build/rms.full.js' ]
+          src: [ 'tmp/rms.js','tmp/rms.full.js' ]
         }
@@ -125,3 +120,3 @@ }
 
-  grunt.registerTask('default', ['browserify','uglify','usebanner','copy']);
-};
+  grunt.registerTask('default', ['browserify','uglify','usebanner','copy','clean']);
+};

package.json

 {
   "name": "rmsjs",
-  "version": "0.1.6",
+  "version": "1.0.0",
   "description": "Javascript SDK for Microsoft Retail Management System",
@@ -31,5 +31,5 @@ "main": "rms.js",
   "bugs": {
-    "url": "https://invelo.io/modules/rms/support"
+    "url": "https://developers.invelo.io/support"
   },
-  "homepage": "https://invelo.io/modules/rms"
+  "homepage": "https://developers.invelo.io/rms"
 }

README.md

@@ -1,1 +0,33 @@
-#RMSjs 
+# RMSjs
+
+## Synopsis
+
+At the top of the file there should be a short introduction and/ or overview that explains **what** the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)
+
+## Code Example
+
+Show what the library does as concisely as possible, developers should be able to figure out **how** your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.
+
+## Motivation
+
+A short description of the motivation behind the creation and maintenance of the project. This should explain **why** the project exists.
+
+## Installation
+
+Provide code examples and explanations of how to get the project.
+
+## API Reference
+
+Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.
+
+## Tests
+
+Describe and show how to run the tests with code examples.
+
+## Contributors
+
+Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.
+
+## License
+
+A short snippet describing the license (MIT, Apache, etc.)

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

No bug tracker

Maintenance

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

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

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 v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

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

18953

increased by8.03%

Lines of code

604

increased by2.37%

Number of low quality alerts

2

decreased by-33.33%

Number of lines in readme file

34

increased by1600%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes