feat: Create basic logger generator

Create a simple, winston-based logger generator.

Author: ikhemissi

.circleci/config.yml

@@ -0,0 +1,58 @@
+defaults: &defaults
+  working_directory: ~/repo
+  docker:
+    - image: circleci/node:8.4.0
+
+version: 2
+jobs:
+  checkout_code:
+    <<: *defaults
+    steps:
+      - checkout
+      - persist_to_workspace:
+          root: ~/repo
+          paths:
+            - .
+
+  test:
+    <<: *defaults
+    steps:
+      - attach_workspace:
+          at: ~/repo
+      - restore_cache:
+          key: dependency-cache-{{ checksum "package.json" }}
+      - run:
+          name: install dependencies with npm
+          command: npm install
+      - save_cache:
+          key: dependency-cache-{{ checksum "package.json" }}
+          paths:
+            - ./node_modules
+      - run:
+          name: Lint
+          command: npm run lint
+      - persist_to_workspace:
+          root: ~/repo
+          paths:
+            - node_modules
+
+  release:
+    <<: *defaults
+    steps:
+      - attach_workspace:
+          at: ~/repo
+      - checkout
+      - run: npm run semantic-release
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - checkout_code
+      - test:
+          requires:
+            - checkout_code
+      - release:
+          context: org-global
+          requires:
+            - test

.eslintrc.json

@@ -0,0 +1,30 @@
+{
+	"root": true,
+	"extends": "5app",
+	"plugins": [
+		"promise",
+		"security"
+	],
+	"rules": {
+		"array-bracket-newline": [2, "consistent"],
+		"array-element-newline": [2, "consistent"],
+		"arrow-body-style": [2, "as-needed"],
+		"capitalized-comments": 2,
+		"comma-dangle": 2,
+		"dot-location": [2, "property"],
+		"no-empty-function": 2,
+		"no-magic-numbers": 0,
+		"no-tabs": [2, {"allowIndentationTabs": true}],
+		"multiline-comment-style": [2, "starred-block"],
+		"padded-blocks": 2,
+		"require-atomic-updates": 0,
+		"require-await": 0,
+		"spaced-comment": [2, "always"],
+		"strict": 2,
+		"template-curly-spacing": 2,
+		"newline-per-chained-call": 2,
+		"prefer-promise-reject-errors": 2,
+		"promise/prefer-await-to-then": 2,
+		"security/detect-unsafe-regex": 2
+	}
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 5app
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,66 @@
 # logger
-Simple console logger that outputs json in prod and pretty messages on dev
+
+> Simple console logger that outputs json in prod and pretty messages on dev
+
+## Usage
+```sh
+npm install --save @5app/logger
+```
+
+Then, generate a logger in your app and use it to log messages.
+
+```javascript
+const getLogger = require('@5app/logger');
+
+const logger = getLogger({
+  simple: process.env.NODE_ENV === 'development',
+  metadata: {
+    tag: process.env.TAG, // release tag, e.g. docker container tag
+  },
+});
+
+logger.info('An email was sent', {
+  email: 'customer@5app.com',
+  template: 'template1',
+});
+
+logger.error(new Error('Unknown playlist 123'));
+```
+
+## Options
+
+The logger generator accepts the following options:
+
+### simple
+
+This boolean value specifies whether we should log pretty dev-friendly messages instead of JSON or not.
+By default, simple will be false.
+
+Example:
+```javascript
+const getLogger = require('@5app/logger');
+
+// This logger will log dev-friendly messages
+const logger = getLogger({
+  simple: true,
+});
+```
+
+### metadata
+
+Metadata is an object containing service metadata like the release tag or the A/B testing experiment we are running.
+This object will be added to each log entry when using the JSON mode.
+
+Example:
+```javascript
+const getLogger = require('@5app/logger');
+
+// This logger will add details about the current release and A/B experiment to every log line
+const getLogger = require('@5app/logger');
+const logger = getLogger({
+  metadata: {
+    release: '1.2.3',
+    experiment: 12345,
+  },
+});
+```

index.js

@@ -0,0 +1,54 @@
+const winston = require('winston');
+
+const LEVEL = Symbol.for('level');
+const {format} = winston;
+const sqlFormat = {
+	level: winston.config.npm.levels.debug,
+	color: 'grey'
+};
+
+winston.addColors({sql: sqlFormat.color});
+
+const colorizer = format.colorize();
+const sqlFormatter = format((info, opts) => {
+
+	const level = info[LEVEL];
+
+	if (opts.colorize && level === 'sql') {
+
+		info.message = colorizer.colorize(level, `${info.level}: ${info.message}\n`);
+
+	}
+
+	return info;
+
+});
+
+function getFormatter({simple}) {
+
+	if (simple) {
+
+		return format.combine(format.splat(), format.colorize(), sqlFormatter({colorize: true}), format.simple());
+
+	}
+
+	return format.combine(format.splat(), format.timestamp(), format.json());
+
+}
+
+function getLogger({simple, metadata}) {
+
+	return winston.createLogger({
+		level: simple ? 'debug' : 'info',
+		levels: {
+			...winston.config.npm.levels,
+			sql: sqlFormat.level
+		},
+		format: getFormatter({simple}),
+		defaultMeta: metadata,
+		transports: [new winston.transports.Console()]
+	});
+
+}
+
+module.exports = getLogger;