logule - npm Package Compare versions

Comparing version 0.5.1 to 0.5.2

History.md

@@ -1,5 +0,10 @@
-0.5.1 / 2011-11-28
+0.5.2 / 2011-11-30
 ==================
-  * logule.get('line') does not chain like the other get() functions
+  * logger.data exposes a frozen object with the current namespaces and logule version
+  * logule.verify(inst) will verify that another logule instance is compatible with this (using exposed data.version on prototype)
 
+0.5.1 / 2011-11-27
+==================
+  * logule.get('line') does not chain, like the other get() functions
+
 0.5.0 / 2011-11-27
@@ -6,0 +11,0 @@ ==================

index.js

 require('coffee-script');
 
-module.exports = require('./lib/logule');
+module.exports = require('./lib/');

package.json

@@ -5,3 +5,3 @@ {
   "description": "An advanced logger for nodejs",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "repository": {
@@ -20,3 +20,4 @@ "type": "git",
     "coffee-script": "~1.1.3",
-    "colors": "~0.5.1"
+    "colors": "~0.5.1",
+    "semver": "~1.0.12"
   },
@@ -23,0 +24,0 @@ "devDependencies": {

Readme.md

@@ -21,6 +21,6 @@ # Logule ![travis build status](https://secure.travis-ci.org/clux/logule.png)
 
-![simple output!](https://github.com/clux/logule/raw/master/outputsimple.png)
+![simple output!](https://github.com/clux/logule/raw/master/imgs/outputsimple.png)
 
 ## Namespaces
-To add a namespace prefix, subclass logule and pass it in
+To add a namespace prefix, subclass logule with it:
 
@@ -34,3 +34,3 @@ ````javascript
 
-![one namespace output!](https://github.com/clux/logule/raw/master/output.png)
+![one namespace output!](https://github.com/clux/logule/raw/master/imgs/output.png)
 
@@ -67,3 +67,3 @@ ### Multiple Namespaces
 
-![line output!](https://github.com/clux/logule/raw/master/line.png)
+![line output!](https://github.com/clux/logule/raw/master/imgs/line.png)
 
@@ -128,2 +128,20 @@ ## Passing log around
 
+### Verifying Logule Validity
+When passing logule subs around, it might be useful for separate code to test whether what is received is an appropriate Logule instance or not.
+Unfortunately, instanceof testing against your installed logule will only work when your code is not separated into modules.
+Therefore, to support npm module style where there are possible multiple installations of logule spread around, the module can test that the
+one passed in has a version compatible with the module's own using a built in helper function.
+
+````javascript
+var logule = require('logule');
+function(logInput) {
+  if (logule.verify(logInput)) {
+    // logInput is an instance of logule, and its version is ~logule.info.version
+  }
+}
+````
+
+Note that single functions like `logule.get('info')` will of course not pass this test.
+If your API expects a single logger function, then it can only type test the input as a function.
+
 ## Zalgo
@@ -130,0 +148,0 @@ H̸̡̪̯ͨ͊̽̅̾̎Ȩ̬̩̾͛ͪ̈́̀́͘ ̶̧̨̱̹̭̯ͧ̾ͬC̷̙̲̝͖ͭ̏ͥͮ͟Oͮ͏̮̪̝͍M̲̖͊̒ͪͩͬ̚̚͜Ȇ̴̟̟͙̞ͩ͌͝S̨̥̫͎̭ͯ̿̔̀ͅ

No alert changes

Improved metrics

Total package byte prevSize

76200

increased by4.17%

Number of package files

14

increased by7.69%

Number of lines in readme file

171

increased by11.76%

Worsened metrics

Dependency count

3

increased by50%

Dependency changes

• + Addedsemver@~1.0.12

• + Addedsemver@1.0.14(transitive)