loggerhythm - npm Package Compare versions

Comparing version 1.0.1 to 2.0.0

package.json

 {
   "name": "loggerhythm",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "description": "wrapper for winston to use it like debug with namespaces",
@@ -8,5 +8,7 @@ "publicConfig": {
   },
-  "main": "index.js",
+  "main": "dist/commonjs/loggerhythm.js",
+  "typings": "dist/loggerhythm.d.ts",
   "scripts": {
-    "test": "mocha"
+    "test": "mocha",
+    "build": "gulp build"
   },
@@ -36,4 +38,4 @@ "author": {
   "files": [
-    "index.js",
-    "lib/",
+    "dist/",
+    "src/",
     "History.md",
@@ -47,8 +49,13 @@ "LICENSE.md",
   "devDependencies": {
-    "eslint": "^3.4.0",
-    "eslint-config-5minds": "^0.0.3",
-    "eslint-plugin-import": "^1.14.0",
+    "@types/winston": "^2.3.5",
+    "gulp": "^3.9.1",
+    "gulptraum": "^2.2.2",
+    "gulptraum-typescript": "^1.3.3",
     "mocha": "^3.0.2",
-    "should": "^11.1.0"
+    "should": "^11.1.0",
+    "tsconfig": "^7.0.0",
+    "tslint": "^5.7.0",
+    "tslint-eslint-config-5minds": "^1.0.2",
+    "typescript": "^2.5.2"
   }
 }

README.md

@@ -6,19 +6,22 @@ # Loggerhythm
 ## Usage
-Loggerhythm exports a function, which requires a namespace and returns the
-logger-class. This class has different log-functions for different log-levels.
-By default, the avaliable loglevels are:
+Loggerhythm exports a Logger-class, whose instances have different log-functions for different log-levels.
+the avaliable loglevels are:
 
-- critical
-- error
-- warn
-- info
-- verbose
-- debug
-- silly
+0. critical
+1. error
+2. warn
+3. info
+4. verbose
+5. debug
+6. silly
 
+***critical* and *error* log to `stderr`, everything else logs to `stdout`!**
+
 #### Example
 
 ```javascript
-const logger = require('loggerhythm')('readme-namespace');
+const Logger = require('loggerhythm').Logger;
+// import {Logger} from 'loggerhythm'; // for TypeScript
 
+const logger = new Logger('readme-namespace')
 logger.info('foo');
@@ -36,36 +39,55 @@ logger.warn('bar');
 ## Methods
-alongside the different log-methods you have (within setup) the setLevel-method
-to tell the module, what the minimal loglevel is a message needs to have to be
-logged. This setting is global, and will effect all loggers. You also have this
-method, if you only require loggerhythm, without giving it a namespace, although
-you **cannot** use these non-namespaced instances to log things.
+### Static
+The Logger-Class has static methods, that can be used to *globally* set loggerhythm-config and register global log-hooks:
 
-```javascript
-const logger = require('loggerhythm')('readme-namespace');
+```TypeScript
+const Logger = require('loggerhythm').Logger;
+const Loglevel = require('loggerhythm').LogLevel;
+// import {Logger, LogLevel} from 'loggerhythm'; // for TypeScript
 
-logger.setup.setLevel('warn');
-logger.info('foo');
-logger.warn('bar');
-```
-or
+// Set the loglevel to only log warnings, errors and critical-logs
+Logger.setLogLevel(LogLevel.WARN);
 
-```javascript
-const logger = require('loggerhythm')('readme-namespace');
-const someOtherLogger = require('loggerhythm');
+// Set the max. log-depth
+Logger.setMaxObjectLogDepth(3);
 
-someOtherLogger.setup.setLevel('warn');
-logger.info('foo');
-logger.warn('bar');
-```
-will output:
+// get informed about all Logs everywhere
+const subscription = Logger.subscribe((logLevel, namespace, message, ...logObjects) => {
+  // do stuff
+});
 
+// do stuff
+
+// unsubscribe
+subscription.dispose();
 ```
-2016-08-30T14:14:48.520Z - warn:     [readme-namespace] bar
-```
 
-## Todo
+### Instance-methods
+The Instances of the Logger-class have a log-method for every loglevel and a subscribe-method to get informed about
+logs of that instance
 
-Loggerhythm can not yet log to files, only to the console. It is planned that
-logs can be stored to files independent of the DEBUG-environment-variable. With
-that, you could get a complete, persistent log, aswell as the DEBUG-filtered
-console-output.
+```TypeScript
+const Logger = require('loggerhythm').Logger;
+// import {Logger} from 'loggerhythm'; // for TypeScript
+
+const logger = new Logger('readme-namespace');
+
+// get informed about all the logs of that instance
+const subscription = Logger.subscribe((logLevel, namespace, message, ...logObjects) => {
+  // namespace will always be 'readme-namespace' here
+  // do stuff
+});
+
+logger.critical('critical log');
+logger.error('error-log', new Error('hello'));
+logger.warn('warning-log');
+logger.info('have some info', {v1: 1, v2: 2, test: ['some', 'test', 'array']});
+logger.verbose('some', 'more detailed', 'info');
+logger.debug('denug-log');
+logger.silly('some stupidly verbose log');
+
+// do stuff
+
+// unsubscribe
+subscription.dispose();
+```

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

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

26438

increased by259.16%

Number of package files

10

increased by25%

Lines of code

407

increased by283.96%

Number of lines in readme file

92

increased by31.43%

Worsened metrics

Dev dependency count

10

increased by100%

Number of low supply chain risk alerts

1

increased byInfinity%

No dependency changes