feat: recreate logger (DX-181) (#54)

BREAKING CHANGE: using the latest version of pino and not wrapping it in a custom logger class

Author: effervescentia

.depcheckrc

@@ -1,13 +1,25 @@
 {
-  "specials": ["bin", "eslint", "lint-staged", "istanbul", "commitizen", "husky", "prettier", "ttypescript"],
+  "specials": [
+    "bin",
+    "eslint",
+    "lint-staged",
+    "istanbul",
+    "commitizen",
+    "husky",
+    "prettier"
+  ],
   "ignores": [
     "@commitlint/*",
     "@types/*",
-    "@voiceflow/commitlint-config",
+    "@voiceflow/tsconfig",
     "@voiceflow/git-branch-check",
-    "prettier-eslint-cli",
+    "@voiceflow/commitlint-config",
+    "@voiceflow/semantic-release-config",
+    "eslint-import-resolver-typescript",
     "fixpack",
     "husky",
-    "lint-staged"
+    "istanbul",
+    "lint-staged",
+    "pino-pretty"
   ]
 }

.eslintignore

@@ -1,7 +1,4 @@
 coverage
-.idea
 .nyc_output
-scratch.js
-/node_modules
 /build
-nyc_coverage*
+/node_modules

.eslintrc.js

@@ -1,15 +1,12 @@
 module.exports = {
-  extends: ['@voiceflow/eslint-config', 'plugin:@typescript-eslint/recommended'],
-  parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint'],
+  extends: ['@voiceflow/eslint-config', '@voiceflow/eslint-config/typescript'],
   overrides: [
     {
-      files: ['*.ts'],
-      extends: ['@voiceflow/eslint-config/typescript'],
+      files: ['test/**/*'],
+      extends: ['@voiceflow/eslint-config/utility', '@voiceflow/eslint-config/mocha'],
       rules: {
-        'class-methods-use-this': 'off',
-        'no-param-reassign': 'off',
-        'import/no-cycle': 'off',
+        // off
+        'no-unused-expressions': 'off',
       },
     },
   ],

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn commitlint --edit "$1"

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn lint-staged

.husky/pre-push

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn git-branch-check

.huskyrc.json

@@ -1,57 +1,26 @@
 [![circle ci](https://circleci.com/gh/voiceflow/logger.svg?style=shield&circle-token=8c4e4ce8d04d87f16e903bd7e1ccab194a118262)](https://circleci.com/gh/voiceflow/logger)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=voiceflow_logger&metric=coverage)](https://sonarcloud.io/dashboard?id=voiceflow_logger)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=voiceflow_logger&metric=alert_status)](https://sonarcloud.io/dashboard?id=voiceflow_logger)
-# logger
-
-Author: Frank Gu <<[email protected]>>
-Date: Dec 11, 2019
 
-A logging package for VERY fast and useful JSON logging.
+# logger
 
-- All log entries go to `process.stdout`
-- Minimal overhead and no logger hierarchies
-- Multiple instantiations allowed
+A standardized package for logging built on `pino`.
 
 ## Usage
 
-```javascript
-const Logger = require('@voiceflow/logger').default;
-// or
-import Logger from '@voiceflow/logger';
-
-const defaultOptions = {
-  level: 'info',
-  pretty: false,
-};
-
-const overrideOptions = {
-  level: 'trace', // Minimum log-level to be printed
-  pretty: true, // Pretty print
-};
-
-const defaultLogger = new Logger(); // Default options
-const customLogger = new Logger(overrideOptions);
-
-defaultLogger.trace('this is a trace');
-defaultLogger.debug('this is a debug');
-defaultLogger.info('this is an info');
-defaultLogger.warn('this is a warning');
-defaultLogger.error('this is an error');
-defaultLogger.fatal('this is a fatal');
-
-customLogger.trace('this is a trace');
-customLogger.debug('this is a debug');
-customLogger.info('this is an info');
-customLogger.warn('this is a warning');
-customLogger.error('this is an error');
-customLogger.fatal('this is a fatal');
-```
+```ts
+import { createLogger, LogLevel, LogFormat } from '@voiceflow/logger';
 
-### Development Assitance
+const logger = createLogger({ format: LogFormat.JSON, level: LogLevel.INFO });
 
-- For `warn` logs, the calling function and line number is included
-- For `error` and `fatal` logs, the full call-stack is included
+const inlineLogger = createLogger({ format: LogFormat.INLINE, level: LogLevel.WARN });
 
-### Pretty Printing
+const detailedLogger = createLogger({ format: LogFormat.DETAILED, level: LogLevel.TRACE });
 
-Pretty printing will add colors, parse unix epoch timestamps into UTC time.
+logger.trace('this is a trace log');
+logger.debug('this is a debug log');
+logger.info('this is an info log');
+logger.warn('this is a warning log');
+logger.error('this is an error log');
+logger.fatal('this is a fatal log');
+```

README.md

@@ -0,0 +1,6 @@
+require:
+  - source-map-support/register
+
+timeout: 4000
+exit: true
+recursive: true