Merge branch 'release/v2.6.0'

Author: ivanmarban

.eslintrc

@@ -14,11 +14,11 @@
     "SharedArrayBuffer": "readonly"
   },
   "parserOptions": {
-    "ecmaVersion": 6
+    "ecmaVersion": 2020
   },
   "rules": {
     "jsdoc/check-alignment": 1,
-    "jsdoc/check-examples": 1,
+    "jsdoc/check-examples": 0,
     "jsdoc/check-indentation": 1,
     "jsdoc/check-param-names": 1,
     "jsdoc/check-syntax": 1,

.github/workflows/tests.yml

@@ -15,7 +15,7 @@ jobs:
     timeout-minutes: 5
     strategy:
       matrix:
-        node: [12, 14, 16]
+        node: [14, 16, 18]
     name: Node ${{ matrix.node }} test
     steps:
       - name: Clone repository

.gitignore

@@ -1,6 +1,39 @@
 
-# Created by https://www.gitignore.io/api/node,visualstudiocode
-# Edit at https://www.gitignore.io/?templates=node,visualstudiocode
+# Created by https://www.toptal.com/developers/gitignore/api/node,visualstudiocode,macos
+# Edit at https://www.toptal.com/developers/gitignore?templates=node,visualstudiocode,macos
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
 
 ### Node ###
 # Logs
@@ -10,6 +43,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
+.pnpm-debug.log*
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
@@ -25,6 +59,7 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
+*.lcov
 
 # nyc test coverage
 .nyc_output
@@ -45,15 +80,27 @@ build/Release
 node_modules/
 jspm_packages/
 
-# TypeScript v1 declaration files
-typings/
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
 
 # Optional npm cache directory
 .npm
 
 # Optional eslint cache
 .eslintcache
 
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
 # Optional REPL history
 .node_repl_history
 
@@ -63,22 +110,40 @@ typings/
 # Yarn Integrity file
 .yarn-integrity
 
-# dotenv environment variables file
+# dotenv environment variable files
 .env
-.env.test
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache
+.parcel-cache
 
-# next.js build output
+# Next.js build output
 .next
+out
 
-# nuxt.js build output
+# Nuxt.js build / generate output
 .nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
 
 # vuepress build output
 .vuepress/dist
 
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
 # Serverless directories
 .serverless/
 
@@ -88,15 +153,51 @@ typings/
 # DynamoDB Local files
 .dynamodb/
 
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
 ### VisualStudioCode ###
 .vscode/*
 !.vscode/settings.json
 !.vscode/tasks.json
 !.vscode/launch.json
 !.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
 
 ### VisualStudioCode Patch ###
 # Ignore all local history of files
 .history
+.ionide
+
+# Support for Project snippet scope
+.vscode/*.code-snippets
+
+# Ignore code-workspaces
+*.code-workspace
 
-# End of https://www.gitignore.io/api/node,visualstudiocode
+# End of https://www.toptal.com/developers/gitignore/api/node,visualstudiocode,macos

.pre-commit-config.yaml

@@ -1,3 +1,4 @@
+repos:
 - repo: https://github.com/Yelp/detect-secrets
   rev: v1.1.0
   hooks:

CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [v2.6.0] - 2022-05-15
+### Fixed
+- [#36](https://github.com/ivanmarban/winston-telegram/pull/36) Handle uncaught exceptions.
+
+### Removed
+-  Replace sf dependency by custom string templating implementation.
+
 ## [v2.5.0] - 2021-11-9
 ### Added
 - [#29](https://github.com/ivanmarban/winston-telegram/issues/29) Split long messages.
@@ -144,7 +151,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [v0.1.0] - 2015-11-12
 - First version.
 
-[unreleased]: https://github.com/ivanmarban/winston-telegram/compare/v2.5.0...develop
+[unreleased]: https://github.com/ivanmarban/winston-telegram/compare/v2.6.0...develop
+[v2.6.0]: https://github.com/ivanmarban/winston-telegram/compare/v2.5.0...v2.6.0
 [v2.5.0]: https://github.com/ivanmarban/winston-telegram/compare/v2.4.1...v2.5.0
 [v2.4.1]: https://github.com/ivanmarban/winston-telegram/compare/v2.4.0...v2.4.1
 [v2.4.0]: https://github.com/ivanmarban/winston-telegram/compare/v2.3.5...v2.4.0

README.md

@@ -29,7 +29,7 @@ const logger = require('winston')
 const TelegramLogger = require('winston-telegram')
 
 // or
-import * as TelegramLogger from 'winston-telegram';
+import TelegramLogger from 'winston-telegram';
 
 logger.add(new TelegramLogger(options))
 ```

lib/string-format.js

@@ -0,0 +1,18 @@
+function format (str, data) {
+  data = flattenObject(data)
+  Object.keys(data).forEach(function (key) {
+    str = str.replace(new RegExp('{' + key + '}', 'g'), data[key])
+  })
+  return str
+}
+
+function flattenObject (obj, prefix = '') {
+  return Object.keys(obj).reduce((acc, k) => {
+    const pre = prefix.length ? prefix + '.' : ''
+    if (typeof obj[k] === 'object') Object.assign(acc, flattenObject(obj[k], pre + k))
+    else acc[pre + k] = obj[k]
+    return acc
+  }, {})
+}
+
+module.exports = format

lib/winston-telegram.js

@@ -6,7 +6,7 @@
  */
 
 const https = require('https')
-const format = require('sf')
+const format = require('./string-format')
 const Transport = require('winston-transport')
 const MAX_MESSAGE_LENGTH = 4096
 
@@ -43,7 +43,7 @@ module.exports = class Telegram extends Transport {
     this.chatId = options.chatId
     this.parseMode = options.parseMode || ''
     this.level = options.level || 'info'
-    this.handleExceptions = options.handleExceptions || true
+    this.handleExceptions = options.handleExceptions ?? true
     this.unique = options.unique || false
     this.silent = options.silent || false
     this.disableNotification = options.disableNotification || false

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "winston-telegram",
   "description": "A Telegram transport for winston",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "author": "Ivan Marban",
   "repository": {
     "type": "git",
@@ -19,35 +19,34 @@
     "bot"
   ],
   "dependencies": {
-    "sf": "^0.2.0",
     "winston-transport": "^4.3.0"
   },
   "peerDependencies": {
     "winston": "^3.0.0"
   },
   "main": "lib/winston-telegram",
   "engines": {
-    "node": ">= 6.4.0"
+    "node": ">= 14.0.0"
   },
   "types": "lib/winston-telegram",
   "license": "MIT",
   "devDependencies": {
-    "chai": "^4.3.4",
+    "chai": "^4.3.6",
     "coveralls": "^3.1.1",
-    "eslint": "^7.32.0",
-    "eslint-config-standard": "^16.0.3",
-    "eslint-plugin-import": "^2.24.2",
-    "eslint-plugin-jsdoc": "^36.1.0",
-    "eslint-plugin-mocha": "^9.0.0",
+    "eslint": "^8.15.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jsdoc": "^39.2.9",
+    "eslint-plugin-mocha": "^10.0.4",
+    "eslint-plugin-n": "^15.2.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^5.1.0",
-    "eslint-plugin-standard": "^5.0.0",
-    "mocha": "^9.1.1",
-    "nock": "^13.1.3",
+    "eslint-plugin-promise": "^6.0.0",
+    "mocha": "^10.0.0",
+    "nock": "^13.2.4",
     "nyc": "^15.1.0",
-    "prettier-standard": "^15.0.1",
-    "sinon": "^11.1.2",
-    "winston": "^3.0.0"
+    "prettier-standard": "^16.4.1",
+    "sinon": "^14.0.0",
+    "winston": "^3.7.2"
   },
   "scripts": {
     "lint": "eslint lib test examples --color",