feat: add transformations (ddbe00d2) · Commits · Open StApps / Logger

.gitlab-ci.yml

+2 −0

Original line number	Diff line number	Diff line
		@@ -22,6 +22,8 @@ build:
		- lib

		test:
		variables:
		FORCE_COLOR: '1' # see https://github.com/chalk/chalk/issues/203
		stage: test
		script:
		- npm test

README.md

+17 −1

Original line number	Diff line number	Diff line
		@@ -3,11 +3,12 @@
		[![pipeline status](https://gitlab.com/openstapps/logger/badges/master/pipeline.svg)](https://gitlab.com/openstapps/logger/commits/master)
		[![coverage report](https://gitlab.com/openstapps/logger/badges/master/coverage.svg)](https://gitlab.com/openstapps/logger/commits/master)

		This is a simple logger for TypeScript projects with colors for console output.
		This is a simple logger for TypeScript projects with transformations for the log output.

		Logs are only printed if their log level is equal or higher than the defined log level.

		## Log Levels

		Available log levels are:
		- 1 - INFO
		- 2 - LOG
		@@ -25,15 +26,18 @@ If you want to use logger in production (`NODE_ENV=production`) and allow all tr
		`ALLOW_NO_TRANSPORT` to `true`.

		## SMTP

		This class also provides a simple implementation of an SMTP transport which can be used as a
		`TransportWithVerification` for the logger. You can use this to transport errors of the logger or to transport mails
		of your own monitoring solution.

		### Usage

		You can instatiate it with a config or it will check for a config in the environment variables. Environment variables
		can overwrite the actual config values.

		Environment variables are:

		* SMTP_AUTH_USER: SMTP username
		* SMTP_AUTH_PASSWORD: SMTP password
		* SMTP_HOST: SMTP host
		@@ -43,3 +47,15 @@ Environment variables are:
		* SMTP_SENDER_MAIL: sender of the mail
		* SMTP_SENDER_NAME: name of the sender
		* SMTP_SECURE: `true` to enable tls

		## Transformations

		By default the logger will only add the log level to the message.

		You can change this behavior by setting other Transformers via `Logger.setTransformations`. If you do so, mind the order of the transformers.

		You may choose from the following:

		* `AddLogLevel`, which prepends the output with the log level
		* `Colorize`, which colorizes the output according to the log level
		* `Timestamp`, which prepends a timestamp to the output

package-lock.json

+41 −141

Original line number	Diff line number	Diff line
		@@ -73,9 +73,9 @@
		"dev": true
		},
		"@babel/runtime": {
		"version": "7.4.5",
		"resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.4.5.tgz",
		"integrity": "sha512-TuI4qpWZP6lGOGIuGWtp9sPluqYICmbk8T/1vpSysqJxRPkudh/ofFWyqdcMsDf2s7KvDL4/YHgKyvcS3g9CJQ==",
		"version": "7.5.4",
		"resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.5.4.tgz",
		"integrity": "sha512-Na84uwyImZZc3FKf4aUF1tysApzwf3p2yuFBIyBfbzT5glzKTdvYI4KVW4kcgjrzoGUjC7w3YyCHcJKaRxsr2Q==",
		"dev": true,
		"requires": {
		"regenerator-runtime": "^0.13.2"
		@@ -132,9 +132,9 @@
		}
		},
		"@openstapps/configuration": {
		"version": "0.18.0",
		"resolved": "https://registry.npmjs.org/@openstapps/configuration/-/configuration-0.18.0.tgz",
		"integrity": "sha512-Ufi3jzCozVqCymNeaeRzuOHO2Yd5qXJ10uF4xNHk6Q4LFD9NAMMBkYbawkjmecZoNR+Llqs4AnwSxIkuEAxcxA==",
		"version": "0.21.0",
		"resolved": "https://registry.npmjs.org/@openstapps/configuration/-/configuration-0.21.0.tgz",
		"integrity": "sha512-0PR8es12HJqNOoTHc4XwfNgS3WDpsrhXvkyty8sid6mcyeaOMmhoj680LwJlqcNsRP9DqqPc+s0JB8zKd0NOig==",
		"dev": true,
		"requires": {
		"@types/node": "10.14.7",
		@@ -142,8 +142,8 @@
		"@types/yaml": "1.0.2",
		"chalk": "2.4.2",
		"commander": "2.20.0",
		"semver": "6.1.0",
		"tslint": "5.16.0",
		"semver": "6.1.1",
		"tslint": "5.17.0",
		"tslint-eslint-rules": "5.4.0",
		"yaml": "1.6.0"
		},
		@@ -155,15 +155,15 @@
		"dev": true
		},
		"semver": {
		"version": "6.1.0",
		"resolved": "https://registry.npmjs.org/semver/-/semver-6.1.0.tgz",
		"integrity": "sha512-kCqEOOHoBcFs/2Ccuk4Xarm/KiWRSLEX9CAZF8xkJ6ZPlIoTZ8V5f7J16vYLJqDbR7KrxTJpR2lqjIEm2Qx9cQ==",
		"version": "6.1.1",
		"resolved": "https://registry.npmjs.org/semver/-/semver-6.1.1.tgz",
		"integrity": "sha512-rWYq2e5iYW+fFe/oPPtYJxYgjBm8sC4rmoGdUOgBB7VnwKt6HrL793l2voH1UlsyYZpJ4g0wfjnTEO1s1NP2eQ==",
		"dev": true
		},
		"tslint": {
		"version": "5.16.0",
		"resolved": "https://registry.npmjs.org/tslint/-/tslint-5.16.0.tgz",
		"integrity": "sha512-UxG2yNxJ5pgGwmMzPMYh/CCnCnh0HfPgtlVRDs1ykZklufFBL1ZoTlWFRz2NQjcoEiDoRp+JyT0lhBbbH/obyA==",
		"version": "5.17.0",
		"resolved": "https://registry.npmjs.org/tslint/-/tslint-5.17.0.tgz",
		"integrity": "sha512-pflx87WfVoYepTet3xLfDOLDm9Jqi61UXIKePOuca0qoAZyrGWonDG9VTbji58Fy+8gciUn8Bt7y69+KEVjc/w==",
		"dev": true,
		"requires": {
		"@babel/code-frame": "^7.0.0",
		@@ -172,7 +172,7 @@
		"commander": "^2.12.1",
		"diff": "^3.2.0",
		"glob": "^7.1.1",
		"js-yaml": "^3.13.0",
		"js-yaml": "^3.13.1",
		"minimatch": "^3.0.4",
		"mkdirp": "^0.5.1",
		"resolve": "^1.3.2",
		@@ -191,42 +191,6 @@
		}
		}
		},
		"@sinonjs/commons": {
		"version": "1.4.0",
		"resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.4.0.tgz",
		"integrity": "sha512-9jHK3YF/8HtJ9wCAbG+j8cD0i0+ATS9A7gXFqS36TblLPNy6rEEc+SB0imo91eCboGaBYGV/MT1/br/J+EE7Tw==",
		"dev": true,
		"requires": {
		"type-detect": "4.0.8"
		}
		},
		"@sinonjs/formatio": {
		"version": "3.2.1",
		"resolved": "https://registry.npmjs.org/@sinonjs/formatio/-/formatio-3.2.1.tgz",
		"integrity": "sha512-tsHvOB24rvyvV2+zKMmPkZ7dXX6LSLKZ7aOtXY6Edklp0uRcgGpOsQTTGTcWViFyx4uhWc6GV8QdnALbIbIdeQ==",
		"dev": true,
		"requires": {
		"@sinonjs/commons": "^1",
		"@sinonjs/samsam": "^3.1.0"
		}
		},
		"@sinonjs/samsam": {
		"version": "3.3.1",
		"resolved": "https://registry.npmjs.org/@sinonjs/samsam/-/samsam-3.3.1.tgz",
		"integrity": "sha512-wRSfmyd81swH0hA1bxJZJ57xr22kC07a1N4zuIL47yTS04bDk6AoCkczcqHEjcRPmJ+FruGJ9WBQiJwMtIElFw==",
		"dev": true,
		"requires": {
		"@sinonjs/commons": "^1.0.2",
		"array-from": "^2.1.1",
		"lodash": "^4.17.11"
		}
		},
		"@sinonjs/text-encoding": {
		"version": "0.7.1",
		"resolved": "https://registry.npmjs.org/@sinonjs/text-encoding/-/text-encoding-0.7.1.tgz",
		"integrity": "sha512-+iTbntw2IZPb/anVDbypzfQa+ay64MW0Zo8aJ8gZPWMMK6/OubMVb6lUPMagqjOPnmtauXnFCACVl3O7ogjeqQ==",
		"dev": true
		},
		"@types/chai": {
		"version": "4.1.7",
		"resolved": "https://registry.npmjs.org/@types/chai/-/chai-4.1.7.tgz",
		@@ -314,9 +278,9 @@
		"dev": true
		},
		"@types/node": {
		"version": "10.14.8",
		"resolved": "https://registry.npmjs.org/@types/node/-/node-10.14.8.tgz",
		"integrity": "sha512-I4+DbJEhLEg4/vIy/2gkWDvXBOOtPKV9EnLhYjMoqxcRW+TTZtUftkHktz/a8suoD5mUL7m6ReLrkPvSsCQQmw=="
		"version": "10.14.12",
		"resolved": "https://registry.npmjs.org/@types/node/-/node-10.14.12.tgz",
		"integrity": "sha512-QcAKpaO6nhHLlxWBvpc4WeLrTvPqlHOvaj0s5GriKkA1zq+bsFBPpfYCvQhLqLgYlIko8A9YrPdaMHCo5mBcpg=="
		},
		"@types/nodemailer": {
		"version": "6.2.0",
		@@ -342,12 +306,6 @@
		"@types/node": "*"
		}
		},
		"@types/sinon": {
		"version": "7.0.12",
		"resolved": "https://registry.npmjs.org/@types/sinon/-/sinon-7.0.12.tgz",
		"integrity": "sha512-fo0MWpVPSUrnZZhp9wyu+hhI3VJ9+Jhs+PWrokBTg3d2ryNPDOAWF1csIhQuYWBTn7KdZzXpRgpX2o6cwOlPWg==",
		"dev": true
		},
		"@types/yaml": {
		"version": "1.0.2",
		"resolved": "https://registry.npmjs.org/@types/yaml/-/yaml-1.0.2.tgz",
		@@ -426,12 +384,6 @@
		"integrity": "sha1-3wEKoSh+Fku9pvlyOwqWoexBh6E=",
		"dev": true
		},
		"array-from": {
		"version": "2.1.1",
		"resolved": "https://registry.npmjs.org/array-from/-/array-from-2.1.1.tgz",
		"integrity": "sha1-z+nYwmYoudxa7MYqn12PHzUsEZU=",
		"dev": true
		},
		"array-ify": {
		"version": "1.0.0",
		"resolved": "https://registry.npmjs.org/array-ify/-/array-ify-1.0.0.tgz",
		@@ -1132,9 +1084,9 @@
		}
		},
		"flatted": {
		"version": "2.0.0",
		"resolved": "https://registry.npmjs.org/flatted/-/flatted-2.0.0.tgz",
		"integrity": "sha512-R+H8IZclI8AAkSBRQJLVOsxwAoHd6WC40b4QTNWIjzAa6BXOBfQcM587MXDTVPeYaopFNWHUFLx7eNmHDSxMWg=="
		"version": "2.0.1",
		"resolved": "https://registry.npmjs.org/flatted/-/flatted-2.0.1.tgz",
		"integrity": "sha512-a1hQMktqW9Nmqr5aktAux3JMNqaucxGcjtjWnZLHX7yyPCmlSV3M54nGYbqT8K+0GhF3NBgmJCc3ma+WOgX8Jg=="
		},
		"foreground-child": {
		"version": "1.5.6",
		@@ -1935,12 +1887,6 @@
		"integrity": "sha1-P02uSpH6wxX3EGL4UhzCOfE2YoA=",
		"dev": true
		},
		"just-extend": {
		"version": "4.0.2",
		"resolved": "https://registry.npmjs.org/just-extend/-/just-extend-4.0.2.tgz",
		"integrity": "sha512-FrLwOgm+iXrPV+5zDU6Jqu4gCRXbWEQg2O3SKONsWE4w7AXFRkryS53bpWdaL9cNol+AmR3AEYz6kn+o0fCPnw==",
		"dev": true
		},
		"lcid": {
		"version": "1.0.0",
		"resolved": "https://registry.npmjs.org/lcid/-/lcid-1.0.0.tgz",
		@@ -2024,12 +1970,6 @@
		"chalk": "^2.0.1"
		}
		},
		"lolex": {
		"version": "4.0.1",
		"resolved": "https://registry.npmjs.org/lolex/-/lolex-4.0.1.tgz",
		"integrity": "sha512-UHuOBZ5jjsKuzbB/gRNNW8Vg8f00Emgskdq2kvZxgBJCS0aqquAuXai/SkWORlKeZEiNQWZjFZOqIUcH9LqKCw==",
		"dev": true
		},
		"loud-rejection": {
		"version": "1.6.0",
		"resolved": "https://registry.npmjs.org/loud-rejection/-/loud-rejection-1.6.0.tgz",
		@@ -2435,6 +2375,11 @@
		"integrity": "sha512-xV2bxeN6F7oYjZWTe/YPAy6MN2M+sL4u/Rlm2AHCIVGfo2p1yGmBHQ6vHehl4bRTZBdHu3TSkWdYgkwpYzAGSw==",
		"dev": true
		},
		"moment": {
		"version": "2.24.0",
		"resolved": "https://registry.npmjs.org/moment/-/moment-2.24.0.tgz",
		"integrity": "sha512-bV7f+6l2QigeBBZSM/6yTNq4P2fNpSWj/0e7jQcy87A8e7o2nAfP/34/2ky5Vw4B9S446EtIhodAzkFCcR4dQg=="
		},
		"ms": {
		"version": "2.1.1",
		"resolved": "https://registry.npmjs.org/ms/-/ms-2.1.1.tgz",
		@@ -2459,27 +2404,6 @@
		"integrity": "sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ==",
		"dev": true
		},
		"nise": {
		"version": "1.4.10",
		"resolved": "https://registry.npmjs.org/nise/-/nise-1.4.10.tgz",
		"integrity": "sha512-sa0RRbj53dovjc7wombHmVli9ZihXbXCQ2uH3TNm03DyvOSIQbxg+pbqDKrk2oxMK1rtLGVlKxcB9rrc6X5YjA==",
		"dev": true,
		"requires": {
		"@sinonjs/formatio": "^3.1.0",
		"@sinonjs/text-encoding": "^0.7.1",
		"just-extend": "^4.0.2",
		"lolex": "^2.3.2",
		"path-to-regexp": "^1.7.0"
		},
		"dependencies": {
		"lolex": {
		"version": "2.7.5",
		"resolved": "https://registry.npmjs.org/lolex/-/lolex-2.7.5.tgz",
		"integrity": "sha512-l9x0+1offnKKIzYVjyXU2SiwhXDLekRzKyhnbyldPHvC7BvLPVpdNUNR2KeMAiCN2D/kLNttZgQD5WjSxuBx3Q==",
		"dev": true
		}
		}
		},
		"node-environment-flags": {
		"version": "1.0.5",
		"resolved": "https://registry.npmjs.org/node-environment-flags/-/node-environment-flags-1.0.5.tgz",
		@@ -2952,15 +2876,6 @@
		"integrity": "sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw==",
		"dev": true
		},
		"path-to-regexp": {
		"version": "1.7.0",
		"resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.7.0.tgz",
		"integrity": "sha1-Wf3g9DW62suhA6hOnTvGTpa5k30=",
		"dev": true,
		"requires": {
		"isarray": "0.0.1"
		}
		},
		"path-type": {
		"version": "3.0.0",
		"resolved": "https://registry.npmjs.org/path-type/-/path-type-3.0.0.tgz",
		@@ -3279,21 +3194,6 @@
		"integrity": "sha1-tf3AjxKH6hF4Yo5BXiUTK3NkbG0=",
		"dev": true
		},
		"sinon": {
		"version": "7.3.2",
		"resolved": "https://registry.npmjs.org/sinon/-/sinon-7.3.2.tgz",
		"integrity": "sha512-thErC1z64BeyGiPvF8aoSg0LEnptSaWE7YhdWWbWXgelOyThent7uKOnnEh9zBxDbKixtr5dEko+ws1sZMuFMA==",
		"dev": true,
		"requires": {
		"@sinonjs/commons": "^1.4.0",
		"@sinonjs/formatio": "^3.2.1",
		"@sinonjs/samsam": "^3.3.1",
		"diff": "^3.5.0",
		"lolex": "^4.0.1",
		"nise": "^1.4.10",
		"supports-color": "^5.5.0"
		}
		},
		"source-map": {
		"version": "0.5.7",
		"resolved": "https://registry.npmjs.org/source-map/-/source-map-0.5.7.tgz",
		@@ -3645,9 +3545,9 @@
		"dev": true
		},
		"ts-node": {
		"version": "8.2.0",
		"resolved": "https://registry.npmjs.org/ts-node/-/ts-node-8.2.0.tgz",
		"integrity": "sha512-m8XQwUurkbYqXrKqr3WHCW310utRNvV5OnRVeISeea7LoCWVcdfeB/Ntl8JYWFh+WRoUAdBgESrzKochQt7sMw==",
		"version": "8.3.0",
		"resolved": "https://registry.npmjs.org/ts-node/-/ts-node-8.3.0.tgz",
		"integrity": "sha512-dyNS/RqyVTDcmNM4NIBAeDMpsAdaQ+ojdf0GOLqE6nwJOgzEkdRNzJywhDfwnuvB10oa6NLVG1rUJQCpRN7qoQ==",
		"dev": true,
		"requires": {
		"arg": "^4.1.0",
		@@ -3666,15 +3566,15 @@
		}
		},
		"tslib": {
		"version": "1.9.3",
		"resolved": "https://registry.npmjs.org/tslib/-/tslib-1.9.3.tgz",
		"integrity": "sha512-4krF8scpejhaOgqzBEcGM7yDIEfi0/8+8zDRZhNZZ2kjmHJ4hv3zCbQWxoJGz1iw5U0Jl0nma13xzHXcncMavQ==",
		"version": "1.10.0",
		"resolved": "https://registry.npmjs.org/tslib/-/tslib-1.10.0.tgz",
		"integrity": "sha512-qOebF53frne81cf0S9B41ByenJ3/IuH8yJKngAX35CmiZySA0khhkovshKK+jGCaMnVomla7gVlIcc3EvKPbTQ==",
		"dev": true
		},
		"tslint": {
		"version": "5.17.0",
		"resolved": "https://registry.npmjs.org/tslint/-/tslint-5.17.0.tgz",
		"integrity": "sha512-pflx87WfVoYepTet3xLfDOLDm9Jqi61UXIKePOuca0qoAZyrGWonDG9VTbji58Fy+8gciUn8Bt7y69+KEVjc/w==",
		"version": "5.18.0",
		"resolved": "https://registry.npmjs.org/tslint/-/tslint-5.18.0.tgz",
		"integrity": "sha512-Q3kXkuDEijQ37nXZZLKErssQVnwCV/+23gFEMROi8IlbaBG6tXqLPQJ5Wjcyt/yHPKBC+hD5SzuGaMora+ZS6w==",
		"dev": true,
		"requires": {
		"@babel/code-frame": "^7.0.0",
		@@ -3710,9 +3610,9 @@
		"dev": true
		},
		"tsutils": {
		"version": "3.13.0",
		"resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.13.0.tgz",
		"integrity": "sha512-wRtEjVU8Su72sDIDoqno5Scwt8x4eaF0teKO3m4hu8K1QFPnIZMM88CLafs2tapUeWnY9SwwO3bWeOt2uauBcg==",
		"version": "3.14.0",
		"resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.14.0.tgz",
		"integrity": "sha512-SmzGbB0l+8I0QwsPgjooFRaRvHLBLNYM8SeQ0k6rtNDru5sCGeLJcZdwilNndN+GysuFjF5EIYgN8GfFG6UeUw==",
		"dev": true,
		"requires": {
		"tslib": "^1.8.1"
		@@ -3775,9 +3675,9 @@
		"dev": true
		},
		"typescript": {
		"version": "3.5.1",
		"resolved": "https://registry.npmjs.org/typescript/-/typescript-3.5.1.tgz",
		"integrity": "sha512-64HkdiRv1yYZsSe4xC1WVgamNigVYjlssIoaH2HcZF0+ijsk5YK2g0G34w9wJkze8+5ow4STd22AynfO6ZYYLw==",
		"version": "3.5.3",
		"resolved": "https://registry.npmjs.org/typescript/-/typescript-3.5.3.tgz",
		"integrity": "sha512-ACzBtm/PhXBDId6a6sDJfroT2pOWt/oOnk4/dElG5G33ZL776N3Y6/6bKZJBFpd+b05F3Ct9qDjMeJmRWtE2/g==",
		"dev": true
		},
		"uglify-js": {

package.json

+11 −9

Original line number	Diff line number	Diff line
		@@ -17,7 +17,7 @@
		"prepublishOnly": "npm ci && npm run build",
		"preversion": "npm run prepublishOnly",
		"push": "git push && git push origin \"v$npm_package_version\"",
		"test": "nyc mocha --require ts-node/register --ui mocha-typescript 'test/*.ts'",
		"test": "nyc mocha --require ts-node/register --ui mocha-typescript 'test/*/.spec.ts'",
		"tslint": "tslint -p tsconfig.json -c tslint.json 'src/*/.ts'"
		},
		"author": "Karl-Philipp Wulfert <krlwlfrt@gmail.com>",
		@@ -48,15 +48,17 @@
		"html",
		"text-summary"
		],
		"require": [
		"ts-node/register"
		],
		"statements": 95
		},
		"devDependencies": {
		"@openstapps/configuration": "0.18.0",
		"@openstapps/configuration": "0.21.0",
		"@types/chai": "4.1.7",
		"@types/chai-as-promised": "7.1.0",
		"@types/chai-spies": "1.0.0",
		"@types/mocha": "5.2.7",
		"@types/sinon": "7.0.12",
		"chai": "4.2.0",
		"chai-as-promised": "7.1.1",
		"chai-spies": "1.0.0",
		@@ -66,17 +68,17 @@
		"nyc": "14.1.1",
		"prepend-file-cli": "1.0.6",
		"rimraf": "2.6.3",
		"sinon": "7.3.2",
		"ts-node": "8.2.0",
		"tslint": "5.17.0",
		"ts-node": "8.3.0",
		"tslint": "5.18.0",
		"typedoc": "0.14.2",
		"typescript": "3.5.1"
		"typescript": "3.5.3"
		},
		"dependencies": {
		"@types/node": "10.14.8",
		"@types/node": "10.14.12",
		"@types/nodemailer": "6.2.0",
		"chalk": "2.4.2",
		"flatted": "2.0.0",
		"flatted": "2.0.1",
		"moment": "2.24.0",
		"nodemailer": "6.2.1"
		}
		}

src/common.ts

+1 −2

Original line number	Diff line number	Diff line
		@@ -12,14 +12,13 @@
		* You should have received a copy of the GNU General Public License along with
		* this program. If not, see <https://www.gnu.org/licenses/>.
		*/
		import {Transport, VerifiableTransport} from './transport';

		/**
		* A recursive partial object
		*
		* Copied from https://stackoverflow.com/a/51365037
		*/
		import {Transport, VerifiableTransport} from './transport';

		export type RecursivePartial<T> = {
		[P in keyof T]?: T[P] extends Array<infer U> ?
		Array<RecursivePartial<U>> :