elecpen - npm Package Compare versions

Comparing version 0.1.5 to 0.2.0

package.json

 {
   "name": "elecpen",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "description": "a simple logger",
   "main": "index.js",
   "scripts": {
-    "test": "node_modules/.bin/mocha"
+    "test": "mocha --compilers js:babel-register"
   },
@@ -23,7 +23,12 @@ "repository": {
   "dependencies": {
-    "chalk": "^1.0.0"
+    "chalk": "^1.0.0",
+    "moment": "^2.11.1"
   },
   "devDependencies": {
+    "babel": "^6.3.26",
+    "babel-preset-es2015": "^6.3.13",
+    "babel-preset-stage-0": "^6.3.13",
+    "babel-register": "^6.3.13",
     "mocha": "^2.2.5"
   }
 }

README.md

@@ -1,5 +0,21 @@
-# ElecPen  ![travis](https://travis-ci.org/leozdgao/logger.svg?branch=master)
+# ElecPen
 
-A simple logger
+[![Build Status](https://travis-ci.org/leozdgao/elecpen.svg?branch=master)](https://travis-ci.org/leozdgao/elecpen)
 
+We take logger as a function to receive a record and output to a stream, and `elecPen` is a simple logger creator.
+
+## API
+
+`elecPen(writable, prefix, dateFormat)`
+
+|Param|Description|
+|-----|-----------|
+|writable|A writable stream for logging|
+|prefix|The prefix of the record|
+|dateFormat|Date format for logger or pass `true` to use the default format|
+
+## Default logger
+
+A set of logger is provided by a default logger creator which provide some useful logger like `info` or `error`.
+
 ### Options
@@ -11,4 +27,3 @@
 |errFile|File name for logging error and warning|
-|logToConsole|Write to console too|
-|timestamp|Add timestamp for an entry|
+|timestamp|Date format for logger or pass `true` to use the default format|
 |append|If file exists, append new entries to it instead of truncating|
@@ -23,5 +38,5 @@
 
-### How to use?
+### Example
 
-```
+```javascript
 var opts = {
@@ -34,3 +49,3 @@ infoFile: 'info.log',  // record info and verbose
 };
-var fs = requrie('http');
+var http = requrie('http');
 var logger = require('logger').createLogger(opts);
@@ -37,0 +52,0 @@

test/test.js

@@ -1,47 +0,51 @@
-var assert = require('assert');
-var fs = require('fs');
-var elecpen = require('../');
+var assert = require('assert')
+var fs = require('fs')
+var elecpen = require('../src')
 
 describe('Test actions of the logger.', function() {
-  var logger, logger2;
+  var logger, logger2
 
-  var infoFile = 'info.test.log';
+  var infoFile = 'info.test.log'
   var opts = {
     infoFile: infoFile
-  }, logger;
+  }
+
   before(function() {
-    logger = elecpen.createLogger(opts);
-    logger2 = elecpen.createLogger(opts);
-  });
+    logger = elecpen.defaultLogger(opts)
+    logger2 = elecpen.defaultLogger(opts)
+  })
   after(function(done) {
-    fs.unlink('info.test.log', done);
-  });
+    fs.unlink('info.test.log', done)
+  })
+
   it('Should create a file', function(done) {
     fs.exists(infoFile, function(exist) {
-      assert.equal(exist, true);
-      done();
-    });
-  });
+      assert.equal(exist, true)
+      done()
+    })
+  })
+
   it('Should log correct entry.', function(done) {
-    var expect = /^\[Info\] (.*?) Hello world(?:\n+|$)/m;
-    logger.info('Hello world');
+    var expect = /^\[Info\] (.*?) Hello world(?:\n+|$)/m
+    logger.info('Hello world')
     fs.readFile(infoFile, { encoding: 'utf-8' }, function(err, result) {
-      var match = result.match(expect);
-      assert.notEqual(match, null);
-      assert.equal(isNaN(Date.parse(match[1])), false);
-      done(err);
-    });
-  });
+      var match = result.match(expect)
+      assert.notEqual(match, null)
+      assert.equal(isNaN(Date.parse(match[1])), false)
+      done(err)
+    })
+  })
+
   it('Should append to an existed file.', function(done) {
-    var expect = /(?:^|\n*)\[Info\] (.*?) Hello world(?:\n+|$)/g;
-    logger2.info('Hello world');
+    var expect = /(?:^|\n*)\[Info\] (.*?) Hello world(?:\n+|$)/g
+    logger2.info('Hello world')
     fs.readFile(infoFile, { encoding: 'utf-8' }, function(err, result) {
-      var m, count = 0;
+      var m, count = 0
       while((m = expect.exec(result)) != null) {
-        count++;
+        count++
       }
-      assert.equal(count, 2);
-      done(err);
-    });
-  });
-});
+      assert.equal(count, 2)
+      done(err)
+    })
+  })
+})

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

Improved metrics

Total package byte prevSize

7102

increased by3.05%

Number of package files

8

increased by14.29%

Lines of code

111

increased by3.74%

Number of lines in readme file

58

increased by34.88%

Worsened metrics

Dependency count

2

increased by100%

Dev dependency count

5

increased by400%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedmoment@^2.11.1

• + Addedmoment@2.30.1(transitive)