@voiceflow/logger - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "@voiceflow/logger",
   "description": "Common logger for Voiceflow backend microservices",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "author": "Frank Gu <[e-mail]>",
+  "bugs": {
+    "url": "https://github.com/voiceflow/logger/issues"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
   "dependencies": {
-    "express-pino-logger": "^4.0.0",
-    "pino": "^5.14.0"
+    "colorette": "2.0.19",
+    "lodash.merge": "4.6.2",
+    "pino": "8.17.2",
+    "pino-http": "8.6.1",
+    "pino-pretty": "9.4.1",
+    "ts-pattern": "^4.0.5"
   },
   "devDependencies": {
-    "@commitlint/cli": "^8.0.0",
-    "@commitlint/config-conventional": "^8.0.0",
-    "@voiceflow/commitlint-config": "^1.0.1",
-    "@voiceflow/eslint-config": "^2.0.4",
-    "@voiceflow/git-branch-check": "^1.0.2",
-    "@voiceflow/prettier-config": "^1.0.4",
-    "chai": "^4.2.0",
-    "chai-as-promised": "^7.1.1",
-    "codacy-coverage": "^3.4.0",
-    "commitizen": "^3.1.1",
-    "cz-conventional-changelog": "2.1.0",
-    "eslint": "^6.0.1",
-    "fixpack": "^2.3.1",
-    "husky": "^3.0.0",
-    "jest": "^24.8.0",
-    "lint-staged": "^9.2.0",
-    "mocha": "^6.1.4",
-    "nyc": "^14.1.1",
-    "prettier": "^1.18.2",
-    "prettier-eslint-cli": "^5.0.0",
-    "prettier-stylelint": "^0.4.2",
-    "pretty-quick": "^1.11.1",
-    "semantic-release": "^15.13.18",
-    "sinon": "^7.3.2"
+    "@commitlint/cli": "17.1.2",
+    "@istanbuljs/nyc-config-typescript": "1.0.2",
+    "@types/chai": "4.3.3",
+    "@types/lodash.merge": "^4.6.7",
+    "@types/mocha": "9.1.1",
+    "@voiceflow/commitlint-config": "2.0.0",
+    "@voiceflow/eslint-config": "7.0.0",
+    "@voiceflow/git-branch-check": "1.4.0",
+    "@voiceflow/prettier-config": "1.2.1",
+    "@voiceflow/semantic-release-config": "1.1.0",
+    "@voiceflow/tsconfig": "1.4.8",
+    "chai": "4.3.6",
+    "commitizen": "4.2.5",
+    "cz-conventional-changelog": "^3.3.0",
+    "depcheck": "^1.4.3",
+    "eslint": "8.23.1",
+    "eslint-output": "^3.0.1",
+    "fixpack": "^4.0.0",
+    "husky": "8.0.1",
+    "istanbul": "^0.4.5",
+    "lint-staged": "13.0.3",
+    "mocha": "10.0.0",
+    "nyc": "^15.1.0",
+    "prettier": "2.7.1",
+    "ts-mocha": "10.0.0",
+    "tsc-alias": "1.7.0",
+    "typescript": "4.8.3"
   },
   "files": [
-    "lib/**/*",
-    "*.js"
+    "build/"
   ],
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
-      "pre-commit": "lint-staged",
-      "pre-push": "git-branch-check"
-    }
-  },
+  "homepage": "https://github.com/voiceflow/logger#readme",
+  "keywords": [
+    "voiceflow"
+  ],
   "license": "ISC",
-  "lint-staged": {
-    "package.json": [
-      "fixpack",
-      "git add"
-    ],
-    "**/*.js": [
-      "eslint --fix",
-      "prettier-eslint --write",
-      "git add"
-    ]
-  },
-  "main": "index.js",
+  "main": "build/main.js",
   "prettier": "@voiceflow/prettier-config",
-  "release": {
-    "branch": "production"
-  },
   "repository": "[e-mail]:voiceflow/logger.git",
   "scripts": {
-    "commit": "git-cz",
-    "integration": "mocha --use_strict --exit \"tests/**/*.it.js\"",
-    "lint": "eslint \"**/*.js\" --fix",
-    "lint:quiet": "yarn lint -- --quiet",
-    "prepare": "fixpack",
-    "send-coverage": "cat ./coverage/lcov.info | codacy-coverage",
-    "test": "nyc mocha --use_strict --exit \"tests/**/*.unit.js\" \"tests/**/*.it.js\"",
-    "unit": "mocha --use_strict --exit \"tests/**/*.unit.js\"",
-    "update": "yarn install"
-  }
+    "build": "yarn clean && tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
+    "clean": "rimraf build",
+    "commit": "cz",
+    "eslint-output": "eslint-output",
+    "lint": "eslint '**/*.{js,ts}'",
+    "lint:output": "yarn run eslint-output --quiet \"**/*.{js,ts}\"",
+    "lint:report": "yarn lint:output",
+    "tdd": "yarn test --watch",
+    "test": "yarn test:run",
+    "test:dependencies": "depcheck",
+    "test:integration": "NODE_ENV=test nyc --report-dir nyc_coverage_integration ts-mocha --paths --config ./config/test/.mocharc.yml 'test/**/*.it.ts'",
+    "test:run": "NODE_ENV=test nyc ts-mocha --paths --config ./config/test/.mocharc.yml 'test/**/*.{unit,it}.ts'",
+    "test:single": "NODE_ENV=test ts-mocha --paths --config ./config/test/.mocharc.yml",
+    "test:unit": "NODE_ENV=test nyc --report-dir=nyc_coverage_unit ts-mocha --paths --config ./config/test/.mocharc.yml 'test/**/*.unit.ts'"
+  },
+  "types": "build/main.d.ts"
 }

README.md

@@ -0,2 +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
-Logging package for unified logging features
+
+A standardized package for logging built on `pino`.
+
+## Usage
+
+```ts
+import { createLogger, LogLevel, LogFormat } from '@voiceflow/logger';
+
+const logger = createLogger({ format: LogFormat.JSON, level: LogLevel.INFO });
+
+const inlineLogger = createLogger({ format: LogFormat.INLINE, level: LogLevel.WARN });
+
+const detailedLogger = createLogger({ format: LogFormat.DETAILED, level: LogLevel.TRACE });
+
+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');
+```

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

24172

increased by332.11%

Number of package files

38

increased by280%

Lines of code

316

increased by177.19%

Number of low maintenance alerts

0

decreased by-100%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

27

increased by800%

Worsened metrics

Dependency count

6

increased by200%

Dev dependency count

27

increased by12.5%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addedcolorette@2.0.19

• + Addedlodash.merge@4.6.2

• + Addedpino-http@8.6.1

• + Addedpino-pretty@9.4.1

• + Addedts-pattern@^4.0.5

• + Addedabort-controller@3.0.0(transitive)

• + Addedbalanced-match@1.0.2(transitive)

• + Addedbase64-js@1.5.1(transitive)

• + Addedbrace-expansion@2.0.1(transitive)

• + Addedbuffer@6.0.3(transitive)

• + Addedcolorette@2.0.19(transitive)

• + Addeddateformat@4.6.3(transitive)

• + Addedend-of-stream@1.4.4(transitive)

• + Addedevent-target-shim@5.0.1(transitive)

• + Addedevents@3.3.0(transitive)

• + Addedfast-copy@3.0.2(transitive)

• + Addedfast-redact@3.5.0(transitive)

• + Addedfs.realpath@1.0.0(transitive)

• + Addedget-caller-file@2.0.5(transitive)

• + Addedglob@8.1.0(transitive)

• + Addedhelp-me@4.2.0(transitive)

• + Addedieee754@1.2.1(transitive)

• + Addedinflight@1.0.6(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedjoycon@3.1.1(transitive)

• + Addedlodash.merge@4.6.2(transitive)

• + Addedminimatch@5.1.6(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedon-exit-leak-free@2.1.2(transitive)

• + Addedonce@1.4.0(transitive)

• + Addedpino@8.17.2(transitive)

• + Addedpino-http@8.6.1(transitive)

• + Addedpino-pretty@9.4.1(transitive)

• + Addedpino-std-serializers@6.2.2(transitive)

• + Addedprocess@0.11.10(transitive)

• + Addedprocess-warning@3.0.0(transitive)

• + Addedpump@3.0.2(transitive)

• + Addedquick-format-unescaped@4.0.4(transitive)

• + Addedreadable-stream@3.6.24.7.0(transitive)

• + Addedreal-require@0.2.0(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedsafe-stable-stringify@2.5.0(transitive)

• + Addedsecure-json-parse@2.7.0(transitive)

• + Addedsonic-boom@3.8.1(transitive)

• + Addedstring_decoder@1.3.0(transitive)

• + Addedstrip-json-comments@3.1.1(transitive)

• + Addedthread-stream@2.7.0(transitive)

• + Addedts-pattern@4.3.0(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addedwrappy@1.0.2(transitive)

• - Removedexpress-pino-logger@^4.0.0

• - Removedexpress-pino-logger@4.0.0(transitive)

• - Removedfast-redact@2.1.0(transitive)

• - Removedfast-url-parser@1.1.3(transitive)

• - Removedflatstr@1.0.12(transitive)

• - Removedpino@5.17.0(transitive)

• - Removedpino-http@4.5.0(transitive)

• - Removedpino-std-serializers@2.5.0(transitive)

• - Removedpunycode@1.4.1(transitive)

• - Removedquick-format-unescaped@3.0.3(transitive)

• - Removedsonic-boom@0.7.7(transitive)

• Updatedpino@8.17.2