Finish sentry transport.

Author: benjamin658

.eslintrc.json

@@ -0,0 +1,17 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "env": {
+    "node": true,
+    "es6": true
+  },
+  "extends": [
+    "airbnb-base",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "@typescript-eslint/no-explicit-any": "off"
+  }
+}

.gitignore

@@ -0,0 +1,101 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# gatsby files
+.cache/
+public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# Build result
+lib

README.md

@@ -1,6 +1,86 @@
 # winston-sentry-javascript-node
 
-Sentry transport for the winson logger that using official Sentry SDK for javascript instead of the old Raven.
+[![winston](https://img.shields.io/badge/winston-3.x+-brightgreen.svg)][winston-url]
+
+Sentry transport for the winson logger and uses the [@sentry/node](https://github.com/getsentry/sentry-javascript/tree/master/packages/node) SDK instead of the old Raven.
+
+> This package is written in Typescript with the well typing and code quality.
+
+## Installation
+
+`npm install winston-sentry-javascript-node --save`
+
+## Usage
+
+```javascript
+import { SentryTransport } from 'winston-sentry-javascript-node';
+
+const logger = winston.createLogger({
+  transports: [
+    new SentryTransport({
+      dsn: 'MY_SENTRY_DSN',
+    }),
+  ],
+});
+
+logger.error('Plain text error.');
+logger.error(new Error('Something went wrong.'));
+```
+
+### Extra / Tags / User Example
+
+Set user information, as well as tags and further extras.
+
+```javascript
+logger.error('Plain text error.', {
+  extra: {
+    foo: 'bar',
+  },
+  tags: {
+    foo: 'bar'
+  },
+  user: {
+    ip: '127.0.0.1',
+    username: 'user1'
+  }
+});
+```
+
+### Handle Exception
+
+Catch and send `uncaughtException` to the Sentry.  
+
+```javascript
+const logger = winston.createLogger({
+  transports: [
+    new SentryTransport({
+      dsn: 'MY_SENTRY_DSN',
+      handleExceptions: true,
+    }),
+  ],
+});
+
+// or
+
+const logger = winston.createLogger({
+  exceptionHandlers: [
+    new SentryTransport({
+      dsn: 'MY_SENTRY_DSN',
+    }),
+  ]
+});
+```
+
+## Default Extra for Error Object
+
+By default, if you provide an Error Object to logger, this package will set the following extra:
+
+```javascript
+{
+  stack: err.stack,
+  message: err.message
+}
+```
 
 ---